CellRendererAccelProtocol

public protocol CellRendererAccelProtocol : CellRendererTextProtocol

Renders a keyboard accelerator in a cell

GtkCellRendererAccel displays a keyboard accelerator (i.e. a key combination like Control + a). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination.

The CellRendererAccelProtocol protocol exposes the methods and properties of an underlying GtkCellRendererAccel 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 CellRendererAccel. Alternatively, use CellRendererAccelRef 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 GtkCellRendererAccel instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkCellRendererAccel instance.

    Default Implementation

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

    Declaration

    Swift

    var cell_renderer_accel_ptr: UnsafeMutablePointer<GtkCellRendererAccel>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to CellRendererAccelProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

CellRendererAccel Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

CellRendererAccel signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • Gets emitted when the user has removed the accelerator.

    Note

    This represents the underlying accel-cleared signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onAccelCleared(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: CellRendererAccelRef, _ pathString: String) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pathString

    the path identifying the row of the edited cell
    handler

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

    Typed accel-cleared signal for using the connect(signal:) methods

    Declaration

    Swift

    static var accelClearedSignal: CellRendererAccelSignalName { get }
    Show on GitHub

  • Gets emitted when the user has selected a new accelerator.

    Note

    This represents the underlying accel-edited signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onAccelEdited(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: CellRendererAccelRef, _ pathString: String, _ accelKey: UInt, _ accelMods: Gdk.ModifierType, _ hardwareKeycode: UInt) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pathString

    the path identifying the row of the edited cell
    accelKey

    the new accelerator keyval
    accelMods

    the new acclerator modifier mask
    hardwareKeycode

    the keycode of the new accelerator
    handler

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

    Typed accel-edited signal for using the connect(signal:) methods

    Declaration

    Swift

    static var accelEditedSignal: CellRendererAccelSignalName { 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::accel-key signal

    Declaration

    Swift

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

    Typed notify::accel-key signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccelKeySignal: CellRendererAccelSignalName { 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::accel-mode signal

    Declaration

    Swift

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

    Typed notify::accel-mode signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccelModeSignal: CellRendererAccelSignalName { 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::accel-mods signal

    Declaration

    Swift

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

    Typed notify::accel-mods signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyAccelModsSignal: CellRendererAccelSignalName { 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::keycode signal

    Declaration

    Swift

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

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

    Declaration

    Swift

    static var notifyKeycodeSignal: CellRendererAccelSignalName { get }
    Show on GitHub