TextMarkProtocol

public protocol TextMarkProtocol : ObjectProtocol

A GtkTextMark is a position in a GtkTextbuffer that is preserved across modifications.

You may wish to begin by reading the text widget conceptual overview, which gives an overview of all the objects and data types related to the text widget and how they work together.

A GtkTextMark is like a bookmark in a text buffer; it preserves a position in the text. You can convert the mark to an iterator using [methodGtk.TextBuffer.get_iter_at_mark]. Unlike iterators, marks remain valid across buffer mutations, because their behavior is defined when text is inserted or deleted. When text containing a mark is deleted, the mark remains in the position originally occupied by the deleted text. When text is inserted at a mark, a mark with “left gravity” will be moved to the beginning of the newly-inserted text, and a mark with “right gravity” will be moved to the end.

Note that “left” and “right” here refer to logical direction (left is the toward the start of the buffer); in some languages such as Hebrew the logically-leftmost text is not actually on the left when displayed.

Marks are reference counted, but the reference count only controls the validity of the memory; marks can be deleted from the buffer at any time with [methodGtk.TextBuffer.delete_mark]. Once deleted from the buffer, a mark is essentially useless.

Marks optionally have names; these can be convenient to avoid passing the GtkTextMark object around.

Marks are typically created using the [methodGtk.TextBuffer.create_mark] function.

The TextMarkProtocol protocol exposes the methods and properties of an underlying GtkTextMark 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 TextMark. Alternatively, use TextMarkRef 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 GtkTextMark instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkTextMark instance.

    Default Implementation

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

    Declaration

    Swift

    var text_mark_ptr: UnsafeMutablePointer<GtkTextMark>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to TextMarkProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

TextMark Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

TextMark Class: TextMarkProtocol extension (methods and fields)

  • getBuffer() Extension method

    Gets the buffer this mark is located inside.

    Returns nil if the mark is deleted.

    Declaration

    Swift

    @inlinable
func getBuffer() -> TextBufferRef!
    Show on GitHub
  • getDeleted() Extension method

    Returns true if the mark has been removed from its buffer.

    See [methodGtk.TextBuffer.add_mark] for a way to add it to a buffer again.

    Declaration

    Swift

    @inlinable
func getDeleted() -> Bool
    Show on GitHub
  • getLeftGravity() Extension method

    Determines whether the mark has left gravity.

    Declaration

    Swift

    @inlinable
func getLeftGravity() -> Bool
    Show on GitHub
  • getName() Extension method

    Returns the mark name.

    Returns nil for anonymous marks.

    Declaration

    Swift

    @inlinable
func getName() -> String!
    Show on GitHub
  • getVisible() Extension method

    Returns true if the mark is visible.

    A cursor is displayed for visible marks.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

    @inlinable
func setVisible(setting: Bool)
    Show on GitHub
  • buffer Extension method

    Gets the buffer this mark is located inside.

    Returns nil if the mark is deleted.

    Declaration

    Swift

    @inlinable
var buffer: TextBufferRef! { get }
    Show on GitHub
  • deleted Extension method

    Returns true if the mark has been removed from its buffer.

    See [methodGtk.TextBuffer.add_mark] for a way to add it to a buffer again.

    Declaration

    Swift

    @inlinable
var deleted: Bool { get }
    Show on GitHub
  • leftGravity Extension method

    Determines whether the mark has left gravity.

    Declaration

    Swift

    @inlinable
var leftGravity: Bool { get }
    Show on GitHub
  • name Extension method

    The name of the mark or nil if the mark is anonymous.

    Declaration

    Swift

    @inlinable
var name: String! { get }
    Show on GitHub
  • visible Extension method

    Returns true if the mark is visible.

    A cursor is displayed for visible marks.

    Declaration

    Swift

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

    Undocumented

    Declaration

    Swift

    @inlinable
var parentInstance: GObject { get }
    Show on GitHub