GI.Pango.Structs.TabArray

A TabArray struct contains an array of tab stops. Each tab stop has an alignment and a position.

Exported types

newtype TabArray

Constructors

TabArray (ManagedPtr TabArray)

Instances

BoxedObject TabArray

Methods

boxedType :: TabArray -> IO GType

noTabArray :: Maybe TabArray

Methods

copy

tabArrayCopy

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

src: TabArray to copy

-> m TabArray

Returns: the newly allocated TabArray, which should be freed with tabArrayFree.

Copies a TabArray

free

tabArrayFree

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> m ()

Frees a tab array and associated resources.

getPositionsInPixels

tabArrayGetPositionsInPixels

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> m Bool

Returns: whether positions are in pixels.

Returns True if the tab positions are in pixels, False if they are in Pango units.

getSize

tabArrayGetSize

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> m Int32

Returns: the number of tab stops in the array.

Gets the number of tab stops in tabArray.

getTab

tabArrayGetTab

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> Int32

tabIndex: tab stop index

-> m (TabAlign, Int32)

Gets the alignment and position of a tab stop.

getTabs

tabArrayGetTabs

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> m (TabAlign, Ptr Int32)

If non-Nothing, alignments and locations are filled with allocated arrays of length tabArrayGetSize. You must free the returned array.

new

tabArrayNew

Arguments

:: (HasCallStack, MonadIO m)

=> Int32

initialSize: Initial number of tab stops to allocate, can be 0

-> Bool

positionsInPixels: whether positions are in pixel units

-> m TabArray

Returns: the newly allocated TabArray, which should be freed with tabArrayFree.

Creates an array of initialSize tab stops. Tab stops are specified in pixel units if positionsInPixels is True, otherwise in Pango units. All stops are initially at position 0.

resize

tabArrayResize

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> Int32

newSize: new size of the array

-> m ()

Resizes a tab array. You must subsequently initialize any tabs that were added as a result of growing the array.

setTab

tabArraySetTab

Arguments

:: (HasCallStack, MonadIO m)

=> TabArray

tabArray: a TabArray

-> Int32

tabIndex: the index of a tab stop

-> TabAlign

alignment: tab alignment

-> Int32

location: tab location in Pango units

-> m ()

Sets the alignment and location of a tab stop. alignment must always be PANGO_TAB_LEFT in the current implementation.