gi-pango-1.0.22: Pango bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Pango.Structs.ScriptIter

Contents

Description

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

Synopsis

Exported types

newtype ScriptIter Source #

Memory-managed wrapper type.

Constructors

ScriptIter (ManagedPtr ScriptIter) 
Instances
Eq ScriptIter Source # 
Instance details

Defined in GI.Pango.Structs.ScriptIter

Methods

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

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

BoxedObject ScriptIter Source # 
Instance details

Defined in GI.Pango.Structs.ScriptIter

Methods

boxedType :: ScriptIter -> IO GType

IsGValue ScriptIter Source #

Convert ScriptIter to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Pango.Structs.ScriptIter

Methods

toGValue :: ScriptIter -> IO GValue

fromGValue :: GValue -> IO ScriptIter

noScriptIter :: Maybe ScriptIter Source #

A convenience alias for Nothing :: Maybe ScriptIter.

Methods

Overloaded methods

free

scriptIterFree Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptIter

iter: a tScriptIter

-> m () 

Frees a tScriptIter created with scriptIterNew.

Since: 1.4

getRange

scriptIterGetRange Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptIter

iter: a tScriptIter

-> 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 Source #

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 tScriptIter, 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 Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> ScriptIter

iter: a tScriptIter

-> m Bool

Returns: True if iter was successfully advanced.

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

Since: 1.4