CellRendererToggleProtocol

public protocol CellRendererToggleProtocol : CellRendererProtocol

Renders a toggle button in a cell

GtkCellRendererToggle renders a toggle button in a cell. The button is drawn as a radio or a checkbutton, depending on the GtkCellRendererToggle:radio property. When activated, it emits the GtkCellRendererToggletoggled`` signal.

The CellRendererToggleProtocol protocol exposes the methods and properties of an underlying GtkCellRendererToggle 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 CellRendererToggle. Alternatively, use CellRendererToggleRef 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 GtkCellRendererToggle instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkCellRendererToggle instance.

    Default Implementation

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

    Declaration

    Swift

    var cell_renderer_toggle_ptr: UnsafeMutablePointer<GtkCellRendererToggle>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to CellRendererToggleProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

CellRendererToggle Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

CellRendererToggle signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    The toggled signal is emitted when the cell is toggled.

    It is the responsibility of the application to update the model with the correct value to store at path. Often this is simply the opposite of the value currently stored at path.

    Note

    This represents the underlying toggled signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    path

    string representation of GtkTreePath describing the event location
    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: CellRendererToggleSignalName { 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::activatable signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyActivatableSignal: CellRendererToggleSignalName { 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: CellRendererToggleRef, _ 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: CellRendererToggleSignalName { 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::inconsistent signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyInconsistentSignal: CellRendererToggleSignalName { 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::radio signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyRadioSignal: CellRendererToggleSignalName { get }
    Show on GitHub

CellRendererToggle Class: CellRendererToggleProtocol extension (methods and fields)

  • getActivatable() Extension method

    Returns whether the cell renderer is activatable. See gtk_cell_renderer_toggle_set_activatable().

    Declaration

    Swift

    @inlinable
func getActivatable() -> Bool
    Show on GitHub
  • getActive() Extension method

    Returns whether the cell renderer is active. See gtk_cell_renderer_toggle_set_active().

    Declaration

    Swift

    @inlinable
func getActive() -> Bool
    Show on GitHub
  • getRadio() Extension method

    Returns whether we’re rendering radio toggles rather than checkboxes.

    Declaration

    Swift

    @inlinable
func getRadio() -> Bool
    Show on GitHub
  • setActivatable(setting:) Extension method

    Makes the cell renderer activatable.

    Declaration

    Swift

    @inlinable
func setActivatable(setting: Bool)
    Show on GitHub
  • setActive(setting:) Extension method

    Activates or deactivates a cell renderer.

    Declaration

    Swift

    @inlinable
func setActive(setting: Bool)
    Show on GitHub
  • set(radio:) Extension method

    If radio is true, the cell renderer renders a radio toggle (i.e. a toggle in a group of mutually-exclusive toggles). If false, it renders a check toggle (a standalone boolean option). This can be set globally for the cell renderer, or changed just before rendering each cell in the model (for GtkTreeView, you set up a per-row setting using GtkTreeViewColumn to associate model columns with cell renderer properties).

    Declaration

    Swift

    @inlinable
func set(radio: Bool)
    Show on GitHub
  • activatable Extension method

    Undocumented

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

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