LayoutProtocol

public protocol LayoutProtocol : ObjectProtocol

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):

<picture> <source srcset=“layout-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Pango Layout Parameters” src=“layout-light.png”> </picture>

The following images demonstrate the effect of alignment and justification on the layout of text:
align=left align=left, justify
align=center align=center, justify
align=right align=right, justify

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

The LayoutProtocol protocol exposes the methods and properties of an underlying PangoLayout instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Layout. Alternatively, use LayoutRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying PangoLayout instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • layout_ptr Default implementation

    Typed pointer to the underlying PangoLayout instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the PangoLayout instance.

    Declaration

    Swift

    var layout_ptr: UnsafeMutablePointer<PangoLayout>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to LayoutProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Layout Class: LayoutProtocol extension (methods and fields)

  • contextChanged() Extension method

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

    This function should be called if you make changes to the context subsequent to creating the layout.

    Declaration

    Swift

    @inlinable
func contextChanged()
    Show on GitHub
  • copy() Extension method

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

    The attribute list, tab array, and text from the original layout are all copied by value.

    Declaration

    Swift

    @inlinable
func copy() -> Pango.LayoutRef!
    Show on GitHub
  • getAlignment() Extension method

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

    Declaration

    Swift

    @inlinable
func getAlignment() -> PangoAlignment
    Show on GitHub
  • getAttributes() Extension method

    Gets the attribute list for the layout, if any.

    Declaration

    Swift

    @inlinable
func getAttributes() -> Pango.AttrListRef!
    Show on GitHub
  • getAutoDir() Extension method

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

    See [methodPango.Layout.set_auto_dir].

    Declaration

    Swift

    @inlinable
func getAutoDir() -> Bool
    Show on GitHub
  • getBaseline() Extension method

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

    Declaration

    Swift

    @inlinable
func getBaseline() -> Int
    Show on GitHub

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

    This is a variant of [methodPango.Layout.get_cursor_pos] that applies font metric information about caret slope and offset to the positions it returns.

    <picture> <source srcset=“caret-metrics-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Caret metrics” src=“caret-metrics-light.png”> </picture>

    Declaration

    Swift

    @inlinable
func getCaretPos(index: Int, strongPos: RectangleRef? = nil, weakPos: RectangleRef? = nil)
    Show on GitHub

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

    This is a variant of [methodPango.Layout.get_cursor_pos] that applies font metric information about caret slope and offset to the positions it returns.

    <picture> <source srcset=“caret-metrics-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Caret metrics” src=“caret-metrics-light.png”> </picture>

    Declaration

    Swift

    @inlinable
func getCaretPos<RectangleT>(index: Int, strongPos: RectangleT?, weakPos: RectangleT?) where RectangleT : RectangleProtocol
    Show on GitHub
  • getCharacterCount() Extension method

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

    Declaration

    Swift

    @inlinable
func getCharacterCount() -> Int
    Show on GitHub
  • getContext() Extension method

    Retrieves the PangoContext used for this layout.

    Declaration

    Swift

    @inlinable
func getContext() -> Pango.ContextRef!
    Show on GitHub

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

    The position of each cursor is stored as a zero-width rectangle with the height of the run extents.

    <picture> <source srcset=“cursor-positions-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Cursor positions” src=“cursor-positions-light.png”> </picture>

    The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.

    The following example shows text with both a strong and a weak cursor.

    <picture> <source srcset=“split-cursor-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Strong and weak cursors” src=“split-cursor-light.png”> </picture>

    The strong cursor has a little arrow pointing to the right, the weak cursor to the left. Typing a ‘c’ in this situation will insert the character after the ‘b’, and typing another Hebrew character, like ‘ג’, will insert it at the end.

    Declaration

    Swift

    @inlinable
func getCursorPos(index: Int, strongPos: RectangleRef? = nil, weakPos: RectangleRef? = nil)
    Show on GitHub

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

    The position of each cursor is stored as a zero-width rectangle with the height of the run extents.

    <picture> <source srcset=“cursor-positions-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Cursor positions” src=“cursor-positions-light.png”> </picture>

    The strong cursor location is the location where characters of the directionality equal to the base direction of the layout are inserted. The weak cursor location is the location where characters of the directionality opposite to the base direction of the layout are inserted.

    The following example shows text with both a strong and a weak cursor.

    <picture> <source srcset=“split-cursor-dark.png” media=“(prefers-color-scheme: dark)”> <img alt=“Strong and weak cursors” src=“split-cursor-light.png”> </picture>

    The strong cursor has a little arrow pointing to the right, the weak cursor to the left. Typing a ‘c’ in this situation will insert the character after the ‘b’, and typing another Hebrew character, like ‘ג’, will insert it at the end.

    Declaration

    Swift

    @inlinable
func getCursorPos<RectangleT>(index: Int, strongPos: RectangleT?, weakPos: RectangleT?) where RectangleT : RectangleProtocol
    Show on GitHub
  • getDirection(index:) Extension method

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

    Declaration

    Swift

    @inlinable
func getDirection(index: Int) -> PangoDirection
    Show on GitHub
  • getEllipsize() Extension method

    Gets the type of ellipsization being performed for layout.

    See [methodPango.Layout.set_ellipsize].

    Use [methodPango.Layout.is_ellipsized] to query whether any paragraphs were actually ellipsized.

    Declaration

    Swift

    @inlinable
func getEllipsize() -> PangoEllipsizeMode
    Show on GitHub

  • Computes the logical and ink extents of layout.

    Logical extents are usually what you want for positioning things. Note that both extents may have non-zero x and y. You may want to use those to offset where you render the layout. Not doing that is a very typical bug that shows up as right-to-left layouts not being correctly positioned in a layout with a set width.

    The extents are given in layout coordinates and in Pango units; layout coordinates begin at the top left corner of the layout.

    Declaration

    Swift

    @inlinable
func getExtents(inkRect: RectangleRef? = nil, logicalRect: RectangleRef? = nil)
    Show on GitHub

  • Computes the logical and ink extents of layout.

    Logical extents are usually what you want for positioning things. Note that both extents may have non-zero x and y. You may want to use those to offset where you render the layout. Not doing that is a very typical bug that shows up as right-to-left layouts not being correctly positioned in a layout with a set width.

    The extents are given in layout coordinates and in Pango units; layout coordinates begin at the top left corner of the layout.

    Declaration

    Swift

    @inlinable
func getExtents<RectangleT>(inkRect: RectangleT?, logicalRect: RectangleT?) where RectangleT : RectangleProtocol
    Show on GitHub
  • getFontDescription() Extension method

    Gets the font description for the layout, if any.

    Declaration

    Swift

    @inlinable
func getFontDescription() -> Pango.FontDescriptionRef!
    Show on GitHub
  • getHeight() Extension method

    Gets the height of layout used for ellipsization.

    See [methodPango.Layout.set_height] for details.

    Declaration

    Swift

    @inlinable
func getHeight() -> Int
    Show on GitHub
  • getIndent() Extension method

    Gets the paragraph indent width in Pango units.

    A negative value indicates a hanging indentation.

    Declaration

    Swift

    @inlinable
func getIndent() -> Int
    Show on GitHub
  • getIter() Extension method

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

    Declaration

    Swift

    @inlinable
func getIter() -> Pango.LayoutIterRef!
    Show on GitHub
  • getJustify() Extension method

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

    Declaration

    Swift

    @inlinable
func getJustify() -> Bool
    Show on GitHub
  • getJustifyLastLine() Extension method

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

    Declaration

    Swift

    @inlinable
func getJustifyLastLine() -> Bool
    Show on GitHub
  • get(line:) Extension method

    Retrieves a particular line from a PangoLayout.

    Use the faster [methodPango.Layout.get_line_readonly] if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
func get(line: Int) -> Pango.LayoutLineRef!
    Show on GitHub
  • getLineCount() Extension method

    Retrieves the count of lines for the layout.

    Declaration

    Swift

    @inlinable
func getLineCount() -> Int
    Show on GitHub
  • getLineReadonly(line:) Extension method

    Retrieves a particular line from a PangoLayout.

    This is a faster alternative to [methodPango.Layout.get_line], but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
func getLineReadonly(line: Int) -> Pango.LayoutLineRef!
    Show on GitHub
  • getLineSpacing() Extension method

    Gets the line spacing factor of layout.

    See [methodPango.Layout.set_line_spacing].

    Declaration

    Swift

    @inlinable
func getLineSpacing() -> CFloat
    Show on GitHub
  • getLines() Extension method

    Returns the lines of the layout as a list.

    Use the faster [methodPango.Layout.get_lines_readonly] if you do not plan to modify the contents of the lines (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
func getLines() -> GLib.SListRef!
    Show on GitHub
  • getLinesReadonly() Extension method

    Returns the lines of the layout as a list.

    This is a faster alternative to [methodPango.Layout.get_lines], but the user is not expected to modify the contents of the lines (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
func getLinesReadonly() -> GLib.SListRef!
    Show on GitHub
  • getLog(attrs:nAttrs:) Extension method

    Retrieves an array of logical attributes for each character in the layout.

    Declaration

    Swift

    @inlinable
func getLog(attrs: UnsafeMutablePointer<UnsafeMutablePointer<PangoLogAttr>?>!, nAttrs: UnsafeMutablePointer<gint>!)
    Show on GitHub
  • getLogAttrsReadonly(nAttrs:) Extension method

    Retrieves an array of logical attributes for each character in the layout.

    This is a faster alternative to [methodPango.Layout.get_log_attrs]. The returned array is part of layout and must not be modified. Modifying the layout will invalidate the returned array.

    The number of attributes returned in n_attrs will be one more than the total number of characters in the layout, since there need to be attributes corresponding to both the position before the first character and the position after the last character.

    Declaration

    Swift

    @inlinable
func getLogAttrsReadonly(nAttrs: UnsafeMutablePointer<gint>!) -> UnsafePointer<PangoLogAttr>!
    Show on GitHub

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

    This function just calls [methodPango.Layout.get_extents] followed by two [funcextents_to_pixels] calls, rounding ink_rect and logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [funcPango.extents_to_pixels]).

    Declaration

    Swift

    @inlinable
func getPixelExtents(inkRect: RectangleRef? = nil, logicalRect: RectangleRef? = nil)
    Show on GitHub

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

    This function just calls [methodPango.Layout.get_extents] followed by two [funcextents_to_pixels] calls, rounding ink_rect and logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [funcPango.extents_to_pixels]).

    Declaration

    Swift

    @inlinable
func getPixelExtents<RectangleT>(inkRect: RectangleT?, logicalRect: RectangleT?) where RectangleT : RectangleProtocol
    Show on GitHub
  • getPixelSize(width:height:) Extension method

    Determines the logical width and height of a PangoLayout in device units.

    [methodPango.Layout.get_size] returns the width and height scaled by PANGO_SCALE. This is simply a convenience function around [methodPango.Layout.get_pixel_extents].

    Declaration

    Swift

    @inlinable
func getPixelSize(width: UnsafeMutablePointer<gint>! = nil, height: UnsafeMutablePointer<gint>! = nil)
    Show on GitHub
  • getSerial() Extension method

    Returns the current serial number of layout.

    The serial number is initialized to an small number larger than zero when a new layout is created and is increased whenever the layout is changed using any of the setter functions, or the PangoContext it uses has changed. The serial may wrap, but will never have the value 0. Since it can wrap, never compare it with “less than”, always use “not equals”.

    This can be used to automatically detect changes to a PangoLayout, and is useful for example to decide whether a layout needs redrawing. To force the serial to be increased, use [methodPango.Layout.context_changed].

    Declaration

    Swift

    @inlinable
func getSerial() -> Int
    Show on GitHub
  • getSingleParagraphMode() Extension method

    Obtains whether layout is in single paragraph mode.

    See [methodPango.Layout.set_single_paragraph_mode].

    Declaration

    Swift

    @inlinable
func getSingleParagraphMode() -> Bool
    Show on GitHub
  • getSize(width:height:) Extension method

    Determines the logical width and height of a PangoLayout in Pango units.

    This is simply a convenience function around [methodPango.Layout.get_extents].

    Declaration

    Swift

    @inlinable
func getSize(width: UnsafeMutablePointer<gint>! = nil, height: UnsafeMutablePointer<gint>! = nil)
    Show on GitHub
  • getSpacing() Extension method

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

    Declaration

    Swift

    @inlinable
func getSpacing() -> Int
    Show on GitHub
  • getTabs() Extension method

    Gets the current PangoTabArray used by this layout.

    If no PangoTabArray has been set, then the default tabs are in use and nil is returned. Default tabs are every 8 spaces.

    The return value should be freed with [methodPango.TabArray.free].

    Declaration

    Swift

    @inlinable
func getTabs() -> Pango.TabArrayRef!
    Show on GitHub
  • getText() Extension method

    Gets the text in the layout.

    The returned text should not be freed or modified.

    Declaration

    Swift

    @inlinable
func getText() -> String!
    Show on GitHub
  • getUnknownGlyphsCount() Extension method

    Counts the number of unknown glyphs in layout.

    This function can be used to determine if there are any fonts available to render all characters in a certain string, or when used in combination with PANGO_ATTR_FALLBACK, to check if a certain font supports all the characters in the string.

    Declaration

    Swift

    @inlinable
func getUnknownGlyphsCount() -> Int
    Show on GitHub
  • getWidth() Extension method

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

    Declaration

    Swift

    @inlinable
func getWidth() -> Int
    Show on GitHub
  • getWrap() Extension method

    Gets the wrap mode for the layout.

    Use [methodPango.Layout.is_wrapped] to query whether any paragraphs were actually wrapped.

    Declaration

    Swift

    @inlinable
func getWrap() -> PangoWrapMode
    Show on GitHub

  • Converts from byte index_ within the layout to line and X position.

    The X position is measured from the left edge of the line.

    Declaration

    Swift

    @inlinable
func indexToLineX(index: Int, trailing: Bool, line: UnsafeMutablePointer<gint>! = nil, xPos: UnsafeMutablePointer<gint>! = nil)
    Show on GitHub
  • indexToPos(index:pos:) Extension method

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

    The return value is represented as rectangle. Note that pos-&gt;x is always the leading edge of the grapheme and pos-&gt;x + pos-&gt;width the trailing edge of the grapheme. If the directionality of the grapheme is right-to-left, then pos-&gt;width will be negative.

    Declaration

    Swift

    @inlinable
func indexToPos<RectangleT>(index: Int, pos: RectangleT) where RectangleT : RectangleProtocol
    Show on GitHub

  • Computes a new cursor position from an old position and a direction.

    If direction is positive, then the new position will cause the strong or weak cursor to be displayed one position to right of where it was with the old cursor position. If direction is negative, it will be moved to the left.

    In the presence of bidirectional text, the correspondence between logical and visual order will depend on the direction of the current run, and there may be jumps when the cursor is moved off of the end of a run.

    Motion here is in cursor positions, not in characters, so a single call to this function may move the cursor over multiple characters when multiple characters combine to form a single grapheme.

    Declaration

    Swift

    @inlinable
func moveCursorVisually(strong: Bool, oldIndex: Int, oldTrailing: Int, direction: Int, newIndex: UnsafeMutablePointer<gint>!, newTrailing: UnsafeMutablePointer<gint>!)
    Show on GitHub
  • serialize(flags:) Extension method

    Serializes the layout for later deserialization via [funcPango.Layout.deserialize].

    There are no guarantees about the format of the output across different versions of Pango and [funcPango.Layout.deserialize] will reject data that it cannot parse.

    The intended use of this function is testing, benchmarking and debugging. The format is not meant as a permanent storage format.

    Declaration

    Swift

    @inlinable
func serialize(flags: LayoutSerializeFlags) -> GLib.BytesRef!
    Show on GitHub
  • set(alignment:) Extension method

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

    The default alignment is PANGO_ALIGN_LEFT.

    Declaration

    Swift

    @inlinable
func set(alignment: PangoAlignment)
    Show on GitHub
  • setAttributes(attrs:) Extension method

    Sets the text attributes for a layout object.

    References attrs, so the caller can unref its reference.

    Declaration

    Swift

    @inlinable
func setAttributes(attrs: AttrListRef? = nil)
    Show on GitHub
  • setAttributes(attrs:) Extension method

    Sets the text attributes for a layout object.

    References attrs, so the caller can unref its reference.

    Declaration

    Swift

    @inlinable
func setAttributes<AttrListT>(attrs: AttrListT?) where AttrListT : AttrListProtocol
    Show on GitHub
  • set(autoDir:) Extension method

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

    When this flag is on (the default), then paragraphs in layout that begin with strong right-to-left characters (Arabic and Hebrew principally), will have right-to-left layout, paragraphs with letters from other scripts will have left-to-right layout. Paragraphs with only neutral characters get their direction from the surrounding paragraphs.

    When false, the choice between left-to-right and right-to-left layout is done according to the base direction of the layout’s PangoContext. (See [methodPango.Context.set_base_dir]).

    When the auto-computed direction of a paragraph differs from the base direction of the context, the interpretation of PANGO_ALIGN_LEFT and PANGO_ALIGN_RIGHT are swapped.

    Declaration

    Swift

    @inlinable
func set(autoDir: Bool)
    Show on GitHub
  • set(ellipsize:) Extension method

    Sets the type of ellipsization being performed for layout.

    Depending on the ellipsization mode ellipsize text is removed from the start, middle, or end of text so they fit within the width and height of layout set with [methodPango.Layout.set_width] and [methodPango.Layout.set_height].

    If the layout contains characters such as newlines that force it to be layed out in multiple paragraphs, then whether each paragraph is ellipsized separately or the entire layout is ellipsized as a whole depends on the set height of the layout.

    The default value is PANGO_ELLIPSIZE_NONE.

    See [methodPango.Layout.set_height] for details.

    Declaration

    Swift

    @inlinable
func set(ellipsize: PangoEllipsizeMode)
    Show on GitHub
  • setFontDescription(desc:) Extension method

    Sets the default font description for the layout.

    If no font description is set on the layout, the font description from the layout’s context is used.

    Declaration

    Swift

    @inlinable
func setFontDescription(desc: FontDescriptionRef? = nil)
    Show on GitHub
  • setFontDescription(desc:) Extension method

    Sets the default font description for the layout.

    If no font description is set on the layout, the font description from the layout’s context is used.

    Declaration

    Swift

    @inlinable
func setFontDescription<FontDescriptionT>(desc: FontDescriptionT?) where FontDescriptionT : FontDescriptionProtocol
    Show on GitHub
  • set(height:) Extension method

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

    There are two different behaviors, based on whether height is positive or negative.

    If height is positive, it will be the maximum height of the layout. Only lines would be shown that would fit, and if there is any text omitted, an ellipsis added. At least one line is included in each paragraph regardless of how small the height value is. A value of zero will render exactly one line for the entire layout.

    If height is negative, it will be the (negative of) maximum number of lines per paragraph. That is, the total number of lines shown may well be more than this value if the layout contains multiple paragraphs of text. The default value of -1 means that the first line of each paragraph is ellipsized. This behavior may be changed in the future to act per layout instead of per paragraph. File a bug against pango at https://gitlab.gnome.org/gnome/pango if your code relies on this behavior.

    Height setting only has effect if a positive width is set on layout and ellipsization mode of layout is not PANGO_ELLIPSIZE_NONE. The behavior is undefined if a height other than -1 is set and ellipsization mode is set to PANGO_ELLIPSIZE_NONE, and may change in the future.

    Declaration

    Swift

    @inlinable
func set(height: Int)
    Show on GitHub
  • set(indent:) Extension method

    Sets the width in Pango units to indent each paragraph.

    A negative value of indent will produce a hanging indentation. That is, the first line will have the full width, and subsequent lines will be indented by the absolute value of indent.

    The indent setting is ignored if layout alignment is set to PANGO_ALIGN_CENTER.

    The default value is 0.

    Declaration

    Swift

    @inlinable
func set(indent: Int)
    Show on GitHub
  • set(justify:) Extension method

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

    Stretching is typically done by adding whitespace, but for some scripts (such as Arabic), the justification may be done in more complex ways, like extending the characters.

    Note that this setting is not implemented and so is ignored in Pango older than 1.18.

    Note that tabs and justification conflict with each other: Justification will move content away from its tab-aligned positions.

    The default value is false.

    Also see [methodPango.Layout.set_justify_last_line].

    Declaration

    Swift

    @inlinable
func set(justify: Bool)
    Show on GitHub
  • setJustifyLastLine(justify:) Extension method

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

    This only has an effect if [methodPango.Layout.set_justify] has been called as well.

    The default value is false.

    Declaration

    Swift

    @inlinable
func setJustifyLastLine(justify: Bool)
    Show on GitHub
  • setLineSpacing(factor:) Extension method

    Sets a factor for line spacing.

    Typical values are: 0, 1, 1.5, 2. The default values is 0.

    If factor is non-zero, lines are placed so that

    baseline2 = baseline1 + factor * height2

    where height2 is the line height of the second line (as determined by the font(s)). In this case, the spacing set with [methodPango.Layout.set_spacing] is ignored.

    If factor is zero (the default), spacing is applied as before.

    Note: for semantics that are closer to the CSS line-height property, see [funcPango.attr_line_height_new].

    Declaration

    Swift

    @inlinable
func setLineSpacing(factor: CFloat)
    Show on GitHub
  • set(markup:length:) Extension method

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

    See Pango Markup).

    Replaces the current text and attribute list.

    This is the same as [methodPango.Layout.set_markup_with_accel], but the markup text isn’t scanned for accelerators.

    Declaration

    Swift

    @inlinable
func set(markup: UnsafePointer<CChar>!, length: Int)
    Show on GitHub

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

    See Pango Markup).

    Replaces the current text and attribute list.

    If accel_marker is nonzero, the given character will mark the character following it as an accelerator. For example, accel_marker might be an ampersand or underscore. All characters marked as an accelerator will receive a PANGO_UNDERLINE_LOW attribute, and the first character so marked will be returned in accel_char. Two accel_marker characters following each other produce a single literal accel_marker character.

    Declaration

    Swift

    @inlinable
func setMarkupWithAccel(markup: UnsafePointer<CChar>!, length: Int, accelMarker: gunichar, accelChar: UnsafeMutablePointer<gunichar>! = nil)
    Show on GitHub

  • Sets the single paragraph mode of layout.

    If setting is true, do not treat newlines and similar characters as paragraph separators; instead, keep all text in a single paragraph, and display a glyph for paragraph separator characters. Used when you want to allow editing of newlines on a single text line.

    The default value is false.

    Declaration

    Swift

    @inlinable
func setSingleParagraphMode(setting: Bool)
    Show on GitHub
  • set(spacing:) Extension method

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

    When placing lines with spacing, Pango arranges things so that

    line2.top = line1.bottom + spacing

    The default value is 0.

    Note: Since 1.44, Pango is using the line height (as determined by the font) for placing lines when the line spacing factor is set to a non-zero value with [methodPango.Layout.set_line_spacing]. In that case, the spacing set with this function is ignored.

    Note: for semantics that are closer to the CSS line-height property, see [funcPango.attr_line_height_new].

    Declaration

    Swift

    @inlinable
func set(spacing: Int)
    Show on GitHub
  • set(tabs:) Extension method

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

    PangoLayout will place content at the next tab position whenever it meets a Tab character (U+0009).

    By default, tabs are every 8 spaces. If tabs is nil, the default tabs are reinstated. tabs is copied into the layout; you must free your copy of tabs yourself.

    Note that tabs and justification conflict with each other: Justification will move content away from its tab-aligned positions. The same is true for alignments other than PANGO_ALIGN_LEFT.

    Declaration

    Swift

    @inlinable
func set(tabs: TabArrayRef? = nil)
    Show on GitHub
  • set(tabs:) Extension method

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

    PangoLayout will place content at the next tab position whenever it meets a Tab character (U+0009).

    By default, tabs are every 8 spaces. If tabs is nil, the default tabs are reinstated. tabs is copied into the layout; you must free your copy of tabs yourself.

    Note that tabs and justification conflict with each other: Justification will move content away from its tab-aligned positions. The same is true for alignments other than PANGO_ALIGN_LEFT.

    Declaration

    Swift

    @inlinable
func set<TabArrayT>(tabs: TabArrayT?) where TabArrayT : TabArrayProtocol
    Show on GitHub
  • set(text:length:) Extension method

    Sets the text of the layout.

    This function validates text and renders invalid UTF-8 with a placeholder glyph.

    Note that if you have used [methodPango.Layout.set_markup] or [methodPango.Layout.set_markup_with_accel] on layout before, you may want to call [methodPango.Layout.set_attributes] to clear the attributes set on the layout from the markup as this function does not clear attributes.

    Declaration

    Swift

    @inlinable
func set(text: UnsafePointer<CChar>!, length: Int)
    Show on GitHub
  • set(width:) Extension method

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

    The default value is -1: no width set.

    Declaration

    Swift

    @inlinable
func set(width: Int)
    Show on GitHub
  • set(wrap:) Extension method

    Sets the wrap mode.

    The wrap mode only has effect if a width is set on the layout with [methodPango.Layout.set_width]. To turn off wrapping, set the width to -1.

    The default value is PANGO_WRAP_WORD.

    Declaration

    Swift

    @inlinable
func set(wrap: PangoWrapMode)
    Show on GitHub
  • writeToFile(flags:filename:) Extension method

    A convenience method to serialize a layout to a file.

    It is equivalent to calling [methodPango.Layout.serialize] followed by [funcGLib.file_set_contents].

    See those two functions for details on the arguments.

    It is mostly intended for use inside a debugger to quickly dump a layout to a file for later inspection.

    Declaration

    Swift

    @inlinable
func writeToFile(flags: LayoutSerializeFlags, filename: UnsafePointer<CChar>!) throws -> Bool
    Show on GitHub

  • Converts from X and Y position within a layout to the byte index to the character at that logical position.

    If the Y position is not inside the layout, the closest position is chosen (the position will be clamped inside the layout). If the X position is not within the layout, then the start or the end of the line is chosen as described for [methodPango.LayoutLine.x_to_index]. If either the X or Y positions were not inside the layout, then the function returns false; on an exact hit, it returns true.

    Declaration

    Swift

    @inlinable
func xyToIndex(x: Int, y: Int, index: UnsafeMutablePointer<gint>!, trailing: UnsafeMutablePointer<gint>!) -> Bool
    Show on GitHub
  • alignment Extension method

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

    Declaration

    Swift

    @inlinable
var alignment: PangoAlignment { get nonmutating set }
    Show on GitHub
  • attributes Extension method

    Gets the attribute list for the layout, if any.

    Declaration

    Swift

    @inlinable
var attributes: Pango.AttrListRef! { get nonmutating set }
    Show on GitHub
  • autoDir Extension method

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

    See [methodPango.Layout.set_auto_dir].

    Declaration

    Swift

    @inlinable
var autoDir: Bool { get nonmutating set }
    Show on GitHub
  • baseline Extension method

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

    Declaration

    Swift

    @inlinable
var baseline: Int { get }
    Show on GitHub
  • characterCount Extension method

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

    Declaration

    Swift

    @inlinable
var characterCount: Int { get }
    Show on GitHub
  • context Extension method

    Retrieves the PangoContext used for this layout.

    Declaration

    Swift

    @inlinable
var context: Pango.ContextRef! { get }
    Show on GitHub
  • ellipsize Extension method

    Gets the type of ellipsization being performed for layout.

    See [methodPango.Layout.set_ellipsize].

    Use [methodPango.Layout.is_ellipsized] to query whether any paragraphs were actually ellipsized.

    Declaration

    Swift

    @inlinable
var ellipsize: PangoEllipsizeMode { get nonmutating set }
    Show on GitHub
  • fontDescription Extension method

    Gets the font description for the layout, if any.

    Declaration

    Swift

    @inlinable
var fontDescription: Pango.FontDescriptionRef! { get nonmutating set }
    Show on GitHub
  • height Extension method

    Gets the height of layout used for ellipsization.

    See [methodPango.Layout.set_height] for details.

    Declaration

    Swift

    @inlinable
var height: Int { get nonmutating set }
    Show on GitHub
  • indent Extension method

    Gets the paragraph indent width in Pango units.

    A negative value indicates a hanging indentation.

    Declaration

    Swift

    @inlinable
var indent: Int { get nonmutating set }
    Show on GitHub
  • isEllipsized Extension method

    Queries whether the layout had to ellipsize any paragraphs.

    This returns true if the ellipsization mode for layout is not PANGO_ELLIPSIZE_NONE, a positive width is set on layout, and there are paragraphs exceeding that width that have to be ellipsized.

    Declaration

    Swift

    @inlinable
var isEllipsized: Bool { get }
    Show on GitHub
  • isWrapped Extension method

    Queries whether the layout had to wrap any paragraphs.

    This returns true if a positive width is set on layout, ellipsization mode of layout is set to PANGO_ELLIPSIZE_NONE, and there are paragraphs exceeding the layout width that have to be wrapped.

    Declaration

    Swift

    @inlinable
var isWrapped: Bool { get }
    Show on GitHub
  • iter Extension method

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

    Declaration

    Swift

    @inlinable
var iter: Pango.LayoutIterRef! { get }
    Show on GitHub
  • justify Extension method

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

    Declaration

    Swift

    @inlinable
var justify: Bool { get nonmutating set }
    Show on GitHub
  • justifyLastLine Extension method

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

    Declaration

    Swift

    @inlinable
var justifyLastLine: Bool { get nonmutating set }
    Show on GitHub
  • lineCount Extension method

    Retrieves the count of lines for the layout.

    Declaration

    Swift

    @inlinable
var lineCount: Int { get }
    Show on GitHub
  • lineSpacing Extension method

    Gets the line spacing factor of layout.

    See [methodPango.Layout.set_line_spacing].

    Declaration

    Swift

    @inlinable
var lineSpacing: CFloat { get nonmutating set }
    Show on GitHub
  • lines Extension method

    Returns the lines of the layout as a list.

    Use the faster [methodPango.Layout.get_lines_readonly] if you do not plan to modify the contents of the lines (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
var lines: GLib.SListRef! { get }
    Show on GitHub
  • linesReadonly Extension method

    Returns the lines of the layout as a list.

    This is a faster alternative to [methodPango.Layout.get_lines], but the user is not expected to modify the contents of the lines (glyphs, glyph widths, etc.).

    Declaration

    Swift

    @inlinable
var linesReadonly: GLib.SListRef! { get }
    Show on GitHub
  • serial Extension method

    Returns the current serial number of layout.

    The serial number is initialized to an small number larger than zero when a new layout is created and is increased whenever the layout is changed using any of the setter functions, or the PangoContext it uses has changed. The serial may wrap, but will never have the value 0. Since it can wrap, never compare it with “less than”, always use “not equals”.

    This can be used to automatically detect changes to a PangoLayout, and is useful for example to decide whether a layout needs redrawing. To force the serial to be increased, use [methodPango.Layout.context_changed].

    Declaration

    Swift

    @inlinable
var serial: Int { get }
    Show on GitHub
  • singleParagraphMode Extension method

    Obtains whether layout is in single paragraph mode.

    See [methodPango.Layout.set_single_paragraph_mode].

    Declaration

    Swift

    @inlinable
var singleParagraphMode: Bool { get nonmutating set }
    Show on GitHub
  • spacing Extension method

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

    Declaration

    Swift

    @inlinable
var spacing: Int { get nonmutating set }
    Show on GitHub
  • tabs Extension method

    Gets the current PangoTabArray used by this layout.

    If no PangoTabArray has been set, then the default tabs are in use and nil is returned. Default tabs are every 8 spaces.

    The return value should be freed with [methodPango.TabArray.free].

    Declaration

    Swift

    @inlinable
var tabs: Pango.TabArrayRef! { get nonmutating set }
    Show on GitHub
  • text Extension method

    Gets the text in the layout.

    The returned text should not be freed or modified.

    Declaration

    Swift

    @inlinable
var text: String! { get }
    Show on GitHub
  • unknownGlyphsCount Extension method

    Counts the number of unknown glyphs in layout.

    This function can be used to determine if there are any fonts available to render all characters in a certain string, or when used in combination with PANGO_ATTR_FALLBACK, to check if a certain font supports all the characters in the string.

    Declaration

    Swift

    @inlinable
var unknownGlyphsCount: Int { get }
    Show on GitHub
  • width Extension method

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

    Declaration

    Swift

    @inlinable
var width: Int { get nonmutating set }
    Show on GitHub
  • wrap Extension method

    Gets the wrap mode for the layout.

    Use [methodPango.Layout.is_wrapped] to query whether any paragraphs were actually wrapped.

    Declaration

    Swift

    @inlinable
var wrap: PangoWrapMode { get nonmutating set }
    Show on GitHub