Struct directwrite::text_layout::TextLayout

pub struct TextLayout { /* fields omitted */ }

The TextLayout interface represents a block of text after it has been fully analyzed and formatted.

Methods

impl TextLayout

pub unsafe fn from_ptr(ptr: ComPtr<IDWriteTextLayout>) -> Self

pub unsafe fn get_ptr(&self) -> ComPtr<IDWriteTextLayout>

pub unsafe fn get_raw(&self) -> *mut IDWriteTextLayout

pub fn as_format(&self) -> TextFormat

pub fn determine_min_width(&self) -> f32

Determines the minimum possible width the layout can be set to without emergency breaking between the characters of whole words occurring.

pub fn get_cluster_metrics_count(&self) -> usize

Gets the number of ClusterMetrics objects which exist for this TextLayout

pub fn get_cluster_metrics_slice(
    &self,
    buf: &mut [ClusterMetrics]
) -> Result<usize, usize>

Retrieves the ClusterMetrics for the glyph clusters in this layout. You should ensure the slice is large enough to hold all of the metrics, which can be obtained by calling get_cluster_metrics_count. If the slice is not large enough, it will return Err(actual_count), otherwise returns Ok(actual_count).

pub fn get_cluster_metrics(&self, buf: &mut Vec<ClusterMetrics>)

Fill all of the Cluster metrics into a Vec. This function will resize the Vec to fit all of the metrics structures exactly.

pub fn get_font_size(
    &self,
    position: u32
) -> Result<(f32, TextRange), DWriteError>

Gets the font em height of the text at the specified position. Also returns the text range which has identical formatting to the current character.

pub fn get_font_stretch(
    &self,
    position: u32
) -> Result<(FontStretch, TextRange), DWriteError>

Gets the font stretch of the text at the specified position. Also returns the text range which has identical formatting to the current character.

pub fn get_font_style(
    &self,
    position: u32
) -> Result<(FontStyle, TextRange), DWriteError>

Gets the font style of the text at the specified position. Also returns the text range which has identical formatting to the current character.

pub fn get_font_weight(
    &self,
    position: u32
) -> Result<(FontWeight, TextRange), DWriteError>

Gets the font weight of the text at the specified position. Also returns the text range which has identical formatting to the current character.

pub fn get_line_metrics_count(&self) -> usize

Get the number of LineMetrics objects that you need room for when calling get_line_metrics_slice

pub fn get_line_metrics_slice(
    &self,
    buf: &mut [LineMetrics]
) -> Result<usize, usize>

Retrieves the information about each individual text line of the text string. You should first call get_line_metrics_count to know how large your slice must be to fit all of the metrics objects. The return value will contain the actual number of elements in the layout, but the official documentation does not specify whether the array will be filled with any values in the Err case, so that behavior is not guaranteed between windows versions.

pub fn get_line_metrics(&self, buf: &mut Vec<LineMetrics>)

etrieves the information about each individual text line of the text string. Resizes buf to fit all of the elements exactly.

pub fn get_max_height(&self) -> f32

Gets the layout maximum height.

pub fn get_max_width(&self) -> f32

Gets the layout maximum width.

pub fn get_metrics(&self) -> Metrics

Retrieves overall metrics for the formatted string.

pub fn get_overhang_metrics(&self) -> OverhangMetrics

Returns the overhangs (in DIPs) of the layout and all objects contained in it, including text glyphs and inline objects.

pub fn hit_test_point(&self, point_x: f32, point_y: f32) -> HitTestPoint

The application calls this function passing in a specific pixel location relative to the top-left location of the layout box and obtains the information about the correspondent hit-test metrics of the text string where the hit-test has occurred. Returns None if the specified pixel location is outside the string.

pub fn hit_test_text_position(
    &self,
    position: u32,
    trailing: bool
) -> Option<HitTestTextPosition>

The application calls this function to get the pixel location relative to the top-left of the layout box given the text position and the logical side of the position. This function is normally used as part of caret positioning of text where the caret is drawn at the location corresponding to the current text editing position. It may also be used as a way to programmatically obtain the geometry of a particular text position in UI automation.

pub fn hit_test_text_range(
    &self,
    position: u32,
    length: u32,
    origin_x: f32,
    origin_y: f32,
    metrics: &mut Vec<HitTestMetrics>
) -> bool

The application calls this function to get a set of hit-test metrics corresponding to a range of text positions. One of the main usages is to implement highlight selection of the text string. origin_x and origin_y are added to the hit-test metrics returned.

pub fn set_drawing_effect<E>(&self, effect: &E, range: TextRange) where
    E: DrawingEffect, 

Sets the drawing style for text within a text range.

pub fn set_font_style(&self, style: FontStyle, range: TextRange)

Sets the font style for text within a text range.

pub fn set_font_weight(&self, weight: FontWeight, range: TextRange)

Sets the font weight for text within a text range.

pub fn set_underline(&self, underline: bool, range: TextRange)

Sets underlining for text within a specified text range.

Trait Implementations

impl FromParams for TextLayout

type Params = Params

fn from_params(
    factory: &mut IDWriteFactory,
    params: Params
) -> Result<Self, DWriteError>

impl Clone for TextLayout

fn clone(&self) -> TextLayout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl PartialEq for TextLayout

fn eq(&self, __arg_0: &TextLayout) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &TextLayout) -> bool

This method tests for !=.