GI.Gtk.Interfaces.ToolShell

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

Exported types

newtype ToolShell

Memory-managed wrapper type.

Constructors

ToolShell (ManagedPtr ToolShell)

Instances

Eq ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

Methods

(==) :: ToolShell -> ToolShell -> Bool

(/=) :: ToolShell -> ToolShell -> Bool

IsGValue ToolShell

Convert ToolShell to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Interfaces.ToolShell

Methods

toGValue :: ToolShell -> IO GValue

fromGValue :: GValue -> IO ToolShell

ManagedPtrNewtype ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

Methods

toManagedPtr :: ToolShell -> ManagedPtr ToolShell

TypedObject ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

Methods

glibType :: IO GType

GObject ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

HasParentTypes ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

type ParentTypes ToolShell

Defined in GI.Gtk.Interfaces.ToolShell

type ParentTypes ToolShell = '[Widget, Object]

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

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

Instances

(GObject o, IsDescendantOf ToolShell o) => IsToolShell o

Defined in GI.Gtk.Interfaces.ToolShell

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

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

Methods

Overloaded methods

getEllipsizeMode

toolShellGetEllipsizeMode

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

Arguments

:: (HasCallStack, MonadIO m, IsToolShell a)

=> a

shell: a ToolShell

-> m Int32

Returns: the current size (tIconSize) 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

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

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

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

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

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

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

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