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

Eq ScriptIter

Defined in GI.Pango.Structs.ScriptIter

Methods

(==) :: ScriptIter -> ScriptIter -> Bool

(/=) :: ScriptIter -> ScriptIter -> Bool

IsGValue ScriptIter

Convert ScriptIter to and from GValue with toGValue and fromGValue.

Defined in GI.Pango.Structs.ScriptIter

Methods

toGValue :: ScriptIter -> IO GValue

fromGValue :: GValue -> IO ScriptIter

ManagedPtrNewtype ScriptIter

Defined in GI.Pango.Structs.ScriptIter

Methods

toManagedPtr :: ScriptIter -> ManagedPtr ScriptIter

TypedObject ScriptIter

Defined in GI.Pango.Structs.ScriptIter

Methods

glibType :: IO GType

GBoxed ScriptIter

Defined in GI.Pango.Structs.ScriptIter

HasParentTypes ScriptIter

Defined in GI.Pango.Structs.ScriptIter

type ParentTypes ScriptIter

Defined in GI.Pango.Structs.ScriptIter

type ParentTypes ScriptIter = '[] :: [Type]

Methods

Overloaded methods

free

scriptIterFree

Arguments

:: (HasCallStack, MonadIO m)

=> ScriptIter

iter: a ScriptIter

-> m ()

Frees a ScriptIter created with scriptIterNew.

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)

Note that while the type of the script argument is declared as PangoScript, as of Pango 1.18, this function simply returns GUnicodeScript values. Callers must be prepared to handle unknown values.

Since: 1.4

new

scriptIterNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

text: a UTF-8 string

-> Int32

length: length of text, or -1 if text is nul-terminated.

-> m ScriptIter

Returns: the new script iterator, initialized to point at the first range in the text, which should be freed with scriptIterFree. If the string is empty, it will point at an empty range.

Create a new ScriptIter, used to break a string of Unicode text into runs by Unicode script. No copy is made of text, so the caller needs to make sure it remains valid until the iterator is freed with scriptIterFree.

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