pango/org.gtkkn.bindings.pango/Layout

Layout

open class Layout(pointer: <Error class: unknown class><<Error class: unknown class>>)

A PangoLayout structure represents an entire paragraph of text.

While complete access to the layout capabilities of Pango is provided using the detailed interfaces for itemization and shaping, using that functionality directly involves writing a fairly large amount of code. PangoLayout provides a high-level driver for formatting entire paragraphs of text at once. This includes paragraph-level functionality such as line breaking, justification, alignment and ellipsization.

A PangoLayout is initialized with a PangoContext, UTF-8 string and set of attributes for that string. Once that is done, the set of formatted lines can be extracted from the object, the layout can be rendered, and conversion between logical character positions within the layout's text, and the physical position of the resulting glyphs can be made.

There are a number of parameters to adjust the formatting of a PangoLayout. The following image shows adjustable parameters (on the left) and font metrics (on the right):

The following images demonstrate the effect of alignment and justification on the layout of text:

It is possible, as well, to ignore the 2-D setup, and simply treat the results of a PangoLayout as a list of lines.

Skipped during bindings generation

parameter attrs: attrs: Out parameter is not supported
parameter n_attrs: n_attrs: Out parameter is not supported
parameter width: width: Out parameter is not supported
parameter width: width: Out parameter is not supported
parameter line: line: Out parameter is not supported
parameter new_index: new_index: Out parameter is not supported
parameter accel_char: accel_char: Out parameter is not supported
parameter index: index: Out parameter is not supported

Constructors

Layout

constructor(context: Context)

Create a new PangoLayout object with attributes initialized to default values for a particular PangoContext.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

pangoLayoutPointer

val pangoLayoutPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

contextChanged

open fun contextChanged()

Forces recomputation of any state in the PangoLayout that might depend on the layout's context.

copy

open fun copy(): Layout

Creates a deep copy-by-value of the layout.

getAlignment

open fun getAlignment(): Alignment

Gets the alignment for the layout: how partial lines are positioned within the horizontal space available.

getAttributes

open fun getAttributes(): AttrList?

Gets the attribute list for the layout, if any.

getAutoDir

open fun getAutoDir(): Boolean

Gets whether to calculate the base direction for the layout according to its contents.

getBaseline

open fun getBaseline(): <Error class: unknown class>

Gets the Y position of baseline of the first line in @layout.

getCaretPos

open fun getCaretPos(index: <Error class: unknown class>, strongPos: Rectangle?, weakPos: Rectangle?)

Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index.

getCharacterCount

open fun getCharacterCount(): <Error class: unknown class>

Returns the number of Unicode characters in the the text of @layout.

getContext

open fun getContext(): Context

Retrieves the PangoContext used for this layout.

getCursorPos

open fun getCursorPos(index: <Error class: unknown class>, strongPos: Rectangle?, weakPos: Rectangle?)

Given an index within a layout, determines the positions that of the strong and weak cursors if the insertion point is at that index.

getDirection

open fun getDirection(index: <Error class: unknown class>): Direction

Gets the text direction at the given character position in @layout.

getEllipsize

open fun getEllipsize(): EllipsizeMode

Gets the type of ellipsization being performed for @layout.

getExtents

open fun getExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

Computes the logical and ink extents of @layout.

getFontDescription

open fun getFontDescription(): FontDescription?

Gets the font description for the layout, if any.

getHeight

open fun getHeight(): <Error class: unknown class>

Gets the height of layout used for ellipsization.

getIndent

open fun getIndent(): <Error class: unknown class>

Gets the paragraph indent width in Pango units.

getIter

open fun getIter(): LayoutIter

Returns an iterator to iterate over the visual extents of the layout.

getJustify

open fun getJustify(): Boolean

Gets whether each complete line should be stretched to fill the entire width of the layout.

getJustifyLastLine

open fun getJustifyLastLine(): Boolean

Gets whether the last line should be stretched to fill the entire width of the layout.

getLine

open fun getLine(line: <Error class: unknown class>): LayoutLine?

Retrieves a particular line from a PangoLayout.

getLineCount

open fun getLineCount(): <Error class: unknown class>

Retrieves the count of lines for the @layout.

getLineReadonly

open fun getLineReadonly(line: <Error class: unknown class>): LayoutLine?

Retrieves a particular line from a PangoLayout.

getLines

open fun getLines(): <Error class: unknown class>

Returns the lines of the @layout as a list.

getLineSpacing

open fun getLineSpacing(): <Error class: unknown class>

Gets the line spacing factor of @layout.

getLinesReadonly

open fun getLinesReadonly(): <Error class: unknown class>

Returns the lines of the @layout as a list.

getPixelExtents

open fun getPixelExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

Computes the logical and ink extents of @layout in device units.

getSerial

open fun getSerial(): <Error class: unknown class>

Returns the current serial number of @layout.

getSingleParagraphMode

open fun getSingleParagraphMode(): Boolean

Obtains whether @layout is in single paragraph mode.

getSpacing

open fun getSpacing(): <Error class: unknown class>

Gets the amount of spacing between the lines of the layout.

getTabs

open fun getTabs(): TabArray?

Gets the current PangoTabArray used by this layout.

getText

open fun getText(): String

Gets the text in the layout.

getUnknownGlyphsCount

open fun getUnknownGlyphsCount(): <Error class: unknown class>

Counts the number of unknown glyphs in @layout.

getWidth

open fun getWidth(): <Error class: unknown class>

Gets the width to which the lines of the PangoLayout should wrap.

getWrap

open fun getWrap(): WrapMode

Gets the wrap mode for the layout.

indexToPos

open fun indexToPos(index: <Error class: unknown class>, pos: Rectangle)

Converts from an index within a PangoLayout to the onscreen position corresponding to the grapheme at that index.

isEllipsized

open fun isEllipsized(): Boolean

Queries whether the layout had to ellipsize any paragraphs.

isWrapped

open fun isWrapped(): Boolean

Queries whether the layout had to wrap any paragraphs.

serialize

open fun serialize(flags: LayoutSerializeFlags): <Error class: unknown class>

Serializes the @layout for later deserialization via func@Pango.Layout.deserialize.

setAlignment

open fun setAlignment(alignment: Alignment)

Sets the alignment for the layout: how partial lines are positioned within the horizontal space available.

setAttributes

open fun setAttributes(attrs: AttrList? = null)

Sets the text attributes for a layout object.

setAutoDir

open fun setAutoDir(autoDir: Boolean)

Sets whether to calculate the base direction for the layout according to its contents.

setEllipsize

open fun setEllipsize(ellipsize: EllipsizeMode)

Sets the type of ellipsization being performed for @layout.

setFontDescription

open fun setFontDescription(desc: FontDescription? = null)

Sets the default font description for the layout.

setHeight

open fun setHeight(height: <Error class: unknown class>)

Sets the height to which the PangoLayout should be ellipsized at.

setIndent

open fun setIndent(indent: <Error class: unknown class>)

Sets the width in Pango units to indent each paragraph.

setJustify

open fun setJustify(justify: Boolean)

Sets whether each complete line should be stretched to fill the entire width of the layout.

setJustifyLastLine

open fun setJustifyLastLine(justify: Boolean)

Sets whether the last line should be stretched to fill the entire width of the layout.

setLineSpacing

open fun setLineSpacing(factor: <Error class: unknown class>)

Sets a factor for line spacing.

setMarkup

open fun setMarkup(markup: String, length: <Error class: unknown class>)

Sets the layout text and attribute list from marked-up text.

setSingleParagraphMode

open fun setSingleParagraphMode(setting: Boolean)

Sets the single paragraph mode of @layout.

setSpacing

open fun setSpacing(spacing: <Error class: unknown class>)

Sets the amount of spacing in Pango units between the lines of the layout.

setTabs

open fun setTabs(tabs: TabArray? = null)

Sets the tabs to use for @layout, overriding the default tabs.

setText

open fun setText(text: String, length: <Error class: unknown class>)

Sets the text of the layout.

setWidth

open fun setWidth(width: <Error class: unknown class>)

Sets the width to which the lines of the PangoLayout should wrap or ellipsized.

setWrap

open fun setWrap(wrap: WrapMode)

Sets the wrap mode.

writeToFile

open fun writeToFile(flags: LayoutSerializeFlags, filename: String): <Error class: unknown class><Boolean>

A convenience method to serialize a layout to a file.