GI.Pango.Structs.ScriptIter

A ScriptIter is used to iterate through a string and identify ranges in different scripts.

Exported types

newtype ScriptIter

Memory-managed wrapper type.

Constructors

ScriptIter (ManagedPtr ScriptIter)

Instances

WrappedPtr ScriptIter

Defined in GI.Pango.Structs.ScriptIter

Methods

wrappedPtrCalloc :: IO (Ptr ScriptIter)

wrappedPtrCopy :: ScriptIter -> IO ScriptIter

wrappedPtrFree :: Maybe (GDestroyNotify ScriptIter)

noScriptIter :: Maybe ScriptIter

A convenience alias for Nothing :: Maybe ScriptIter.

Methods

free

scriptIterFree

Arguments

:: (HasCallStack, MonadIO m)

=> ScriptIter

iter: a ScriptIter

-> m ()

Frees a ScriptIter created with pango_script_iter_new().

Since: 1.4

getRange

scriptIterGetRange

Arguments

:: (HasCallStack, MonadIO m)

=> ScriptIter

iter: a ScriptIter

-> m (Text, Text, Script)

Gets information about the range to which iter currently points. The range is the set of locations p where *start <= p < *end. (That is, it doesn't include the character stored at *end)

Since: 1.4

next

scriptIterNext

Arguments

:: (HasCallStack, MonadIO m)

=> ScriptIter

iter: a ScriptIter

-> m Bool

Returns: True if iter was successfully advanced.

Advances a ScriptIter to the next range. If iter is already at the end, it is left unchanged and False is returned.

Since: 1.4