PgLayoutLine

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. The objects and functions in this section provide a high-level driver for formatting entire paragraphs of text at once.

class PgLayoutLine {

protected

PangoLayoutLine* pangoLayoutLine;

PangoLayoutLine* getPgLayoutLineStruct();

void* getStruct();

this(PangoLayoutLine* pangoLayoutLine);

PgLayoutLine doref();

void unref();

void getExtents(PangoRectangle* inkRect, PangoRectangle* logicalRect);

void getPixelExtents(PangoRectangle* inkRect, PangoRectangle* logicalRect);

void indexToX(int index, int trailing, int xPos);

int xToIndex(int xPos, int index, int trailing);

void getXRanges(int startIndex, int endIndex, int[] ranges);

}

Constructors

this this(PangoLayoutLine* pangoLayoutLine): Sets our main struct and passes it to the parent class

Members

Functions

doref PgLayoutLine doref(): Increase the reference count of a PangoLayoutLine by one. Since 1.10
getExtents void getExtents(PangoRectangle* inkRect, PangoRectangle* logicalRect): Computes the logical and ink extents of a layout line. See pango_font_get_glyph_extents() for details about the interpretation of the rectangles.
getPgLayoutLineStruct PangoLayoutLine* getPgLayoutLineStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getPixelExtents void getPixelExtents(PangoRectangle* inkRect, PangoRectangle* logicalRect): Computes the logical and ink extents of layout_line in device units. This function just calls pango_layout_line_get_extents() followed by two pango_extents_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 pango_extents_to_pixels()).
getStruct void* getStruct(): the main Gtk struct as a void*
getXRanges void getXRanges(int startIndex, int endIndex, int[] ranges): Gets a list of visual ranges corresponding to a given logical range. This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line.
indexToX void indexToX(int index, int trailing, int xPos): Converts an index within a line to a X position.
unref void unref(): Decrease the reference count of a PangoLayoutLine by one. If the result is zero, the line and all associated memory will be freed.
xToIndex int xToIndex(int xPos, int index, int trailing): Converts from x offset to the byte index of the corresponding character within the text of the layout. If x_pos is outside the line, index_ and trailing will point to the very first or very last position in the line. This determination is based on the resolved direction of the paragraph; for example, if the resolved direction is right-to-left, then an X position to the right of the line (after it) results in 0 being stored in index_ and trailing. An X position to the left of the line results in index_ pointing to the (logical) last grapheme in the line and trailing being set to the number of characters in that grapheme. The reverse is true for a left-to-right line.

Variables

pangoLayoutLine PangoLayoutLine* pangoLayoutLine;: the main Gtk struct

PgLayoutLine

Constructors

Members

Functions

Variables

Meta

Source