ToggleActionProtocol

public protocol ToggleActionProtocol : ActionProtocol

A GtkToggleAction corresponds roughly to a GtkCheckMenuItem. It has an “active” state specifying whether the action has been checked or not.

The ToggleActionProtocol protocol exposes the methods and properties of an underlying GtkToggleAction 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 ToggleAction. Alternatively, use ToggleActionRef 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 GtkToggleAction instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkToggleAction instance.

    Default Implementation

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

    Declaration

    Swift

    var toggle_action_ptr: UnsafeMutablePointer<GtkToggleAction>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ToggleActionProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ToggleAction Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ToggleAction signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Should be connected if you wish to perform an action whenever the GtkToggleAction state is changed.

    Note

    This represents the underlying toggled signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

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

    Declaration

    Swift

    static var toggledSignal: ToggleActionSignalName { 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::active signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyActiveSignal: ToggleActionSignalName { 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::draw-as-radio signal

    Declaration

    Swift

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

    Typed notify::draw-as-radio signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyDrawAsRadioSignal: ToggleActionSignalName { get }
    Show on GitHub

ToggleAction Class: ToggleActionProtocol extension (methods and fields)

  • getActive() Extension method

    Returns the checked state of the toggle action.

    get_active is deprecated: This method is deprecated.

    Declaration

    Swift

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

    Returns whether the action should have proxies like a radio action.

    get_draw_as_radio is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func getDrawAsRadio() -> Bool
    Show on GitHub
  • setActive(isActive:) Extension method

    Sets the checked state on the toggle action.

    set_active is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func setActive(isActive: Bool)
    Show on GitHub
  • set(drawAsRadio:) Extension method

    Sets whether the action should have proxies like a radio action.

    set_draw_as_radio is deprecated: This method is deprecated.

    Declaration

    Swift

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

    Emits the “toggled” signal on the toggle action.

    toggled is deprecated: This method is deprecated.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func toggled()
    Show on GitHub
  • active Extension method

    Whether the toggle action should be active.

    active is deprecated: This method is deprecated.

    Declaration

    Swift

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

    Returns whether the action should have proxies like a radio action.

    get_draw_as_radio is deprecated: This method is deprecated.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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