gi-gtk-3.0.41: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

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

Exported types

newtype TextChildAnchor Source #

Memory-managed wrapper type.

Constructors

TextChildAnchor (ManagedPtr TextChildAnchor) 

Instances

Instances details
Eq TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

GObject TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

ManagedPtrNewtype TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

TypedObject TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

Methods

glibType :: IO GType

HasParentTypes TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

IsGValue (Maybe TextChildAnchor) Source #

Convert TextChildAnchor to and from GValue. See toGValue and fromGValue.

Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TextChildAnchor -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TextChildAnchor)

type ParentTypes TextChildAnchor Source # 
Instance details

Defined in GI.Gtk.Objects.TextChildAnchor

type ParentTypes TextChildAnchor = '[Object]

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

Instances details
(GObject o, IsDescendantOf TextChildAnchor o) => IsTextChildAnchor o Source # 
Instance details

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

getDeleted

textChildAnchorGetDeleted Source #

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 Source #

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 Source #

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.