gi-gtk-3.0.31: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Interfaces.ToolShell

Contents

Description

The ToolShell interface allows container widgets to provide additional information when embedding ToolItem widgets.

Synopsis

Exported types

newtype ToolShell Source #

Memory-managed wrapper type.

Instances
GObject ToolShell Source # 
Instance details

Defined in GI.Gtk.Interfaces.ToolShell

Methods

gobjectType :: IO GType #

HasParentTypes ToolShell Source # 
Instance details

Defined in GI.Gtk.Interfaces.ToolShell

type ParentTypes ToolShell Source # 
Instance details

Defined in GI.Gtk.Interfaces.ToolShell

type ParentTypes ToolShell = Widget ': (Object ': ([] :: [Type]))

noToolShell :: Maybe ToolShell Source #

A convenience alias for Nothing :: Maybe ToolShell.

class (GObject o, IsDescendantOf ToolShell o) => IsToolShell o Source #

Type class for types which can be safely cast to ToolShell, for instance with toToolShell.

Instances
(GObject o, IsDescendantOf ToolShell o) => IsToolShell o Source # 
Instance details

Defined in GI.Gtk.Interfaces.ToolShell

toToolShell :: (MonadIO m, IsToolShell o) => o -> m ToolShell Source #

Cast to ToolShell, for types for which this is known to be safe. For general casts, use castTo.

Methods

getEllipsizeMode

toolShellGetEllipsizeMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m EllipsizeMode

Returns: the current ellipsize mode of shell

Retrieves the current ellipsize mode for the tool shell. Tool items must not call this function directly, but rely on toolItemGetEllipsizeMode instead.

Since: 2.20

getIconSize

toolShellGetIconSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m Int32

Returns: the current size (IconSize) for icons of shell

Retrieves the icon size for the tool shell. Tool items must not call this function directly, but rely on toolItemGetIconSize instead.

Since: 2.14

getOrientation

toolShellGetOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m Orientation

Returns: the current orientation of shell

Retrieves the current orientation for the tool shell. Tool items must not call this function directly, but rely on toolItemGetOrientation instead.

Since: 2.14

getReliefStyle

toolShellGetReliefStyle Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m ReliefStyle

Returns: The relief style of buttons on shell.

Returns the relief style of buttons on shell. Tool items must not call this function directly, but rely on toolItemGetReliefStyle instead.

Since: 2.14

getStyle

toolShellGetStyle Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m ToolbarStyle

Returns: the current style of shell

Retrieves whether the tool shell has text, icons, or both. Tool items must not call this function directly, but rely on toolItemGetToolbarStyle instead.

Since: 2.14

getTextAlignment

toolShellGetTextAlignment Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m Float

Returns: the current text alignment of shell

Retrieves the current text alignment for the tool shell. Tool items must not call this function directly, but rely on toolItemGetTextAlignment instead.

Since: 2.20

getTextOrientation

toolShellGetTextOrientation Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m Orientation

Returns: the current text orientation of shell

Retrieves the current text orientation for the tool shell. Tool items must not call this function directly, but rely on toolItemGetTextOrientation instead.

Since: 2.20

getTextSizeGroup

toolShellGetTextSizeGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m SizeGroup

Returns: the current text size group of shell

Retrieves the current text size group for the tool shell. Tool items must not call this function directly, but rely on toolItemGetTextSizeGroup instead.

Since: 2.20

rebuildMenu

toolShellRebuildMenu Source #

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a) 
=> a

shell: a ToolShell

-> m () 

Calling this function signals the tool shell that the overflow menu item for tool items have changed. If there is an overflow menu and if it is visible when this function it called, the menu will be rebuilt.

Tool items must not call this function directly, but rely on toolItemRebuildMenu instead.

Since: 2.14