GI.Gtk.Objects.ToolItemGroup

A ToolItemGroup is used together with ToolPalette to add GtkToolItems to a palette like container with different categories and drag and drop support.

CSS nodes

GtkToolItemGroup has a single CSS node named toolitemgroup.

Since: 2.20

Exported types

newtype ToolItemGroup

Memory-managed wrapper type.

Constructors

ToolItemGroup (ManagedPtr ToolItemGroup)

Instances

GObject ToolItemGroup

Defined in GI.Gtk.Objects.ToolItemGroup

Methods

gobjectType :: IO GType

HasParentTypes ToolItemGroup

Defined in GI.Gtk.Objects.ToolItemGroup

type ParentTypes ToolItemGroup

Defined in GI.Gtk.Objects.ToolItemGroup

type ParentTypes ToolItemGroup = Container ': (Widget ': (Object ': (ImplementorIface ': (Buildable ': (ToolShell ': ([] :: [Type]))))))

class (GObject o, IsDescendantOf ToolItemGroup o) => IsToolItemGroup o

Type class for types which can be safely cast to ToolItemGroup, for instance with toToolItemGroup.

Instances

(GObject o, IsDescendantOf ToolItemGroup o) => IsToolItemGroup o

Defined in GI.Gtk.Objects.ToolItemGroup

toToolItemGroup :: (MonadIO m, IsToolItemGroup o) => o -> m ToolItemGroup

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

noToolItemGroup :: Maybe ToolItemGroup

A convenience alias for Nothing :: Maybe ToolItemGroup.

Methods

getCollapsed

toolItemGroupGetCollapsed

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a GtkToolItemGroup

-> m Bool

Returns: True if group is collapsed, False if it is expanded

Gets whether group is collapsed or expanded.

Since: 2.20

getDropItem

toolItemGroupGetDropItem

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> Int32

x: the x position

-> Int32

y: the y position

-> m ToolItem

Returns: the ToolItem at position (x, y)

Gets the tool item at position (x, y).

Since: 2.20

getEllipsize

toolItemGroupGetEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> m EllipsizeMode

Returns: the EllipsizeMode of group

Gets the ellipsization mode of group.

Since: 2.20

getHeaderRelief

toolItemGroupGetHeaderRelief

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> m ReliefStyle

Returns: the ReliefStyle

Gets the relief mode of the header button of group.

Since: 2.20

getItemPosition

toolItemGroupGetItemPosition

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a, IsToolItem b)

=> a

group: a ToolItemGroup

-> b

item: a ToolItem

-> m Int32

Returns: the index of item in group or -1 if item is no child of group

Gets the position of item in group as index.

Since: 2.20

getLabel

toolItemGroupGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> m Text

Returns: the label of group. The label is an internal string of group and must not be modified. Note that Nothing is returned if a custom label has been set with toolItemGroupSetLabelWidget

Gets the label of group.

Since: 2.20

getLabelWidget

toolItemGroupGetLabelWidget

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> m Widget

Returns: the label widget of group

Gets the label widget of group. See toolItemGroupSetLabelWidget.

Since: 2.20

getNItems

toolItemGroupGetNItems

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> m Word32

Returns: the number of tool items in group

Gets the number of tool items in group.

Since: 2.20

getNthItem

toolItemGroupGetNthItem

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> Word32

index: the index

-> m ToolItem

Returns: the ToolItem at index

Gets the tool item at index in group.

Since: 2.20

insert

toolItemGroupInsert

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a, IsToolItem b)

=> a

group: a ToolItemGroup

-> b

item: the ToolItem to insert into group

-> Int32

position: the position of item in group, starting with 0. The position -1 means end of list.

-> m ()

Inserts item at position in the list of children of group.

Since: 2.20

new

toolItemGroupNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

label: the label of the new group

-> m ToolItemGroup

Returns: a new ToolItemGroup.

Creates a new tool item group with label label.

Since: 2.20

setCollapsed

toolItemGroupSetCollapsed

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> Bool

collapsed: whether the group should be collapsed or expanded

-> m ()

Sets whether the group should be collapsed or expanded.

Since: 2.20

setEllipsize

toolItemGroupSetEllipsize

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> EllipsizeMode

ellipsize: the EllipsizeMode labels in group should use

-> m ()

Sets the ellipsization mode which should be used by labels in group.

Since: 2.20

setHeaderRelief

toolItemGroupSetHeaderRelief

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> ReliefStyle

style: the ReliefStyle

-> m ()

Set the button relief of the group header. See buttonSetRelief for details.

Since: 2.20

setItemPosition

toolItemGroupSetItemPosition

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a, IsToolItem b)

=> a

group: a ToolItemGroup

-> b

item: the ToolItem to move to a new position, should be a child of group.

-> Int32

position: the new position of item in group, starting with 0. The position -1 means end of list.

-> m ()

Sets the position of item in the list of children of group.

Since: 2.20

setLabel

toolItemGroupSetLabel

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a)

=> a

group: a ToolItemGroup

-> Text

label: the new human-readable label of of the group

-> m ()

Sets the label of the tool item group. The label is displayed in the header of the group.

Since: 2.20

setLabelWidget

toolItemGroupSetLabelWidget

Arguments

:: (HasCallStack, MonadIO m, IsToolItemGroup a, IsWidget b)

=> a

group: a ToolItemGroup

-> b

labelWidget: the widget to be displayed in place of the usual label

-> m ()

Sets the label of the tool item group. The label widget is displayed in the header of the group, in place of the usual label.

Since: 2.20

Properties

collapsed

No description available in the introspection data.

constructToolItemGroupCollapsed :: IsToolItemGroup o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “collapsed” property. This is rarely needed directly, but it is used by new.

getToolItemGroupCollapsed :: (MonadIO m, IsToolItemGroup o) => o -> m Bool

Get the value of the “collapsed” property. When overloading is enabled, this is equivalent to

get toolItemGroup #collapsed

setToolItemGroupCollapsed :: (MonadIO m, IsToolItemGroup o) => o -> Bool -> m ()

Set the value of the “collapsed” property. When overloading is enabled, this is equivalent to

set toolItemGroup [ #collapsed := value ]

ellipsize

No description available in the introspection data.

constructToolItemGroupEllipsize :: IsToolItemGroup o => EllipsizeMode -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ellipsize” property. This is rarely needed directly, but it is used by new.

getToolItemGroupEllipsize :: (MonadIO m, IsToolItemGroup o) => o -> m EllipsizeMode

Get the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

get toolItemGroup #ellipsize

setToolItemGroupEllipsize :: (MonadIO m, IsToolItemGroup o) => o -> EllipsizeMode -> m ()

Set the value of the “ellipsize” property. When overloading is enabled, this is equivalent to

set toolItemGroup [ #ellipsize := value ]

headerRelief

No description available in the introspection data.

constructToolItemGroupHeaderRelief :: IsToolItemGroup o => ReliefStyle -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “header-relief” property. This is rarely needed directly, but it is used by new.

getToolItemGroupHeaderRelief :: (MonadIO m, IsToolItemGroup o) => o -> m ReliefStyle

Get the value of the “header-relief” property. When overloading is enabled, this is equivalent to

get toolItemGroup #headerRelief

setToolItemGroupHeaderRelief :: (MonadIO m, IsToolItemGroup o) => o -> ReliefStyle -> m ()

Set the value of the “header-relief” property. When overloading is enabled, this is equivalent to

set toolItemGroup [ #headerRelief := value ]

label

No description available in the introspection data.

constructToolItemGroupLabel :: IsToolItemGroup o => Text -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “label” property. This is rarely needed directly, but it is used by new.

getToolItemGroupLabel :: (MonadIO m, IsToolItemGroup o) => o -> m Text

Get the value of the “label” property. When overloading is enabled, this is equivalent to

get toolItemGroup #label

setToolItemGroupLabel :: (MonadIO m, IsToolItemGroup o) => o -> Text -> m ()

Set the value of the “label” property. When overloading is enabled, this is equivalent to

set toolItemGroup [ #label := value ]

labelWidget

No description available in the introspection data.

constructToolItemGroupLabelWidget :: (IsToolItemGroup o, IsWidget a) => a -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “label-widget” property. This is rarely needed directly, but it is used by new.

getToolItemGroupLabelWidget :: (MonadIO m, IsToolItemGroup o) => o -> m Widget

Get the value of the “label-widget” property. When overloading is enabled, this is equivalent to

get toolItemGroup #labelWidget

setToolItemGroupLabelWidget :: (MonadIO m, IsToolItemGroup o, IsWidget a) => o -> a -> m ()

Set the value of the “label-widget” property. When overloading is enabled, this is equivalent to

set toolItemGroup [ #labelWidget := value ]