GI.Pango.Structs.GlyphItemIter

A GlyphItemIter is an iterator over the clusters in a GlyphItem. The <firstterm>forward direction</firstterm> of the iterator is the logical direction of text. That is, with increasing startIndex and startChar values. If glyphItem is right-to-left (that is, if <literal>glyphItem->item->analysis.level</literal> is odd), then startGlyph decreases as the iterator moves forward. Moreover, in right-to-left cases, startGlyph is greater than endGlyph.

An iterator should be initialized using either of glyphItemIterInitStart and glyphItemIterInitEnd, for forward and backward iteration respectively, and walked over using any desired mixture of glyphItemIterNextCluster and glyphItemIterPrevCluster. 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 (&amp;cluster_iter, glyph_item, text); have_cluster; have_cluster = pango_glyph_item_iter_next_cluster (&amp;cluster_iter)) { ... } </programlisting>

Note that text is the start of the text for layout, which is then indexed by <literal>glyphItem->item->offset</literal> to get to the text of glyphItem. The startIndex and endIndex values can directly index into text. The startGlyph, endGlyph, startChar, and endChar values however are zero-based for the glyphItem. 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 GlyphItemIter 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

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

orig: a GlyphItemIter, may be Nothing

-> m (Maybe GlyphItemIter)

Returns: the newly allocated GlyphItemIter, which should be freed with glyphItemIterFree, or Nothing if orig was Nothing.

Make a shallow copy of an existing GlyphItemIter structure.

Since: 1.22

free

data GlyphItemIterFreeMethodInfo

Instances

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

Methods

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

glyphItemIterFree

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

iter: a GlyphItemIter, may be Nothing

-> m ()

Frees a GlyphItemIter created by glyphItemIterCopy.

Since: 1.22

initEnd

data GlyphItemIterInitEndMethodInfo

Instances

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

Methods

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

glyphItemIterInitEnd

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

iter: a GlyphItemIter

-> GlyphItem

glyphItem: the glyph item to iterate over

-> Text

text: text corresponding to the glyph item

-> m Bool

Returns: False if there are no clusters in the glyph item

Initializes a GlyphItemIter structure to point to the last cluster in a glyph item. See GlyphItemIter for details of cluster orders.

Since: 1.22

initStart

data GlyphItemIterInitStartMethodInfo

Instances

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

Methods

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

glyphItemIterInitStart

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

iter: a GlyphItemIter

-> GlyphItem

glyphItem: the glyph item to iterate over

-> Text

text: text corresponding to the glyph item

-> m Bool

Returns: False if there are no clusters in the glyph item

Initializes a GlyphItemIter structure to point to the first cluster in a glyph item. See GlyphItemIter for details of cluster orders.

Since: 1.22

nextCluster

data GlyphItemIterNextClusterMethodInfo

Instances

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

Methods

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

glyphItemIterNextCluster

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

iter: a GlyphItemIter

-> m Bool

Returns: True if the iterator was advanced, False if we were already on the last cluster.

Advances the iterator to the next cluster in the glyph item. See GlyphItemIter for details of cluster orders.

Since: 1.22

prevCluster

data GlyphItemIterPrevClusterMethodInfo

Instances

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

Methods

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

glyphItemIterPrevCluster

Arguments

:: (HasCallStack, MonadIO m)

=> GlyphItemIter

iter: a GlyphItemIter

-> m Bool

Returns: True if the iterator was moved, False if we were already on the first cluster.

Moves the iterator to the preceding cluster in the glyph item. See GlyphItemIter for details of cluster orders.

Since: 1.22

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 ()