Gtk.ToolItemGroup

Gtk.ToolItemGroup — A sub container used in a tool palette

Object Hierarchy:

    GObject
    ╰── GInitiallyUnowned
        ╰── Gtk.Widget
            ╰── Gtk.Container
                ╰── Gtk.ToolItemGroup

Functions:

• get_collapsed (self) -> bool
• get_drop_item (self, x:int, y:int) -> Gtk.ToolItem
• get_ellipsize (self) -> Pango.EllipsizeMode
• get_item_position (self, item:Gtk.ToolItem) -> int
• get_n_items (self) -> int
• get_label (self) -> str
• get_label_widget (self) -> Gtk.Widget
• get_nth_item (self, index:int) -> Gtk.ToolItem
• get_header_relief (self) -> Gtk.ReliefStyle
• insert (self, item:Gtk.ToolItem, position:int)
• new (label:str) -> Gtk.Widget
• set_collapsed (self, collapsed:bool)
• set_ellipsize (self, ellipsize:Pango.EllipsizeMode)
• set_item_position (self, item:Gtk.ToolItem, position:int)
• set_label (self, label:str)
• set_label_widget (self, label_widget:Gtk.Widget)
• set_header_relief (self, style:Gtk.ReliefStyle)

Description:

A Gtk.ToolItemGroup is used together with GtkToolPalette to add Gtk.ToolItems to a palette like container with different categories and drag and drop support.

Function Details:

get_collapsed()

get_collapsed (self) -> bool

Gets whether group is collapsed or expanded.

• Returns: True if groupis collapsed, FALSE if it is expanded

• Since: 2.20

get_drop_item()

get_drop_item (self, x:int, y:int) -> Gtk.ToolItem

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

• Returns: the Gtk.ToolItem at position (x, y).

• Since: 2.20

get_ellipsize()

get_ellipsize (self) -> Pango.EllipsizeMode

Gets the ellipsization mode of group.

• Returns: the PangoEllipsizeMode of group

• Since: 2.20

get_item_position()

get_item_position (self, item:Gtk.ToolItem) -> int

Gets the position of item in group as index.

• Returns: the index of itemin groupor -1 if itemis no child of group

• Since: 2.20

get_n_items()

get_n_items (self) -> int

Gets the number of tool items in group.

• Returns: the number of tool items in group

• Since: 2.20

get_label()

get_label (self) -> str

Gets the label of group.

• Returns: the label of group. The label is an internal string of groupand must not be modified. Note that None is returned if a customlabel has been set with Gtk.ToolItemGroup:set_label_widget()

• Since: 2.20

get_label_widget()

get_label_widget (self) -> Gtk.Widget

Gets the label widget of group.See Gtk.ToolItemGroup:set_label_widget().

• Returns: the label widget of group.

• Since: 2.20

get_nth_item()

get_nth_item (self, index:int) -> Gtk.ToolItem

Gets the tool item at index in group.

• Returns: the Gtk.ToolItem at index.

• Since: 2.20

get_header_relief()

get_header_relief (self) -> Gtk.ReliefStyle

Gets the relief mode of the header button of group.

• Returns: the Gtk.ReliefStyle

• Since: 2.20

insert()

insert (self, item:Gtk.ToolItem, position:int)

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

• Since: 2.20

new()

new (label:str) -> Gtk.Widget

Creates a new tool item group with label label.

• Returns: a new Gtk.ToolItemGroup.

• Since: 2.20

set_collapsed()

set_collapsed (self, collapsed:bool)

Sets whether the group should be collapsed or expanded.

• Since: 2.20

set_ellipsize()

set_ellipsize (self, ellipsize:Pango.EllipsizeMode)

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

• Since: 2.20

set_item_position()

set_item_position (self, item:Gtk.ToolItem, position:int)

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

• Since: 2.20

set_label()

set_label (self, label:str)

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

• Since: 2.20

set_label_widget()

set_label_widget (self, label_widget:Gtk.Widget)

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

• Since: 2.20

set_header_relief()

set_header_relief (self, style:Gtk.ReliefStyle)

Set the button relief of the group header.See `Gtk.Button:set_relief()` for details.

• Since: 2.20