GI.Gtk.Objects.TextChildAnchor

A TextChildAnchor is a spot in the buffer where child widgets can be “anchored” (inserted inline, as if they were characters). The anchor can have multiple widgets anchored, to allow for multiple views.

Exported types

newtype TextChildAnchor

Memory-managed wrapper type.

Constructors

TextChildAnchor (ManagedPtr TextChildAnchor)

Instances

GObject TextChildAnchor

Defined in GI.Gtk.Objects.TextChildAnchor

Methods

gobjectType :: TextChildAnchor -> IO GType

IsObject TextChildAnchor

Defined in GI.Gtk.Objects.TextChildAnchor

IsTextChildAnchor TextChildAnchor

Defined in GI.Gtk.Objects.TextChildAnchor

class GObject o => IsTextChildAnchor o

Type class for types which can be safely cast to TextChildAnchor, for instance with toTextChildAnchor.

Instances

(GObject a, (UnknownAncestorError TextChildAnchor a :: Constraint)) => IsTextChildAnchor a

Defined in GI.Gtk.Objects.TextChildAnchor

IsTextChildAnchor TextChildAnchor

Defined in GI.Gtk.Objects.TextChildAnchor

toTextChildAnchor :: (MonadIO m, IsTextChildAnchor o) => o -> m TextChildAnchor

Cast to TextChildAnchor, for types for which this is known to be safe. For general casts, use castTo.

noTextChildAnchor :: Maybe TextChildAnchor

A convenience alias for Nothing :: Maybe TextChildAnchor.

Methods

getDeleted

textChildAnchorGetDeleted

Arguments

:: (HasCallStack, MonadIO m, IsTextChildAnchor a)

=> a

anchor: a TextChildAnchor

-> m Bool

Returns: True if the child anchor has been deleted from its buffer

Determines whether a child anchor has been deleted from the buffer. Keep in mind that the child anchor will be unreferenced when removed from the buffer, so you need to hold your own reference (with objectRef) if you plan to use this function — otherwise all deleted child anchors will also be finalized.

getWidgets

textChildAnchorGetWidgets

Arguments

:: (HasCallStack, MonadIO m, IsTextChildAnchor a)

=> a

anchor: a TextChildAnchor

-> m [Widget]

Returns: list of widgets anchored at anchor

Gets a list of all widgets anchored at this child anchor. The returned list should be freed with g_list_free().

new

textChildAnchorNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextChildAnchor

Returns: a new TextChildAnchor

Creates a new TextChildAnchor. Usually you would then insert it into a TextBuffer with textBufferInsertChildAnchor. To perform the creation and insertion in one step, use the convenience function textBufferCreateChildAnchor.