ScaleButtonProtocol

public protocol ScaleButtonProtocol : OrientableProtocol, WidgetProtocol

GtkScaleButton provides a button which pops up a scale widget.

This kind of widget is commonly used for volume controls in multimedia applications, and GTK provides a [classGtk.VolumeButton] subclass that is tailored for this use case.

CSS nodes

GtkScaleButton has a single CSS node with name button. To differentiate it from a plain GtkButton, it gets the .scale style class.

The ScaleButtonProtocol protocol exposes the methods and properties of an underlying GtkScaleButton 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 ScaleButton. Alternatively, use ScaleButtonRef 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 GtkScaleButton instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkScaleButton instance.

    Default Implementation

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

    Declaration

    Swift

    var scale_button_ptr: UnsafeMutablePointer<GtkScaleButton>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ScaleButtonProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ScaleButton Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ScaleButton signals

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

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ScaleButtonSignalName, 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 ScaleButtonSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ScaleButtonSignalName, 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
  • onPopdown(flags:handler:) Extension method

    Emitted to dismiss the popup.

    This is a keybinding signal.

    The default binding for this signal is <kbd>Escape</kbd>.

    Note

    This represents the underlying popdown signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var popdownSignal: ScaleButtonSignalName { get }
    Show on GitHub
  • onPopup(flags:handler:) Extension method

    Emitted to popup the scale widget.

    This is a keybinding signal.

    The default bindings for this signal are <kbd>Space</kbd>, <kbd>Enter</kbd> and <kbd>Return</kbd>.

    Note

    This represents the underlying popup signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var popupSignal: ScaleButtonSignalName { get }
    Show on GitHub

  • Emitted when the value field has changed.

    Note

    This represents the underlying value-changed signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onValueChanged(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleButtonRef, _ value: Double) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    value

    the new value
    handler

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

    Typed value-changed signal for using the connect(signal:) methods

    Declaration

    Swift

    static var valueChangedSignal: ScaleButtonSignalName { 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::adjustment signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyAdjustment(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleButtonRef, _ 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 notifyAdjustment signal is emitted
    Show on GitHub
  • notifyAdjustmentSignal Extension method

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

    Declaration

    Swift

    static var notifyAdjustmentSignal: ScaleButtonSignalName { 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::icons signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyIcons(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleButtonRef, _ 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 notifyIcons signal is emitted
    Show on GitHub
  • notifyIconsSignal Extension method

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

    Declaration

    Swift

    static var notifyIconsSignal: ScaleButtonSignalName { 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::value signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyValue(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleButtonRef, _ 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 notifyValue signal is emitted
    Show on GitHub
  • notifyValueSignal Extension method

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

    Declaration

    Swift

    static var notifyValueSignal: ScaleButtonSignalName { get }
    Show on GitHub

ScaleButton Class: ScaleButtonProtocol extension (methods and fields)

  • getAdjustment() Extension method

    Gets the GtkAdjustment associated with the GtkScaleButton’s scale.

    See [methodGtk.Range.get_adjustment] for details.

    Declaration

    Swift

    @inlinable
func getAdjustment() -> AdjustmentRef!
    Show on GitHub
  • getMinusButton() Extension method

    Retrieves the minus button of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
func getMinusButton() -> ButtonRef!
    Show on GitHub
  • getPlusButton() Extension method

    Retrieves the plus button of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
func getPlusButton() -> ButtonRef!
    Show on GitHub
  • getPopup() Extension method

    Retrieves the popup of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
func getPopup() -> WidgetRef!
    Show on GitHub
  • getValue() Extension method

    Gets the current value of the scale button.

    Declaration

    Swift

    @inlinable
func getValue() -> CDouble
    Show on GitHub
  • set(adjustment:) Extension method

    Sets the GtkAdjustment to be used as a model for the GtkScaleButton’s scale.

    See [methodGtk.Range.set_adjustment] for details.

    Declaration

    Swift

    @inlinable
func set<AdjustmentT>(adjustment: AdjustmentT) where AdjustmentT : AdjustmentProtocol
    Show on GitHub
  • set(icons:) Extension method

    Sets the icons to be used by the scale button.

    Declaration

    Swift

    @inlinable
func set(icons: UnsafeMutablePointer<UnsafePointer<CChar>?>!)
    Show on GitHub
  • set(value:) Extension method

    Sets the current value of the scale.

    If the value is outside the minimum or maximum range values, it will be clamped to fit inside them.

    The scale button emits the [signalGtk.ScaleButton::value-changed] signal if the value changes.

    Declaration

    Swift

    @inlinable
func set(value: CDouble)
    Show on GitHub
  • adjustment Extension method

    The GtkAdjustment that is used as the model.

    Declaration

    Swift

    @inlinable
var adjustment: AdjustmentRef! { get nonmutating set }
    Show on GitHub
  • minusButton Extension method

    Retrieves the minus button of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
var minusButton: ButtonRef! { get }
    Show on GitHub
  • plusButton Extension method

    Retrieves the plus button of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
var plusButton: ButtonRef! { get }
    Show on GitHub
  • popup Extension method

    Retrieves the popup of the GtkScaleButton.

    Declaration

    Swift

    @inlinable
var popup: WidgetRef! { get }
    Show on GitHub
  • value Extension method

    The value of the scale.

    Declaration

    Swift

    @inlinable
var value: CDouble { get nonmutating set }
    Show on GitHub
  • parentInstance Extension method

    Undocumented

    Declaration

    Swift

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