Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gtk.Objects.TextChildAnchor
Description
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.
Synopsis
- newtype TextChildAnchor = TextChildAnchor (ManagedPtr TextChildAnchor)
- class (GObject o, IsDescendantOf TextChildAnchor o) => IsTextChildAnchor o
- toTextChildAnchor :: (MonadIO m, IsTextChildAnchor o) => o -> m TextChildAnchor
- textChildAnchorGetDeleted :: (HasCallStack, MonadIO m, IsTextChildAnchor a) => a -> m Bool
- textChildAnchorGetWidgets :: (HasCallStack, MonadIO m, IsTextChildAnchor a) => a -> m [Widget]
- textChildAnchorNew :: (HasCallStack, MonadIO m) => m TextChildAnchor
Exported types
newtype TextChildAnchor Source #
Memory-managed wrapper type.
Constructors
TextChildAnchor (ManagedPtr TextChildAnchor) |
Instances
class (GObject o, IsDescendantOf TextChildAnchor o) => IsTextChildAnchor o Source #
Type class for types which can be safely cast to TextChildAnchor
, for instance with toTextChildAnchor
.
Instances
(GObject o, IsDescendantOf TextChildAnchor o) => IsTextChildAnchor o Source # | |
Defined in GI.Gtk.Objects.TextChildAnchor |
toTextChildAnchor :: (MonadIO m, IsTextChildAnchor o) => o -> m TextChildAnchor Source #
Cast to TextChildAnchor
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getDeleted, getProperty, getQdata, getWidgets.
Setters
getDeleted
textChildAnchorGetDeleted Source #
Arguments
:: (HasCallStack, MonadIO m, IsTextChildAnchor a) | |
=> a |
|
-> m Bool | Returns: |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsTextChildAnchor a) | |
=> a |
|
-> m [Widget] | Returns: list of widgets anchored at |
Gets a list of all widgets anchored at this child anchor.
The returned list should be freed with g_list_free()
.
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m TextChildAnchor | Returns: a new |
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
.