ToolShellProtocol

public protocol ToolShellProtocol : WidgetProtocol

The GtkToolShell interface allows container widgets to provide additional information when embedding GtkToolItem widgets.

The ToolShellProtocol protocol exposes the methods and properties of an underlying GtkToolShell 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 ToolShell. Alternatively, use ToolShellRef 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 GtkToolShell instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkToolShell instance.

    Default Implementation

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

    Declaration

    Swift

    var tool_shell_ptr: UnsafeMutablePointer<GtkToolShell>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ToolShellProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ToolShell Interface

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: ToolShellPropertyName, 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 ToolShell property

    Declaration

    Swift

    @inlinable
func get(property: ToolShellPropertyName) -> 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 ToolShell property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ToolShell Interface: ToolShellProtocol extension (methods and fields)

  • getEllipsizeMode() Extension method

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

    Declaration

    Swift

    @inlinable
func getEllipsizeMode() -> PangoEllipsizeMode
    Show on GitHub
  • getIconSize() Extension method

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

    Declaration

    Swift

    @inlinable
func getIconSize() -> GtkIconSize
    Show on GitHub
  • getOrientation() Extension method

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

    Declaration

    Swift

    @inlinable
func getOrientation() -> GtkOrientation
    Show on GitHub
  • getReliefStyle() Extension method

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

    Declaration

    Swift

    @inlinable
func getReliefStyle() -> GtkReliefStyle
    Show on GitHub
  • getStyle() Extension method

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

    Declaration

    Swift

    @inlinable
func getStyle() -> GtkToolbarStyle
    Show on GitHub
  • getTextAlignment() Extension method

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

    Declaration

    Swift

    @inlinable
func getTextAlignment() -> Double
    Show on GitHub
  • getTextOrientation() Extension method

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

    Declaration

    Swift

    @inlinable
func getTextOrientation() -> GtkOrientation
    Show on GitHub
  • getTextSizeGroup() Extension method

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

    Declaration

    Swift

    @inlinable
func getTextSizeGroup() -> SizeGroupRef!
    Show on GitHub
  • rebuildMenu() Extension method

    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 gtk_tool_item_rebuild_menu() instead.

    Declaration

    Swift

    @inlinable
func rebuildMenu()
    Show on GitHub
  • ellipsizeMode Extension method

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

    Declaration

    Swift

    @inlinable
var ellipsizeMode: PangoEllipsizeMode { get }
    Show on GitHub
  • iconSize Extension method

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

    Declaration

    Swift

    @inlinable
var iconSize: GtkIconSize { get }
    Show on GitHub
  • orientation Extension method

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

    Declaration

    Swift

    @inlinable
var orientation: GtkOrientation { get }
    Show on GitHub
  • reliefStyle Extension method

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

    Declaration

    Swift

    @inlinable
var reliefStyle: GtkReliefStyle { get }
    Show on GitHub
  • style Extension method

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

    Declaration

    Swift

    @inlinable
var style: GtkToolbarStyle { get }
    Show on GitHub
  • textAlignment Extension method

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

    Declaration

    Swift

    @inlinable
var textAlignment: Double { get }
    Show on GitHub
  • textOrientation Extension method

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

    Declaration

    Swift

    @inlinable
var textOrientation: GtkOrientation { get }
    Show on GitHub
  • textSizeGroup Extension method

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

    Declaration

    Swift

    @inlinable
var textSizeGroup: SizeGroupRef! { get }
    Show on GitHub