ToolItemGroupProtocol

public protocol ToolItemGroupProtocol : ContainerProtocol, ToolShellProtocol

A GtkToolItemGroup is used together with GtkToolPalette 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.

The ToolItemGroupProtocol protocol exposes the methods and properties of an underlying GtkToolItemGroup instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see ToolItemGroup. Alternatively, use ToolItemGroupRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkToolItemGroup instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • tool_item_group_ptr Default implementation

    Typed pointer to the underlying GtkToolItemGroup instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkToolItemGroup instance.

    Declaration

    Swift

    var tool_item_group_ptr: UnsafeMutablePointer<GtkToolItemGroup>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ToolItemGroupProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ToolItemGroup Class

  • Bind a ToolItemGroupPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ToolItemGroupPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a ToolItemGroup property

    Declaration

    Swift

    @inlinable
func get(property: ToolItemGroupPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a ToolItemGroup property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: ToolItemGroupPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ToolItemGroup Class: ToolItemGroupProtocol extension (methods and fields)

  • getCollapsed() Extension method

    Gets whether group is collapsed or expanded.

    Declaration

    Swift

    @inlinable
func getCollapsed() -> Bool
    Show on GitHub
  • getDropItem(x:y:) Extension method

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

    Declaration

    Swift

    @inlinable
func getDropItem(x: Int, y: Int) -> ToolItemRef!
    Show on GitHub
  • getEllipsize() Extension method

    Gets the ellipsization mode of group.

    Declaration

    Swift

    @inlinable
func getEllipsize() -> PangoEllipsizeMode
    Show on GitHub
  • getHeaderRelief() Extension method

    Gets the relief mode of the header button of group.

    Declaration

    Swift

    @inlinable
func getHeaderRelief() -> GtkReliefStyle
    Show on GitHub
  • getItemPosition(item:) Extension method

    Gets the position of item in group as index.

    Declaration

    Swift

    @inlinable
func getItemPosition<ToolItemT>(item: ToolItemT) -> Int where ToolItemT : ToolItemProtocol
    Show on GitHub
  • getLabel() Extension method

    Gets the label of group.

    Declaration

    Swift

    @inlinable
func getLabel() -> String!
    Show on GitHub
  • getLabelWidget() Extension method

    Gets the label widget of group. See gtk_tool_item_group_set_label_widget().

    Declaration

    Swift

    @inlinable
func getLabelWidget() -> WidgetRef!
    Show on GitHub
  • getNItems() Extension method

    Gets the number of tool items in group.

    Declaration

    Swift

    @inlinable
func getNItems() -> Int
    Show on GitHub
  • getNthItem(index:) Extension method

    Gets the tool item at index in group.

    Declaration

    Swift

    @inlinable
func getNthItem(index: Int) -> ToolItemRef!
    Show on GitHub
  • insert(item:position:) Extension method

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

    Declaration

    Swift

    @inlinable
func insert<ToolItemT>(item: ToolItemT, position: Int) where ToolItemT : ToolItemProtocol
    Show on GitHub
  • set(collapsed:) Extension method

    Sets whether the group should be collapsed or expanded.

    Declaration

    Swift

    @inlinable
func set(collapsed: Bool)
    Show on GitHub
  • set(ellipsize:) Extension method

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

    Declaration

    Swift

    @inlinable
func set(ellipsize: PangoEllipsizeMode)
    Show on GitHub
  • setHeaderRelief(style:) Extension method

    Set the button relief of the group header. See gtk_button_set_relief() for details.

    Declaration

    Swift

    @inlinable
func setHeaderRelief(style: GtkReliefStyle)
    Show on GitHub

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

    Declaration

    Swift

    @inlinable
func setItemPosition<ToolItemT>(item: ToolItemT, position: Int) where ToolItemT : ToolItemProtocol
    Show on GitHub
  • set(label:) Extension method

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

    Declaration

    Swift

    @inlinable
func set(label: UnsafePointer<gchar>!)
    Show on GitHub
  • set(labelWidget:) Extension method

    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.

    Declaration

    Swift

    @inlinable
func set<WidgetT>(labelWidget: WidgetT) where WidgetT : WidgetProtocol
    Show on GitHub
  • collapsed Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var collapsed: Bool { get nonmutating set }
    Show on GitHub
  • ellipsize Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var ellipsize: PangoEllipsizeMode { get nonmutating set }
    Show on GitHub
  • headerRelief Extension method

    Gets the relief mode of the header button of group.

    Declaration

    Swift

    @inlinable
var headerRelief: GtkReliefStyle { get nonmutating set }
    Show on GitHub
  • label Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var label: String! { get nonmutating set }
    Show on GitHub
  • labelWidget Extension method

    Gets the label widget of group. See gtk_tool_item_group_set_label_widget().

    Declaration

    Swift

    @inlinable
var labelWidget: WidgetRef! { get nonmutating set }
    Show on GitHub
  • nItems Extension method

    Gets the number of tool items in group.

    Declaration

    Swift

    @inlinable
var nItems: Int { get }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GtkContainer { get }
    Show on GitHub