CellEditableProtocol

public protocol CellEditableProtocol : WidgetProtocol

Interface for widgets that can be used for editing cells

The GtkCellEditable interface must be implemented for widgets to be usable to edit the contents of a GtkTreeView cell. It provides a way to specify how temporary widgets should be configured for editing, get the new value, etc.

The CellEditableProtocol protocol exposes the methods and properties of an underlying GtkCellEditable 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 CellEditable. Alternatively, use CellEditableRef 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 GtkCellEditable instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkCellEditable instance.

    Default Implementation

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

    Declaration

    Swift

    var cell_editable_ptr: UnsafeMutablePointer<GtkCellEditable>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to CellEditableProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

CellEditable Interface

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

CellEditable signals

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

    Declaration

    Swift

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

    Declaration

    Swift

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

  • This signal is a sign for the cell renderer to update its value from the cell_editable.

    Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing, e.g. GtkEntry emits this signal when the user presses Enter. Typical things to do in a handler for editing-done are to capture the edited value, disconnect the cell_editable from signals on the GtkCellRenderer, etc.

    gtk_cell_editable_editing_done() is a convenience method for emitting GtkCellEditableediting-done``.

    Note

    This represents the underlying editing-done signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

    Typed editing-done signal for using the connect(signal:) methods

    Declaration

    Swift

    static var editingDoneSignal: CellEditableSignalName { get }
    Show on GitHub

  • This signal is meant to indicate that the cell is finished editing, and the cell_editable widget is being removed and may subsequently be destroyed.

    Implementations of GtkCellEditable are responsible for emitting this signal when they are done editing. It must be emitted after the GtkCellEditableediting-done`` signal, to give the cell renderer a chance to update the cell’s value before the widget is removed.

    gtk_cell_editable_remove_widget() is a convenience method for emitting GtkCellEditableremove-widget``.

    Note

    This represents the underlying remove-widget signal

    Declaration

    Swift

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

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

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

    Typed remove-widget signal for using the connect(signal:) methods

    Declaration

    Swift

    static var removeWidgetSignal: CellEditableSignalName { 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::editing-canceled signal

    Declaration

    Swift

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

    Typed notify::editing-canceled signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyEditingCanceledSignal: CellEditableSignalName { get }
    Show on GitHub

CellEditable Interface: CellEditableProtocol extension (methods and fields)

  • editingDone() Extension method

    Emits the GtkCellEditableediting-done`` signal.

    Declaration

    Swift

    @inlinable
func editingDone()
    Show on GitHub
  • removeWidget() Extension method

    Emits the GtkCellEditableremove-widget`` signal.

    Declaration

    Swift

    @inlinable
func removeWidget()
    Show on GitHub
  • startEditing(event:) Extension method

    Begins editing on a cell_editable.

    The GtkCellRenderer for the cell creates and returns a GtkCellEditable from gtk_cell_renderer_start_editing(), configured for the GtkCellRenderer type.

    gtk_cell_editable_start_editing() can then set up cell_editable suitably for editing a cell, e.g. making the Esc key emit GtkCellEditableediting-done``.

    Note that the cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells.

    Declaration

    Swift

    @inlinable
func startEditing(event: Gdk.EventRef? = nil)
    Show on GitHub
  • startEditing(event:) Extension method

    Begins editing on a cell_editable.

    The GtkCellRenderer for the cell creates and returns a GtkCellEditable from gtk_cell_renderer_start_editing(), configured for the GtkCellRenderer type.

    gtk_cell_editable_start_editing() can then set up cell_editable suitably for editing a cell, e.g. making the Esc key emit GtkCellEditableediting-done``.

    Note that the cell_editable is created on-demand for the current edit; its lifetime is temporary and does not persist across other edits and/or cells.

    Declaration

    Swift

    @inlinable
func startEditing<EventT>(event: EventT?) where EventT : EventProtocol
    Show on GitHub