GI.Pango.Structs.GlyphItemIter

A #PangoGlyphItemIter is an iterator over the clusters in a #PangoGlyphItem. The firsttermforward direction/firstterm of the iterator is the logical direction of text. That is, with increasing start_index and start_char values. If glyph_item is right-to-left (that is, if literalglyph_item->item->analysis.level/literal is odd), then start_glyph decreases as the iterator moves forward. Moreover, in right-to-left cases, start_glyph is greater than @end_glyph.

An iterator should be initialized using either of pango_glyph_item_iter_init_start() and pango_glyph_item_iter_init_end(), for forward and backward iteration respectively, and walked over using any desired mixture of pango_glyph_item_iter_next_cluster() and pango_glyph_item_iter_prev_cluster(). A common idiom for doing a forward iteration over the clusters is: programlisting PangoGlyphItemIter cluster_iter; gboolean have_cluster;

for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter, glyph_item, text); have_cluster; have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter)) { ... } /programlisting

Note that text is the start of the text for layout, which is then indexed by literalglyph_item->item->offset/literal to get to the text of glyph_item. The start_index and end_index values can directly index into text. The start_glyph, end_glyph, start_char, and end_char values however are zero-based for the @glyph_item. For each cluster, the item pointed at by the start variables is included in the cluster while the one pointed at by end variables is not.

None of the members of a #PangoGlyphItemIter should be modified manually.

Exported types

newtype GlyphItemIter

Constructors

GlyphItemIter (ManagedPtr GlyphItemIter)

Instances

BoxedObject GlyphItemIter

Methods

boxedType :: GlyphItemIter -> IO GType

(~) AttrOpTag tag AttrSet => Constructible GlyphItemIter tag

Methods

new :: MonadIO m => (ManagedPtr GlyphItemIter -> GlyphItemIter) -> [AttrOp GlyphItemIter tag] -> m GlyphItemIter

((~) * info (ResolveGlyphItemIterMethod t GlyphItemIter), MethodInfo * info GlyphItemIter p) => IsLabel t (GlyphItemIter -> p)

Methods

fromLabel :: Proxy# Symbol t -> GlyphItemIter -> p

((~) * info (ResolveGlyphItemIterMethod t GlyphItemIter), MethodInfo * info GlyphItemIter p) => IsLabelProxy t (GlyphItemIter -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> GlyphItemIter -> p

HasAttributeList * GlyphItemIter

((~) * signature (m Bool), MonadIO m) => MethodInfo * GlyphItemIterPrevClusterMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterPrevClusterMethodInfo GlyphItemIter -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * GlyphItemIterNextClusterMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterNextClusterMethodInfo GlyphItemIter -> signature -> s

((~) * signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo * GlyphItemIterInitStartMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterInitStartMethodInfo GlyphItemIter -> signature -> s

((~) * signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo * GlyphItemIterInitEndMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterInitEndMethodInfo GlyphItemIter -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * GlyphItemIterFreeMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterFreeMethodInfo GlyphItemIter -> signature -> s

((~) * signature (m (Maybe GlyphItemIter)), MonadIO m) => MethodInfo * GlyphItemIterCopyMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterCopyMethodInfo GlyphItemIter -> signature -> s

type AttributeList GlyphItemIter

type AttributeList GlyphItemIter

newZeroGlyphItemIter :: MonadIO m => m GlyphItemIter

Construct a GlyphItemIter struct initialized to zero.

noGlyphItemIter :: Maybe GlyphItemIter

Methods

copy

data GlyphItemIterCopyMethodInfo

Instances

((~) * signature (m (Maybe GlyphItemIter)), MonadIO m) => MethodInfo * GlyphItemIterCopyMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterCopyMethodInfo GlyphItemIter -> signature -> s

glyphItemIterCopy :: MonadIO m => GlyphItemIter -> m (Maybe GlyphItemIter)

free

data GlyphItemIterFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * GlyphItemIterFreeMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterFreeMethodInfo GlyphItemIter -> signature -> s

glyphItemIterFree :: MonadIO m => GlyphItemIter -> m ()

initEnd

data GlyphItemIterInitEndMethodInfo

Instances

((~) * signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo * GlyphItemIterInitEndMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterInitEndMethodInfo GlyphItemIter -> signature -> s

glyphItemIterInitEnd :: MonadIO m => GlyphItemIter -> GlyphItem -> Text -> m Bool

initStart

data GlyphItemIterInitStartMethodInfo

Instances

((~) * signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo * GlyphItemIterInitStartMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterInitStartMethodInfo GlyphItemIter -> signature -> s

glyphItemIterInitStart :: MonadIO m => GlyphItemIter -> GlyphItem -> Text -> m Bool

nextCluster

data GlyphItemIterNextClusterMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * GlyphItemIterNextClusterMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterNextClusterMethodInfo GlyphItemIter -> signature -> s

glyphItemIterNextCluster :: MonadIO m => GlyphItemIter -> m Bool

prevCluster

data GlyphItemIterPrevClusterMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * GlyphItemIterPrevClusterMethodInfo GlyphItemIter signature

Methods

overloadedMethod :: MethodProxy GlyphItemIterPrevClusterMethodInfo GlyphItemIter -> signature -> s

glyphItemIterPrevCluster :: MonadIO m => GlyphItemIter -> m Bool

Properties

endChar

getGlyphItemIterEndChar :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_endChar :: AttrLabelProxy "endChar"

setGlyphItemIterEndChar :: MonadIO m => GlyphItemIter -> Int32 -> m ()

endGlyph

getGlyphItemIterEndGlyph :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_endGlyph :: AttrLabelProxy "endGlyph"

setGlyphItemIterEndGlyph :: MonadIO m => GlyphItemIter -> Int32 -> m ()

endIndex

getGlyphItemIterEndIndex :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_endIndex :: AttrLabelProxy "endIndex"

setGlyphItemIterEndIndex :: MonadIO m => GlyphItemIter -> Int32 -> m ()

glyphItem

clearGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> m ()

getGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> m (Maybe GlyphItem)

glyphItemIter_glyphItem :: AttrLabelProxy "glyphItem"

setGlyphItemIterGlyphItem :: MonadIO m => GlyphItemIter -> Ptr GlyphItem -> m ()

startChar

getGlyphItemIterStartChar :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_startChar :: AttrLabelProxy "startChar"

setGlyphItemIterStartChar :: MonadIO m => GlyphItemIter -> Int32 -> m ()

startGlyph

getGlyphItemIterStartGlyph :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_startGlyph :: AttrLabelProxy "startGlyph"

setGlyphItemIterStartGlyph :: MonadIO m => GlyphItemIter -> Int32 -> m ()

startIndex

getGlyphItemIterStartIndex :: MonadIO m => GlyphItemIter -> m Int32

glyphItemIter_startIndex :: AttrLabelProxy "startIndex"

setGlyphItemIterStartIndex :: MonadIO m => GlyphItemIter -> Int32 -> m ()

text

clearGlyphItemIterText :: MonadIO m => GlyphItemIter -> m ()

getGlyphItemIterText :: MonadIO m => GlyphItemIter -> m (Maybe Text)

glyphItemIter_text :: AttrLabelProxy "text"

setGlyphItemIterText :: MonadIO m => GlyphItemIter -> CString -> m ()