EditableLabelProtocol

public protocol EditableLabelProtocol : EditableProtocol

A GtkEditableLabel is a label that allows users to edit the text by switching to an “edit mode”.

An example GtkEditableLabel

GtkEditableLabel does not have API of its own, but it implements the [ifaceGtk.Editable] interface.

The default bindings for activating the edit mode is to click or press the Enter key. The default bindings for leaving the edit mode are the Enter key (to save the results) or the Escape key (to cancel the editing).

CSS nodes

editablelabel[.editing]
╰── stack
    ├── label
    ╰── text

GtkEditableLabel has a main node with the name editablelabel. When the entry is in editing mode, it gets the .editing style class.

For all the subnodes added to the text node in various situations, see [classGtk.Text].

The EditableLabelProtocol protocol exposes the methods and properties of an underlying GtkEditableLabel 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 EditableLabel. Alternatively, use EditableLabelRef 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 GtkEditableLabel instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkEditableLabel instance.

    Default Implementation

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

    Declaration

    Swift

    var editable_label_ptr: UnsafeMutablePointer<GtkEditableLabel>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to EditableLabelProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

EditableLabel Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

EditableLabel Class: EditableLabelProtocol extension (methods and fields)

  • getEditing() Extension method

    Returns whether the label is currently in “editing mode”.

    Declaration

    Swift

    @inlinable
func getEditing() -> Bool
    Show on GitHub
  • startEditing() Extension method

    Switches the label into “editing mode”.

    Declaration

    Swift

    @inlinable
func startEditing()
    Show on GitHub
  • stopEditing(commit:) Extension method

    Switches the label out of “editing mode”.

    If commit is true, the resulting text is kept as the [propertyGtk.Editable:text] property value, otherwise the resulting text is discarded and the label will keep its previous [propertyGtk.Editable:text] property value.

    Declaration

    Swift

    @inlinable
func stopEditing(commit: Bool)
    Show on GitHub
  • editing Extension method

    This property is true while the widget is in edit mode.

    Declaration

    Swift

    @inlinable
var editing: Bool { get }
    Show on GitHub