Struct directwrite::text_format::TextFormat

#[repr(transparent)]
pub struct TextFormat { /* fields omitted */ }

Represents a format for laying out text. You can think of this like a Font with all of the little customization boxes filled in.

Methods

impl TextFormat

pub fn create<'a>(factory: &'a Factory) -> TextFormatBuilder<'a>

Get a builder for creating a new text format.

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 PartialEq<TextFormat> for TextFormat

fn eq(&self, other: &TextFormat) -> bool

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

fn ne(&self, other: &TextFormat) -> bool

This method tests for !=.

impl Sync for TextFormat

impl Send for TextFormat

impl Debug for TextFormat

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

Formats the value using the given formatter.

impl ComWrapper for TextFormat

type Interface = IDWriteTextFormat

The raw interface type from winapi

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

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

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

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

unsafe fn into_raw(self) -> *mut IDWriteTextFormat

Consumes the wrapper without affecting the reference count

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

Creates a wrapper taking ownership of a ComPtr.

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

Unwraps the wrapper into a ComPtr.