Struct directwrite::text_layout::TextLayout

#[repr(transparent)]
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 fn create<'a>(factory: &'a Factory) -> TextLayoutBuilder<'a>

Initialize a builder for a new TextLayout.

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 draw(
    &self,
    renderer: &mut TextRenderer,
    origin_x: f32,
    origin_y: f32,
    context: &DrawContext
) -> DWResult<()>

Draws text using the specified client drawing context.

pub fn cluster_metrics_count(&self) -> usize

Gets the number of ClusterMetrics objects which exist for this TextLayout

pub fn 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 cluster_metrics(&self) -> Vec<ClusterMetrics>

Fill all of the Cluster metrics into a Vec.

pub fn drawing_effect(&self, position: u32) -> RangeResult<Option<ClientEffect>>

Get the drawing effect applied at the specified position

pub fn font_collection(&self, position: u32) -> RangeResult<FontCollection>

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

pub fn font_family_name(&self, position: u32) -> RangeResult<String>

Get the font family name applied at the specified text position.

pub fn font_size(&self, position: u32) -> RangeResult<f32>

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 font_stretch(
    &self,
    position: u32
) -> RangeResult<UncheckedEnum<FontStretch>>

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 font_style(&self, position: u32) -> RangeResult<UncheckedEnum<FontStyle>>

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 font_weight(&self, position: u32) -> RangeResult<FontWeight>

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 inline_object(&self, position: u32) -> RangeResult<Option<InlineObject>>

Gets the inline object at the position as-is. May return ptr::null_mut()

pub fn line_metrics_count(&self) -> usize

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

pub fn 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 line_metrics(&self) -> Vec<LineMetrics>

Retrieves the information about each individual text line of the text string.

pub fn locale_name(&self, position: u32) -> RangeResult<String>

Gets the locale name applied to the text at the specified text position.

pub fn max_height(&self) -> f32

Gets the layout maximum height.

pub fn max_width(&self) -> f32

Gets the layout maximum width.

pub fn metrics(&self) -> TextMetrics

Retrieves overall metrics for the formatted string.

pub fn 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 strikethrough(&self, position: u32) -> RangeResult<bool>

Returns whether the text at the specified position has strikethrough applied.

pub fn underline(&self, position: u32) -> RangeResult<bool>

Returns whether the text at the specified position has underline applied.

pub fn typography(&self, position: u32) -> RangeResult<Typography>

Gets the typography description applied to the text at the specified text position.

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>
) -> DWResult<()>

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(
    &mut self,
    effect: &impl DrawingEffect,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the drawing style for text within a text range.

pub fn set_font_collection(
    &mut self,
    collection: FontCollection,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font collection for text within a text range.

pub fn set_font_family_name(
    &mut self,
    name: &str,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font family used for the specified range of text.

pub fn set_font_size(
    &mut self,
    size: f32,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font size used for the specified range of text.

pub fn set_font_stretch(
    &mut self,
    stretch: FontStretch,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font stretch for text within a text range.

pub fn set_font_style(
    &mut self,
    style: FontStyle,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font style for text within a text range.

pub fn set_font_weight(
    &mut self,
    weight: FontWeight,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the font weight for text within a text range.

pub fn set_inline_object(
    &mut self,
    obj: &InlineObject,
    range: impl Into<TextRange>
) -> DWResult<()>

Set the inline object used for a range of text.

pub fn set_locale_name(
    &mut self,
    locale: &str,
    range: impl Into<TextRange>
) -> DWResult<()>

Set the locale used for a range of text.

pub fn set_max_height(&mut self, maxh: f32) -> DWResult<()>

Set the max height in DIPs for this text layout.

pub fn set_max_width(&mut self, maxw: f32) -> DWResult<()>

Set the max width in DIPs for this text layout.

pub fn set_strikethrough(
    &mut self,
    strikethrough: bool,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets strikethrough for text within a specified text range.

pub fn set_underline(
    &mut self,
    underline: bool,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets underlining for text within a specified text range.

pub fn set_typography(
    &mut self,
    typography: &Typography,
    range: impl Into<TextRange>
) -> DWResult<()>

Sets the typography object controlling the font face settings for a range of text.

Methods from Deref<Target = TextFormat>

pub fn flow_direction(&self) -> UncheckedEnum<FlowDirection>

Get the flow direction of text in this format.

pub fn font_collection(&self) -> Option<FontCollection>

Get the font collection this format loaded its font from.

pub fn font_family_name(&self) -> Option<String>

Get the name of the font family specified for this format.

pub fn font_size(&self) -> f32

Get the font size associated with this format.

pub fn font_stretch(&self) -> UncheckedEnum<FontStretch>

Get the stretch applied to this format.

pub fn font_style(&self) -> UncheckedEnum<FontStyle>

Get the style applied to this format.

pub fn font_weight(&self) -> FontWeight

Get the weight applied to this format.

pub fn incremental_tabstop(&self) -> f32

Get the incremental tabstop size for this format.

pub fn line_spacing(&self) -> DWResult<LineSpacing>

Get the line spacing information for this format.

pub fn locale_name(&self) -> DWResult<String>

Get the locale used for this format.

pub fn paragraph_alignment(&self) -> UncheckedEnum<ParagraphAlignment>

Get the paragraph alignment of text under this format.

pub fn reading_direction(&self) -> UncheckedEnum<ReadingDirection>

Get the reading direction of text under this format.

pub fn text_alignment(&self) -> UncheckedEnum<TextAlignment>

Get the alignment of text under this format.

pub fn trimming(&self) -> DWResult<(Trimming, Option<InlineObject>)>

Gets the trimming options for text that overflows the layout box.

The inline object is an omission sign that will be rendered to show that text was omitted.

pub fn word_wrapping(&self) -> UncheckedEnum<WordWrapping>

Get the word wrapping for text under this format.

pub fn set_flow_direction(&mut self, value: FlowDirection) -> DWResult<()>

Set the flow direction for text under this format.

pub fn set_incremental_tabstop(&mut self, value: f32) -> DWResult<()>

Set the incremental tabstop value for text under this format.

pub fn set_line_spacing(
    &mut self,
    method: LineSpacingMethod,
    spacing: f32,
    baseline: f32
) -> DWResult<()>

Set the line spacing metrics for text under this format.

pub fn set_paragraph_alignment(
    &mut self,
    value: ParagraphAlignment
) -> DWResult<()>

Set the paragraph alignment for text under this format.

pub fn set_reading_direction(&mut self, value: ReadingDirection) -> DWResult<()>

Set the reading direction used to lay out text under this format.

pub fn set_text_alignment(&mut self, value: TextAlignment) -> DWResult<()>

Set the text alignment for this format.

pub fn set_trimming(
    &self,
    trimming: &Trimming,
    omission_sign: Option<&InlineObject>
) -> DWResult<()>

Sets trimming options for text overflowing the layout width.

pub fn set_word_wrapping(&mut self, value: WordWrapping) -> DWResult<()>

Set the word wrapping for text under this format.

Trait Implementations

impl Sync for TextLayout

impl Send for TextLayout

impl DerefMut for TextLayout

fn deref_mut(&mut self) -> &mut TextFormat

Mutably dereferences the value.

impl Deref for TextLayout

type Target = TextFormat

The resulting type after dereferencing.

fn deref(&self) -> &TextFormat

Dereferences the value.

impl Debug for TextLayout

fn fmt(&self, fmt: &mut Formatter) -> Result

Formats the value using the given formatter.

impl ComWrapper for TextLayout

type Interface = IDWriteTextLayout

The raw interface type from winapi

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

Gets a raw pointer to the interface. Does not increment the reference count

unsafe fn from_raw(ptr: *mut IDWriteTextLayout) -> Self

Creates a wrapper from the raw pointer. Takes ownership of the pointer for reference counting purposes.

unsafe fn into_raw(self) -> *mut IDWriteTextLayout

Consumes the wrapper without affecting the reference count

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

Creates a wrapper taking ownership of a ComPtr.

unsafe fn into_ptr(self) -> ComPtr<IDWriteTextLayout>

Unwraps the wrapper into a ComPtr.