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):
![Pango Layout Parameters](layout-light.png)
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.
GLib type: GObject with reference counted clone semantics.
Implementations§
source§impl Layout
impl Layout
sourcepub fn context_changed(&self)
pub fn context_changed(&self)
Forces recomputation of any state in the Layout
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.
pub fn copy(&self) -> Layout
sourcepub fn alignment(&self) -> Alignment
pub fn alignment(&self) -> Alignment
Gets the alignment for the layout: how partial lines are positioned within the horizontal space available.
§Returns
the alignment
sourcepub fn attributes(&self) -> Option<AttrList>
pub fn attributes(&self) -> Option<AttrList>
sourcepub fn is_auto_dir(&self) -> bool
pub fn is_auto_dir(&self) -> bool
Gets whether to calculate the base direction for the layout according to its contents.
See set_auto_dir()
.
§Returns
true
if the bidirectional base direction
is computed from the layout’s contents, false
otherwise
sourcepub fn baseline(&self) -> i32
pub fn baseline(&self) -> i32
Gets the Y position of baseline of the first line in @self.
§Returns
baseline of first line, from top of @self
sourcepub fn caret_pos(&self, index_: i32) -> (Rectangle, Rectangle)
Available on crate feature v1_50
only.
pub fn caret_pos(&self, index_: i32) -> (Rectangle, Rectangle)
v1_50
only.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 cursor_pos()
that applies
font metric information about caret slope and offset to the positions
it returns.
![Caret metrics](caret-metrics-light.png)
§Returns
§strong_pos
location to store the strong cursor position
§weak_pos
location to store the weak cursor position
sourcepub fn character_count(&self) -> i32
pub fn character_count(&self) -> i32
Returns the number of Unicode characters in the the text of @self.
§Returns
the number of Unicode characters in the text of @self
sourcepub fn cursor_pos(&self, index_: i32) -> (Rectangle, Rectangle)
pub fn cursor_pos(&self, index_: i32) -> (Rectangle, 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.
The position of each cursor is stored as a zero-width rectangle with the height of the run extents.
![Cursor positions](cursor-positions-light.png)
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.
![Strong and weak cursors](split-cursor-light.png)
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.
§index_
the byte index of the cursor
§Returns
§strong_pos
location to store the strong cursor position
§weak_pos
location to store the weak cursor position
sourcepub fn ellipsize(&self) -> EllipsizeMode
pub fn ellipsize(&self) -> EllipsizeMode
Gets the type of ellipsization being performed for @self.
See set_ellipsize()
.
Use is_ellipsized()
to query whether any
paragraphs were actually ellipsized.
§Returns
the current ellipsization mode for @self
sourcepub fn extents(&self) -> (Rectangle, Rectangle)
pub fn extents(&self) -> (Rectangle, Rectangle)
Computes the logical and ink extents of @self.
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.
§Returns
§ink_rect
rectangle used to store the extents of the layout as drawn
§logical_rect
rectangle used to store the logical extents of the layout
sourcepub fn font_description(&self) -> Option<FontDescription>
pub fn font_description(&self) -> Option<FontDescription>
sourcepub fn height(&self) -> i32
pub fn height(&self) -> i32
Gets the height of layout used for ellipsization.
See set_height()
for details.
§Returns
the height, in Pango units if positive, or number of lines if negative.
sourcepub fn indent(&self) -> i32
pub fn indent(&self) -> i32
Gets the paragraph indent width in Pango units.
A negative value indicates a hanging indentation.
§Returns
the indent in Pango units
sourcepub fn iter(&self) -> LayoutIter
pub fn iter(&self) -> LayoutIter
sourcepub fn is_justify(&self) -> bool
pub fn is_justify(&self) -> bool
Gets whether each complete line should be stretched to fill the entire width of the layout.
§Returns
the justify value
sourcepub fn is_justify_last_line(&self) -> bool
Available on crate feature v1_50
only.
pub fn is_justify_last_line(&self) -> bool
v1_50
only.Gets whether the last line should be stretched to fill the entire width of the layout.
§Returns
the justify value
sourcepub fn line(&self, line: i32) -> Option<LayoutLine>
pub fn line(&self, line: i32) -> Option<LayoutLine>
Retrieves a particular line from a Layout
.
Use the faster line_readonly()
if you do not
plan to modify the contents of the line (glyphs, glyph widths, etc.).
§line
the index of a line, which must be between 0 and
pango_layout_get_line_count(layout) - 1
, inclusive.
§Returns
the requested LayoutLine
,
or None
if the index is out of range. This layout line can be ref’ed
and retained, but will become invalid if changes are made to the
Layout
.
sourcepub fn line_count(&self) -> i32
pub fn line_count(&self) -> i32
sourcepub fn line_readonly(&self, line: i32) -> Option<LayoutLine>
pub fn line_readonly(&self, line: i32) -> Option<LayoutLine>
Retrieves a particular line from a Layout
.
This is a faster alternative to line()
,
but the user is not expected to modify the contents of the line
(glyphs, glyph widths, etc.).
§line
the index of a line, which must be between 0 and
pango_layout_get_line_count(layout) - 1
, inclusive.
§Returns
the requested LayoutLine
,
or None
if the index is out of range. This layout line can be ref’ed
and retained, but will become invalid if changes are made to the
Layout
. No changes should be made to the line.
sourcepub fn line_spacing(&self) -> f32
Available on crate feature v1_44
only.
pub fn line_spacing(&self) -> f32
v1_44
only.Gets the line spacing factor of @self.
See set_line_spacing()
.
sourcepub fn lines(&self) -> Vec<LayoutLine>
pub fn lines(&self) -> Vec<LayoutLine>
Returns the lines of the @self as a list.
Use the faster lines_readonly()
if you do not
plan to modify the contents of the lines (glyphs, glyph widths, etc.).
§Returns
a GSList
containing the lines in the layout. This points to internal data of the
Layout
and must be used with care. It will become invalid on any
change to the layout’s text or properties.
sourcepub fn lines_readonly(&self) -> Vec<LayoutLine>
pub fn lines_readonly(&self) -> Vec<LayoutLine>
Returns the lines of the @self as a list.
This is a faster alternative to lines()
,
but the user is not expected to modify the contents of the lines
(glyphs, glyph widths, etc.).
§Returns
a GSList
containing the lines in the layout. This points to internal data of the
Layout
and must be used with care. It will become invalid on any
change to the layout’s text or properties. No changes should be made to
the lines.
sourcepub fn pixel_extents(&self) -> (Rectangle, Rectangle)
pub fn pixel_extents(&self) -> (Rectangle, Rectangle)
Computes the logical and ink extents of @self in device units.
This function just calls extents()
followed by
two 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 extents_to_pixels()
).
§Returns
§ink_rect
rectangle used to store the extents of the layout as drawn
§logical_rect
rectangle used to store the logical extents of the layout
sourcepub fn pixel_size(&self) -> (i32, i32)
pub fn pixel_size(&self) -> (i32, i32)
sourcepub fn serial(&self) -> u32
pub fn serial(&self) -> u32
Returns the current serial number of @self.
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 Context
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 Layout
,
and is useful for example to decide whether a layout needs redrawing.
To force the serial to be increased, use
context_changed()
.
§Returns
The current serial number of @self.
sourcepub fn is_single_paragraph_mode(&self) -> bool
pub fn is_single_paragraph_mode(&self) -> bool
Obtains whether @self is in single paragraph mode.
See set_single_paragraph_mode()
.
§Returns
true
if the layout does not break paragraphs
at paragraph separator characters, false
otherwise
sourcepub fn text(&self) -> GString
pub fn text(&self) -> GString
Gets the text in the layout.
The returned text should not be freed or modified.
§Returns
the text in the @self
sourcepub fn unknown_glyphs_count(&self) -> i32
pub fn unknown_glyphs_count(&self) -> i32
Counts the number of unknown glyphs in @self.
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 AttrType::Fallback
, to check if a
certain font supports all the characters in the string.
§Returns
The number of unknown glyphs in @self
sourcepub fn wrap(&self) -> WrapMode
pub fn wrap(&self) -> WrapMode
Gets the wrap mode for the layout.
Use is_wrapped()
to query whether
any paragraphs were actually wrapped.
§Returns
active wrap mode.
sourcepub fn index_to_line_x(&self, index_: i32, trailing: bool) -> (i32, i32)
pub fn index_to_line_x(&self, index_: i32, trailing: bool) -> (i32, i32)
Converts from byte @index_ within the @self to line and X position.
The X position is measured from the left edge of the line.
§index_
the byte index of a grapheme within the layout
§trailing
an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme
§Returns
§line
location to store resulting line index. (which will between 0 and pango_layout_get_line_count(layout) - 1)
§x_pos
location to store resulting position within line
(PANGO_SCALE
units per device unit)
sourcepub fn index_to_pos(&self, index_: i32) -> Rectangle
pub fn index_to_pos(&self, index_: i32) -> Rectangle
Converts from an index within a Layout
to the onscreen position
corresponding to the grapheme at that index.
The returns is represented as rectangle. Note that pos->x
is
always the leading edge of the grapheme and pos->x + pos->width
the
trailing edge of the grapheme. If the directionality of the grapheme
is right-to-left, then pos->width
will be negative.
§index_
byte index within @self
§Returns
§pos
rectangle in which to store the position of the grapheme
sourcepub fn is_ellipsized(&self) -> bool
pub fn is_ellipsized(&self) -> bool
Queries whether the layout had to ellipsize any paragraphs.
This returns true
if the ellipsization mode for @self
is not EllipsizeMode::None
, a positive width is set on @self,
and there are paragraphs exceeding that width that have to be
ellipsized.
§Returns
true
if any paragraphs had to be ellipsized,
false
otherwise
sourcepub fn is_wrapped(&self) -> bool
pub fn is_wrapped(&self) -> bool
Queries whether the layout had to wrap any paragraphs.
This returns true
if a positive width is set on @self,
ellipsization mode of @self is set to EllipsizeMode::None
,
and there are paragraphs exceeding the layout width that have
to be wrapped.
§Returns
sourcepub fn move_cursor_visually(
&self,
strong: bool,
old_index: i32,
old_trailing: i32,
direction: i32,
) -> (i32, i32)
pub fn move_cursor_visually( &self, strong: bool, old_index: i32, old_trailing: i32, direction: i32, ) -> (i32, i32)
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.
§strong
whether the moving cursor is the strong cursor or the weak cursor. The strong cursor is the cursor corresponding to text insertion in the base direction for the layout.
§old_index
the byte index of the current cursor position
§old_trailing
if 0, the cursor was at the leading edge of the grapheme indicated by @old_index, if > 0, the cursor was at the trailing edge.
§direction
direction to move cursor. A negative value indicates motion to the left
§Returns
§new_index
location to store the new cursor byte index.
A value of -1 indicates that the cursor has been moved off the
beginning of the layout. A value of G_MAXINT
indicates that
the cursor has been moved off the end of the layout.
§new_trailing
number of characters to move forward from the location returned for @new_index to get the position where the cursor should be displayed. This allows distinguishing the position at the beginning of one line from the position at the end of the preceding line. @new_index is always on the line where the cursor should be displayed.
sourcepub fn serialize(&self, flags: LayoutSerializeFlags) -> Bytes
Available on crate feature v1_50
only.
pub fn serialize(&self, flags: LayoutSerializeFlags) -> Bytes
v1_50
only.Serializes the @self for later deserialization via Pango::Layout::deserialize()
.
There are no guarantees about the format of the output across different
versions of Pango and Pango::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.
§flags
§Returns
a GBytes
containing the serialized form of @self
sourcepub fn set_alignment(&self, alignment: Alignment)
pub fn set_alignment(&self, alignment: Alignment)
Sets the alignment for the layout: how partial lines are positioned within the horizontal space available.
The default alignment is Alignment::Left
.
§alignment
the alignment
sourcepub fn set_attributes(&self, attrs: Option<&AttrList>)
pub fn set_attributes(&self, attrs: Option<&AttrList>)
sourcepub fn set_auto_dir(&self, auto_dir: bool)
pub fn set_auto_dir(&self, auto_dir: bool)
Sets whether to calculate the base direction for the layout according to its contents.
When this flag is on (the default), then paragraphs in @self 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
Context
. (See Context::set_base_dir()
).
When the auto-computed direction of a paragraph differs from the
base direction of the context, the interpretation of
Alignment::Left
and Alignment::Right
are swapped.
§auto_dir
if true
, compute the bidirectional base direction
from the layout’s contents
sourcepub fn set_ellipsize(&self, ellipsize: EllipsizeMode)
pub fn set_ellipsize(&self, ellipsize: EllipsizeMode)
Sets the type of ellipsization being performed for @self.
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
set_width()
and 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 EllipsizeMode::None
.
See set_height()
for details.
§ellipsize
the new ellipsization mode for @self
sourcepub fn set_font_description(&self, desc: Option<&FontDescription>)
pub fn set_font_description(&self, desc: Option<&FontDescription>)
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.
§desc
the new FontDescription
to unset the current font description
sourcepub fn set_height(&self, height: i32)
pub fn set_height(&self, height: i32)
Sets the height to which the Layout
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
@self and ellipsization mode of @self is not EllipsizeMode::None
.
The behavior is undefined if a height other than -1 is set and
ellipsization mode is set to EllipsizeMode::None
, and may change in the
future.
§height
the desired height of the layout in Pango units if positive, or desired number of lines if negative.
sourcepub fn set_indent(&self, indent: i32)
pub fn set_indent(&self, indent: i32)
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
Alignment::Center
.
The default value is 0.
§indent
the amount by which to indent
sourcepub fn set_justify(&self, justify: bool)
pub fn set_justify(&self, justify: bool)
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 set_justify_last_line()
.
§justify
whether the lines in the layout should be justified
sourcepub fn set_justify_last_line(&self, justify: bool)
Available on crate feature v1_50
only.
pub fn set_justify_last_line(&self, justify: bool)
v1_50
only.Sets whether the last line should be stretched to fill the entire width of the layout.
This only has an effect if set_justify()
has
been called as well.
The default value is false
.
§justify
whether the last line in the layout should be justified
sourcepub fn set_line_spacing(&self, factor: f32)
Available on crate feature v1_44
only.
pub fn set_line_spacing(&self, factor: f32)
v1_44
only.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 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 attr_line_height_new()
.
§factor
the new line spacing factor
sourcepub fn set_markup(&self, markup: &str)
pub fn set_markup(&self, markup: &str)
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 set_markup_with_accel()
,
but the markup text isn’t scanned for accelerators.
§markup
marked-up text
§length
length of marked-up text in bytes, or -1 if @markup is
NUL
-terminated
sourcepub fn set_markup_with_accel(&self, markup: &str, accel_marker: char) -> char
pub fn set_markup_with_accel(&self, markup: &str, accel_marker: char) -> char
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 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.
§markup
marked-up text (see Pango Markup)
§length
length of marked-up text in bytes, or -1 if @markup is
NUL
-terminated
§accel_marker
marker for accelerators in the text
§Returns
§accel_char
return location for first located accelerator
sourcepub fn set_single_paragraph_mode(&self, setting: bool)
pub fn set_single_paragraph_mode(&self, setting: bool)
Sets the single paragraph mode of @self.
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
.
§setting
new setting
sourcepub fn set_spacing(&self, spacing: i32)
pub fn set_spacing(&self, spacing: i32)
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 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 attr_line_height_new()
.
§spacing
the amount of spacing
sourcepub fn set_tabs(&self, tabs: Option<&TabArray>)
pub fn set_tabs(&self, tabs: Option<&TabArray>)
Sets the tabs to use for @self, overriding the default tabs.
Layout
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 None
, 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
Alignment::Left
.
§tabs
a TabArray
sourcepub fn set_text(&self, text: &str)
pub fn set_text(&self, text: &str)
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 set_markup()
or
set_markup_with_accel()
on @self before, you
may want to call set_attributes()
to clear the
attributes set on the layout from the markup as this function does
not clear attributes.
§text
the text
§length
maximum length of @text, in bytes. -1 indicates that the string is nul-terminated and the length should be calculated. The text will also be truncated on encountering a nul-termination even when @length is positive.
sourcepub fn set_wrap(&self, wrap: WrapMode)
pub fn set_wrap(&self, wrap: WrapMode)
Sets the wrap mode.
The wrap mode only has effect if a width is set on the layout
with set_width()
. To turn off wrapping,
set the width to -1.
The default value is WrapMode::Word
.
§wrap
the wrap mode
sourcepub fn write_to_file(
&self,
flags: LayoutSerializeFlags,
filename: impl AsRef<Path>,
) -> Result<(), Error>
Available on crate feature v1_50
only.
pub fn write_to_file( &self, flags: LayoutSerializeFlags, filename: impl AsRef<Path>, ) -> Result<(), Error>
v1_50
only.A convenience method to serialize a layout to a file.
It is equivalent to calling serialize()
followed by 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.
§flags
§filename
the file to save it to
§Returns
true
if saving was successful
sourcepub fn xy_to_index(&self, x: i32, y: i32) -> (bool, i32, i32)
pub fn xy_to_index(&self, x: i32, y: i32) -> (bool, i32, i32)
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 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
.
§x
the X offset (in Pango units) from the left edge of the layout
§y
the Y offset (in Pango units) from the top edge of the layout
§Returns
true
if the coordinates were inside text, false
otherwise
§index_
location to store calculated byte index
§trailing
location to store a integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme.
Trait Implementations§
source§impl HasParamSpec for Layout
impl HasParamSpec for Layout
source§impl Ord for Layout
impl Ord for Layout
source§fn cmp(&self, other: &Self) -> Ordering
fn cmp(&self, other: &Self) -> Ordering
Comparison for two GObjects.
Compares the memory addresses of the provided objects.
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<OT: ObjectType> PartialEq<OT> for Layout
impl<OT: ObjectType> PartialEq<OT> for Layout
source§impl<OT: ObjectType> PartialOrd<OT> for Layout
impl<OT: ObjectType> PartialOrd<OT> for Layout
source§impl StaticType for Layout
impl StaticType for Layout
source§fn static_type() -> Type
fn static_type() -> Type
Self
.impl Eq for Layout
Auto Trait Implementations§
impl Freeze for Layout
impl RefUnwindSafe for Layout
impl !Send for Layout
impl !Sync for Layout
impl Unpin for Layout
impl UnwindSafe for Layout
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Cast for Twhere
T: ObjectType,
impl<T> Cast for Twhere
T: ObjectType,
source§fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast<T>(self) -> Twhere
T: ObjectType,
Self: IsA<T>,
T
. Read moresource§fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
fn upcast_ref<T>(&self) -> &Twhere
T: ObjectType,
Self: IsA<T>,
T
. Read moresource§fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: MayDowncastTo<T>,
fn downcast<T>(self) -> Result<T, Self>where
T: ObjectType,
Self: MayDowncastTo<T>,
T
. Read moresource§fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<T>,
fn downcast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
Self: MayDowncastTo<T>,
T
. Read moresource§fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
fn dynamic_cast<T>(self) -> Result<T, Self>where
T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while upcast
will do many checks at compile-time already. downcast
will
perform the same checks at runtime as dynamic_cast
, but will also ensure some amount of
compile-time safety. Read moresource§fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
fn dynamic_cast_ref<T>(&self) -> Option<&T>where
T: ObjectType,
T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read moresource§unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
unsafe fn unsafe_cast<T>(self) -> Twhere
T: ObjectType,
T
unconditionally. Read moresource§unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
unsafe fn unsafe_cast_ref<T>(&self) -> &Twhere
T: ObjectType,
&T
unconditionally. Read moresource§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for Twhere
T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,
source§impl<T> IntoClosureReturnValue for T
impl<T> IntoClosureReturnValue for T
fn into_closure_return_value(self) -> Option<Value>
source§impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
impl<U> IsSubclassableExt for Uwhere
U: IsClass + ParentClassIs,
fn parent_class_init<T>(class: &mut Class<U>)
fn parent_instance_init<T>(instance: &mut InitializingObject<T>)
source§impl<T> ObjectExt for Twhere
T: ObjectType,
impl<T> ObjectExt for Twhere
T: ObjectType,
source§fn is<U>(&self) -> boolwhere
U: StaticType,
fn is<U>(&self) -> boolwhere
U: StaticType,
true
if the object is an instance of (can be cast to) T
.source§fn object_class(&self) -> &Class<Object>
fn object_class(&self) -> &Class<Object>
ObjectClass
of the object. Read moresource§fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
fn class_of<U>(&self) -> Option<&Class<U>>where
U: IsClass,
T
. Read moresource§fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>where
U: IsInterface,
T
of the object. Read moresource§fn set_property_from_value(&self, property_name: &str, value: &Value)
fn set_property_from_value(&self, property_name: &str, value: &Value)
source§fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])
source§fn set_properties_from_value(&self, property_values: &[(&str, Value)])
fn set_properties_from_value(&self, property_values: &[(&str, Value)])
source§fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
fn property<V>(&self, property_name: &str) -> Vwhere
V: for<'b> FromValue<'b> + 'static,
property_name
of the object and cast it to the type V. Read moresource§fn property_value(&self, property_name: &str) -> Value
fn property_value(&self, property_name: &str) -> Value
property_name
of the object. Read moresource§fn property_type(&self, property_name: &str) -> Option<Type>
fn property_type(&self, property_name: &str) -> Option<Type>
property_name
of this object. Read moresource§fn find_property(&self, property_name: &str) -> Option<ParamSpec>
fn find_property(&self, property_name: &str) -> Option<ParamSpec>
ParamSpec
of the property property_name
of this object.source§fn list_properties(&self) -> PtrSlice<ParamSpec>
fn list_properties(&self) -> PtrSlice<ParamSpec>
ParamSpec
of the properties of this object.source§fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
fn freeze_notify(&self) -> PropertyNotificationFreezeGuard
source§unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)where
QD: 'static,
key
. Read moresource§unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>where
QD: 'static,
key
. Read moresource§unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>where
QD: 'static,
key
. Read moresource§unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
unsafe fn set_data<QD>(&self, key: &str, value: QD)where
QD: 'static,
key
. Read moresource§unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>where
QD: 'static,
key
. Read moresource§unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>where
QD: 'static,
key
. Read moresource§fn block_signal(&self, handler_id: &SignalHandlerId)
fn block_signal(&self, handler_id: &SignalHandlerId)
source§fn unblock_signal(&self, handler_id: &SignalHandlerId)
fn unblock_signal(&self, handler_id: &SignalHandlerId)
source§fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)
source§fn stop_signal_emission_by_name(&self, signal_name: &str)
fn stop_signal_emission_by_name(&self, signal_name: &str)
source§fn connect<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
signal_name
on this object. Read moresource§fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
signal_id
on this object. Read moresource§fn connect_local<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
signal_name
on this object. Read moresource§fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
signal_id
on this object. Read moresource§unsafe fn connect_unsafe<F>(
&self,
signal_name: &str,
after: bool,
callback: F,
) -> SignalHandlerId
unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
signal_name
on this object. Read moresource§unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F,
) -> SignalHandlerId
unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
signal_id
on this object. Read moresource§fn connect_closure(
&self,
signal_name: &str,
after: bool,
closure: RustClosure,
) -> SignalHandlerId
fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure, ) -> SignalHandlerId
signal_name
on this object. Read moresource§fn connect_closure_id(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
closure: RustClosure,
) -> SignalHandlerId
fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure, ) -> SignalHandlerId
signal_id
on this object. Read moresource§fn watch_closure(&self, closure: &impl AsRef<Closure>)
fn watch_closure(&self, closure: &impl AsRef<Closure>)
closure
to the lifetime of the object. When
the object’s reference count drops to zero, the closure will be
invalidated. An invalidated closure will ignore any calls to
invoke_with_values
, or
invoke
when using Rust closures.source§fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
source§fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>
Self::emit
but takes Value
for the arguments.source§fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> Rwhere
R: TryFromClosureReturnValue,
source§fn emit_by_name_with_values(
&self,
signal_name: &str,
args: &[Value],
) -> Option<Value>
fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value], ) -> Option<Value>
source§fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_by_name_with_details<R>(
&self,
signal_name: &str,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
source§fn emit_by_name_with_details_and_values(
&self,
signal_name: &str,
details: Quark,
args: &[Value],
) -> Option<Value>
fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value], ) -> Option<Value>
source§fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
fn emit_with_details<R>(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue],
) -> Rwhere
R: TryFromClosureReturnValue,
source§fn emit_with_details_and_values(
&self,
signal_id: SignalId,
details: Quark,
args: &[Value],
) -> Option<Value>
fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value], ) -> Option<Value>
source§fn disconnect(&self, handler_id: SignalHandlerId)
fn disconnect(&self, handler_id: SignalHandlerId)
source§fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
notify
signal of the object. Read moresource§fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
notify
signal of the object. Read moresource§unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F,
) -> SignalHandlerId
unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F, ) -> SignalHandlerId
notify
signal of the object. Read more