RadioActionProtocol

public protocol RadioActionProtocol : ToggleActionProtocol

A GtkRadioAction is similar to GtkRadioMenuItem. A number of radio actions can be linked together so that only one may be active at any one time.

The RadioActionProtocol protocol exposes the methods and properties of an underlying GtkRadioAction 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 RadioAction. Alternatively, use RadioActionRef 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 GtkRadioAction instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkRadioAction instance.

    Default Implementation

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

    Declaration

    Swift

    var radio_action_ptr: UnsafeMutablePointer<GtkRadioAction>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to RadioActionProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

RadioAction Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

RadioAction signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    The changed signal is emitted on every member of a radio group when the active member is changed. The signal gets emitted after the activate signals for the previous and current active members.

    Note

    This represents the underlying changed signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    current

    the member of action‘s group which has just been activated
    handler

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

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

    Declaration

    Swift

    static var changedSignal: RadioActionSignalName { 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::current-value signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyCurrentValueSignal: RadioActionSignalName { 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::group signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyGroupSignal: RadioActionSignalName { 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: RadioActionRef, _ 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: RadioActionSignalName { get }
    Show on GitHub

RadioAction Class: RadioActionProtocol extension (methods and fields)

  • getCurrentValue() Extension method

    Obtains the value property of the currently active member of the group to which action belongs.

    get_current_value is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getCurrentValue() -> Int
    Show on GitHub
  • getGroup() Extension method

    Returns the list representing the radio group for this object. Note that the returned list is only valid until the next change to the group.

    A common way to set up a group of radio group is the following: (C Language Example):

      GSList *group = NULL;
  GtkRadioAction *action;

  while ( ...more actions to add... /)
    {
       action = gtk_radio_action_new (...);

       gtk_radio_action_set_group (action, group);
       group = gtk_radio_action_get_group (action);
    }

    get_group is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getGroup() -> GLib.SListRef!
    Show on GitHub
  • joinGroup(groupSource:) Extension method

    Joins a radio action object to the group of another radio action object.

    Use this in language bindings instead of the gtk_radio_action_get_group() and gtk_radio_action_set_group() methods

    A common way to set up a group of radio actions is the following: (C Language Example):

      GtkRadioAction *action;
  GtkRadioAction *last_action;

  while ( ...more actions to add... /)
    {
       action = gtk_radio_action_new (...);

       gtk_radio_action_join_group (action, last_action);
       last_action = action;
    }

    join_group is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func joinGroup(groupSource: RadioActionRef? = nil)
    Show on GitHub
  • joinGroup(groupSource:) Extension method

    Joins a radio action object to the group of another radio action object.

    Use this in language bindings instead of the gtk_radio_action_get_group() and gtk_radio_action_set_group() methods

    A common way to set up a group of radio actions is the following: (C Language Example):

      GtkRadioAction *action;
  GtkRadioAction *last_action;

  while ( ...more actions to add... /)
    {
       action = gtk_radio_action_new (...);

       gtk_radio_action_join_group (action, last_action);
       last_action = action;
    }

    join_group is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func joinGroup<RadioActionT>(groupSource: RadioActionT?) where RadioActionT : RadioActionProtocol
    Show on GitHub
  • set(currentValue:) Extension method

    Sets the currently active group member to the member with value property current_value.

    set_current_value is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func set(currentValue: Int)
    Show on GitHub
  • set(group:) Extension method

    Sets the radio group for the radio action object.

    set_group is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func set(group: GLib.SListRef? = nil)
    Show on GitHub
  • set(group:) Extension method

    Sets the radio group for the radio action object.

    set_group is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func set<SListT>(group: SListT?) where SListT : SListProtocol
    Show on GitHub
  • currentValue Extension method

    Obtains the value property of the currently active member of the group to which action belongs.

    get_current_value is deprecated: This method is deprecated.

    Declaration

    Swift

    @inlinable
var currentValue: Int { get nonmutating set }
    Show on GitHub
  • group Extension method

    Sets a new group for a radio action.

    group is deprecated: This method is deprecated.

    Declaration

    Swift

    @inlinable
var group: GLib.SListRef! { get nonmutating set }
    Show on GitHub
  • parent Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var parent: GtkToggleAction { get }
    Show on GitHub