Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Pango.Structs.GlyphItemIter

Contents

Exported types
Methods
Properties

Description

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 intotext. 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.

Synopsis

Exported types

newtype GlyphItemIter Source

Constructors

GlyphItemIter (ForeignPtr GlyphItemIter)

Instances

BoxedObject GlyphItemIter Source
Methods boxedType :: GlyphItemIter -> IO GType
((~) * info (ResolveGlyphItemIterMethod t GlyphItemIter), MethodInfo * info GlyphItemIter p) => IsLabel t (GlyphItemIter -> p) Source
Methods fromLabel :: Proxy# Symbol t -> GlyphItemIter -> p
((~) * info (ResolveGlyphItemIterMethod t GlyphItemIter), MethodInfo * info GlyphItemIter p) => IsLabelProxy t (GlyphItemIter -> p) Source
Methods fromLabelProxy :: Proxy Symbol t -> GlyphItemIter -> p
((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterPrevClusterMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterPrevClusterMethodInfo GlyphItemIter -> signature -> s
((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterNextClusterMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterNextClusterMethodInfo GlyphItemIter -> signature -> s
((~) (TYPE Lifted) signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterInitStartMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterInitStartMethodInfo GlyphItemIter -> signature -> s
((~) (TYPE Lifted) signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterInitEndMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterInitEndMethodInfo GlyphItemIter -> signature -> s
((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterFreeMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterFreeMethodInfo GlyphItemIter -> signature -> s
((~) (TYPE Lifted) signature (m GlyphItemIter), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterCopyMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterCopyMethodInfo GlyphItemIter -> signature -> s

newZeroGlyphItemIter :: MonadIO m => m GlyphItemIter Source

Construct a GlyphItemIter struct initialized to zero.

noGlyphItemIter :: Maybe GlyphItemIter Source

Methods

glyphItemIterCopy

data GlyphItemIterCopyMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m GlyphItemIter), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterCopyMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterCopyMethodInfo GlyphItemIter -> signature -> s

glyphItemIterCopy :: MonadIO m => GlyphItemIter -> m GlyphItemIter Source

glyphItemIterFree

data GlyphItemIterFreeMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m ()), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterFreeMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterFreeMethodInfo GlyphItemIter -> signature -> s

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

glyphItemIterInitEnd

data GlyphItemIterInitEndMethodInfo Source

Instances

((~) (TYPE Lifted) signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterInitEndMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterInitEndMethodInfo GlyphItemIter -> signature -> s

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

glyphItemIterInitStart

data GlyphItemIterInitStartMethodInfo Source

Instances

((~) (TYPE Lifted) signature (GlyphItem -> Text -> m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterInitStartMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterInitStartMethodInfo GlyphItemIter -> signature -> s

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

glyphItemIterNextCluster

data GlyphItemIterNextClusterMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterNextClusterMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterNextClusterMethodInfo GlyphItemIter -> signature -> s

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

glyphItemIterPrevCluster

data GlyphItemIterPrevClusterMethodInfo Source

Instances

((~) (TYPE Lifted) signature (m Bool), MonadIO m) => MethodInfo (TYPE Lifted) GlyphItemIterPrevClusterMethodInfo GlyphItemIter signature Source
Methods overloadedMethod :: MethodProxy GlyphItemIterPrevClusterMethodInfo GlyphItemIter -> signature -> s