ButtonProtocol

public protocol ButtonProtocol : ActionableProtocol, ActivatableProtocol, BinProtocol

The GtkButton widget is generally used to trigger a callback function that is called when the button is pressed. The various signals and how to use them are outlined below.

The GtkButton widget can hold any valid child widget. That is, it can hold almost any other standard GtkWidget. The most commonly used child is the GtkLabel.

CSS nodes

GtkButton has a single CSS node with name button. The node will get the style classes .image-button or .text-button, if the content is just an image or label, respectively. It may also receive the .flat style class.

Other style classes that are commonly used with GtkButton include .suggested-action and .destructive-action. In special cases, buttons can be made round by adding the .circular style class.

Button-like widgets like GtkToggleButton, GtkMenuButton, GtkVolumeButton, GtkLockButton, GtkColorButton, GtkFontButton or GtkFileChooserButton use style classes such as .toggle, .popup, .scale, .lock, .color, .font, .file to differentiate themselves from a plain GtkButton.

The ButtonProtocol protocol exposes the methods and properties of an underlying GtkButton 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 Button. Alternatively, use ButtonRef 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 GtkButton instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkButton instance.

    Default Implementation

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

    Declaration

    Swift

    var button_ptr: UnsafeMutablePointer<GtkButton>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Button Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Button signals

  • Connect a Swift signal handler to the given, typed ButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ButtonSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed ButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ButtonSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onActivate(flags:handler:) Extension method

    The activate signal on GtkButton is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the GtkButton::clicked signal.

    Note

    This represents the underlying activate signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onActivate(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the activate signal is emitted
    Show on GitHub
  • activateSignal Extension method

    Typed activate signal for using the connect(signal:) methods

    Declaration

    Swift

    static var activateSignal: ButtonSignalName { get }
    Show on GitHub
  • onClicked(flags:handler:) Extension method

    Emitted when the button has been activated (pressed and released).

    Note

    This represents the underlying clicked signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onClicked(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the clicked signal is emitted
    Show on GitHub
  • clickedSignal Extension method

    Typed clicked signal for using the connect(signal:) methods

    Declaration

    Swift

    static var clickedSignal: ButtonSignalName { get }
    Show on GitHub
  • onEnter(flags:handler:) Extension method

    Emitted when the pointer enters the button.

    Note

    This represents the underlying enter signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onEnter(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the enter signal is emitted
    Show on GitHub
  • enterSignal Extension method

    Typed enter signal for using the connect(signal:) methods

    Declaration

    Swift

    static var enterSignal: ButtonSignalName { get }
    Show on GitHub
  • onLeave(flags:handler:) Extension method

    Emitted when the pointer leaves the button.

    Note

    This represents the underlying leave signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onLeave(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the leave signal is emitted
    Show on GitHub
  • leaveSignal Extension method

    Typed leave signal for using the connect(signal:) methods

    Declaration

    Swift

    static var leaveSignal: ButtonSignalName { get }
    Show on GitHub
  • onPressed(flags:handler:) Extension method

    Emitted when the button is pressed.

    Note

    This represents the underlying pressed signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onPressed(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the pressed signal is emitted
    Show on GitHub
  • pressedSignal Extension method

    Typed pressed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var pressedSignal: ButtonSignalName { get }
    Show on GitHub
  • onReleased(flags:handler:) Extension method

    Emitted when the button is released.

    Note

    This represents the underlying released signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onReleased(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the released signal is emitted
    Show on GitHub
  • releasedSignal Extension method

    Typed released signal for using the connect(signal:) methods

    Declaration

    Swift

    static var releasedSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::always-show-image signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyAlwaysShowImage(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyAlwaysShowImage signal is emitted
    Show on GitHub
  • notifyAlwaysShowImageSignal Extension method

    Typed notify::always-show-image signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAlwaysShowImageSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::image signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyImage(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyImage signal is emitted
    Show on GitHub
  • notifyImageSignal Extension method

    Typed notify::image signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyImageSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::image-position signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyImagePosition(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyImagePosition signal is emitted
    Show on GitHub
  • notifyImagePositionSignal Extension method

    Typed notify::image-position signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyImagePositionSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::label signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyLabel(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyLabel signal is emitted
    Show on GitHub
  • notifyLabelSignal Extension method

    Typed notify::label signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyLabelSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::relief signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyRelief(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyRelief signal is emitted
    Show on GitHub
  • notifyReliefSignal Extension method

    Typed notify::relief signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyReliefSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::use-stock signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyUseStock(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyUseStock signal is emitted
    Show on GitHub
  • notifyUseStockSignal Extension method

    Typed notify::use-stock signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyUseStockSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::use-underline signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyUseUnderline(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyUseUnderline signal is emitted
    Show on GitHub
  • notifyUseUnderlineSignal Extension method

    Typed notify::use-underline signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyUseUnderlineSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::xalign signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyXalign(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyXalign signal is emitted
    Show on GitHub
  • notifyXalignSignal Extension method

    Typed notify::xalign signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyXalignSignal: ButtonSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::yalign signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyYalign(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ButtonRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyYalign signal is emitted
    Show on GitHub
  • notifyYalignSignal Extension method

    Typed notify::yalign signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyYalignSignal: ButtonSignalName { get }
    Show on GitHub

Button Class: ButtonProtocol extension (methods and fields)

  • clicked() Extension method

    Emits a GtkButton::clicked signal to the given GtkButton.

    Declaration

    Swift

    @inlinable
func clicked()
    Show on GitHub
  • enter() Extension method

    Emits a GtkButton::enter signal to the given GtkButton.

    enter is deprecated: Use the #GtkWidget::enter-notify-event signal.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func enter()
    Show on GitHub
  • getAlignment(xalign:yalign:) Extension method

    Gets the alignment of the child in the button.

    get_alignment is deprecated: Access the child widget directly if you need to control its alignment.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getAlignment(xalign: UnsafeMutablePointer<gfloat>!, yalign: UnsafeMutablePointer<gfloat>!)
    Show on GitHub
  • getAlwaysShowImage() Extension method

    Returns whether the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

    Declaration

    Swift

    @inlinable
func getAlwaysShowImage() -> Bool
    Show on GitHub
  • getEventWindow() Extension method

    Returns the button’s event window if it is realized, nil otherwise. This function should be rarely needed.

    Declaration

    Swift

    @inlinable
func getEventWindow() -> Gdk.WindowRef!
    Show on GitHub
  • getFocusOnClick() Extension method

    Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

    get_focus_on_click is deprecated: Use gtk_widget_get_focus_on_click() instead

    Declaration

    Swift

    @available(*, deprecated)
@available(*, deprecated)
@inlinable
func getFocusOnClick() -> Bool
    Show on GitHub
  • getImage() Extension method

    Gets the widget that is currenty set as the image of button. This may have been explicitly set by gtk_button_set_image() or constructed by gtk_button_new_from_stock().

    Declaration

    Swift

    @inlinable
func getImage() -> WidgetRef!
    Show on GitHub
  • getImagePosition() Extension method

    Gets the position of the image relative to the text inside the button.

    Declaration

    Swift

    @inlinable
func getImagePosition() -> GtkPositionType
    Show on GitHub
  • getLabel() Extension method

    Fetches the text from the label of the button, as set by gtk_button_set_label(). If the label text has not been set the return value will be nil. This will be the case if you create an empty button with gtk_button_new() to use as a container.

    Declaration

    Swift

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

    Returns the current relief style of the given GtkButton.

    Declaration

    Swift

    @inlinable
func getRelief() -> GtkReliefStyle
    Show on GitHub
  • getUseStock() Extension method

    Returns whether the button label is a stock item.

    get_use_stock is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getUseStock() -> Bool
    Show on GitHub
  • getUseUnderline() Extension method

    Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

    Declaration

    Swift

    @inlinable
func getUseUnderline() -> Bool
    Show on GitHub
  • leave() Extension method

    Emits a GtkButton::leave signal to the given GtkButton.

    leave is deprecated: Use the #GtkWidget::leave-notify-event signal.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func leave()
    Show on GitHub
  • pressed() Extension method

    Emits a GtkButton::pressed signal to the given GtkButton.

    pressed is deprecated: Use the #GtkWidget::button-press-event signal.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func pressed()
    Show on GitHub
  • released() Extension method

    Emits a GtkButton::released signal to the given GtkButton.

    released is deprecated: Use the #GtkWidget::button-release-event signal.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func released()
    Show on GitHub
  • setAlignment(xalign:yalign:) Extension method

    Sets the alignment of the child. This property has no effect unless the child is a GtkMisc or a GtkAlignment.

    set_alignment is deprecated: Access the child widget directly if you need to control its alignment.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setAlignment(xalign: Double, yalign: Double)
    Show on GitHub

  • If true, the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

    Use this property if the button would be useless or hard to use without the image.

    Declaration

    Swift

    @inlinable
func setAlwaysShowImage(alwaysShow: Bool)
    Show on GitHub
  • set(focusOnClick:) Extension method

    Sets whether the button will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

    set_focus_on_click is deprecated: Use gtk_widget_set_focus_on_click() instead

    Declaration

    Swift

    @available(*, deprecated)
@available(*, deprecated)
@inlinable
func set(focusOnClick: Bool)
    Show on GitHub
  • set(image:) Extension method

    Set the image of button to the given widget. The image will be displayed if the label text is nil or if GtkButton:always-show-image is true. You don’t have to call gtk_widget_show() on image yourself.

    Declaration

    Swift

    @inlinable
func set(image: WidgetRef? = nil)
    Show on GitHub
  • set(image:) Extension method

    Set the image of button to the given widget. The image will be displayed if the label text is nil or if GtkButton:always-show-image is true. You don’t have to call gtk_widget_show() on image yourself.

    Declaration

    Swift

    @inlinable
func set<WidgetT>(image: WidgetT?) where WidgetT : WidgetProtocol
    Show on GitHub
  • setImage(position:) Extension method

    Sets the position of the image relative to the text inside the button.

    Declaration

    Swift

    @inlinable
func setImage(position: GtkPositionType)
    Show on GitHub
  • set(label:) Extension method

    Sets the text of the label of the button to str. This text is also used to select the stock item if gtk_button_set_use_stock() is used.

    This will also clear any previously set labels.

    Declaration

    Swift

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

    Sets the relief style of the edges of the given GtkButton widget. Two styles exist, GTK_RELIEF_NORMAL and GTK_RELIEF_NONE. The default style is, as one can guess, GTK_RELIEF_NORMAL. The deprecated value GTK_RELIEF_HALF behaves the same as GTK_RELIEF_NORMAL.

    Declaration

    Swift

    @inlinable
func set(relief: GtkReliefStyle)
    Show on GitHub
  • set(useStock:) Extension method

    If true, the label set on the button is used as a stock id to select the stock item for the button.

    set_use_stock is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func set(useStock: Bool)
    Show on GitHub
  • set(useUnderline:) Extension method

    If true, an underline in the text of the button label indicates the next character should be used for the mnemonic accelerator key.

    Declaration

    Swift

    @inlinable
func set(useUnderline: Bool)
    Show on GitHub
  • alwaysShowImage Extension method

    Returns whether the button will ignore the GtkSettings:gtk-button-images setting and always show the image, if available.

    Declaration

    Swift

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

    Returns the button’s event window if it is realized, nil otherwise. This function should be rarely needed.

    Declaration

    Swift

    @inlinable
var eventWindow: Gdk.WindowRef! { get }
    Show on GitHub
  • focusOnClick Extension method

    Returns whether the button grabs focus when it is clicked with the mouse. See gtk_button_set_focus_on_click().

    get_focus_on_click is deprecated: Use gtk_widget_get_focus_on_click() instead

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
var focusOnClick: Bool { get nonmutating set }
    Show on GitHub
  • image Extension method

    The child widget to appear next to the button text.

    Declaration

    Swift

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

    Gets the position of the image relative to the text inside the button.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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

    Returns whether the button label is a stock item.

    get_use_stock is deprecated: This method is deprecated.

    Declaration

    Swift

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

    Returns whether an embedded underline in the button label indicates a mnemonic. See gtk_button_set_use_underline ().

    Declaration

    Swift

    @inlinable
var useUnderline: Bool { get nonmutating set }
    Show on GitHub