Struct pango::Layout

source ·

#[repr(transparent)]
pub struct Layout { /* private fields */ }

Expand description

A Layout 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. Layout 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 Layout is initialized with a Context, 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 Layout. 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 Layout as a list of lines.

Struct pango::Layout

Implementations§

impl Layout

pub fn new(context: &Context) -> Layout

pub fn context_changed(&self)

pub fn copy(&self) -> Option<Layout>

pub fn alignment(&self) -> Alignment

pub fn attributes(&self) -> Option<AttrList>

pub fn is_auto_dir(&self) -> bool

pub fn baseline(&self) -> i32

pub fn caret_pos(&self, index_: i32) -> (Rectangle, Rectangle)

pub fn character_count(&self) -> i32

pub fn context(&self) -> Option<Context>

pub fn cursor_pos(&self, index_: i32) -> (Rectangle, Rectangle)

pub fn direction(&self, index: i32) -> Direction

pub fn ellipsize(&self) -> EllipsizeMode

pub fn extents(&self) -> (Rectangle, Rectangle)

pub fn font_description(&self) -> Option<FontDescription>

pub fn height(&self) -> i32

pub fn indent(&self) -> i32

pub fn iter(&self) -> Option<LayoutIter>

pub fn is_justify(&self) -> bool

pub fn is_justify_last_line(&self) -> bool

pub fn line(&self, line: i32) -> Option<LayoutLine>

pub fn line_count(&self) -> i32

pub fn line_readonly(&self, line: i32) -> Option<LayoutLine>

pub fn line_spacing(&self) -> f32

pub fn lines(&self) -> Vec<LayoutLine>

pub fn lines_readonly(&self) -> Vec<LayoutLine>

pub fn pixel_extents(&self) -> (Rectangle, Rectangle)

pub fn pixel_size(&self) -> (i32, i32)

pub fn serial(&self) -> u32

pub fn is_single_paragraph_mode(&self) -> bool

pub fn size(&self) -> (i32, i32)

pub fn spacing(&self) -> i32

pub fn tabs(&self) -> Option<TabArray>

pub fn text(&self) -> Option<GString>

pub fn unknown_glyphs_count(&self) -> i32

pub fn width(&self) -> i32

pub fn wrap(&self) -> WrapMode

pub fn index_to_line_x(&self, index_: i32, trailing: bool) -> (i32, i32)

pub fn index_to_pos(&self, index_: i32) -> Rectangle

pub fn is_ellipsized(&self) -> bool

pub fn is_wrapped(&self) -> bool

pub fn move_cursor_visually( &self, strong: bool, old_index: i32, old_trailing: i32, direction: i32 ) -> (i32, i32)

pub fn serialize(&self, flags: LayoutSerializeFlags) -> Bytes

pub fn set_alignment(&self, alignment: Alignment)

pub fn set_attributes(&self, attrs: Option<&AttrList>)

pub fn set_auto_dir(&self, auto_dir: bool)

pub fn set_ellipsize(&self, ellipsize: EllipsizeMode)

pub fn set_font_description(&self, desc: Option<&FontDescription>)

pub fn set_height(&self, height: i32)

pub fn set_indent(&self, indent: i32)

pub fn set_justify(&self, justify: bool)

pub fn set_justify_last_line(&self, justify: bool)

pub fn set_line_spacing(&self, factor: f32)

pub fn set_markup(&self, markup: &str)

pub fn set_markup_with_accel(&self, markup: &str, accel_marker: char) -> char