Enum egui::WidgetText[−][src]

pub enum WidgetText {
    RichText(RichText),
    LayoutJob(LayoutJob),
    Galley(Arc<Galley>),
}

Expand description

This is how you specify text for a widget.

A lot of widgets use impl Into<WidgetText> as an argument, allowing you to pass in String, RichText, LayoutJob, and more.

Often a WidgetText is just a simple String, but it can be a RichText (text with color, style, etc), a LayoutJob (for when you want full control of how the text looks) or text that has already been layed out in a Galley.

Variants

`RichText(RichText)`

Tuple Fields

0: RichText

`LayoutJob(LayoutJob)`

Tuple Fields

0: LayoutJob

Use this LayoutJob when laying out the text.

Only LayoutJob::text and LayoutJob::sections are guaranteed to be respected.

LayoutJob::wrap_width, LayoutJob::halign, LayoutJob::justify and LayoutJob::first_row_min_height will likely be determined by the crate::Layout of the Ui the widget is placed in. If you want all parts of the LayoutJob respected, then convert it to a Galley and use Self::Galley instead.

`Galley(Arc<Galley>)`

Tuple Fields

0: Arc<Galley>

Use exactly this galley when painting the text.

Implementations

[src]

pub fn text_style(self, text_style: TextStyle) -> Self

Override the TextStyle if, and only if, this is a RichText.

Prefer using RichText directly!

[src]

pub fn fallback_text_style(self, text_style: TextStyle) -> Self

Set the TextStyle unless it has already been set

Prefer using RichText directly!

[src]

pub fn color(self, color: impl Into<Color32>) -> Self

Override text color if, and only if, this is a RichText.

Prefer using RichText directly!

[src]

pub fn heading(self) -> Self

Prefer using RichText directly!

[src]

pub fn monospace(self) -> Self

Prefer using RichText directly!

[src]

pub fn code(self) -> Self

Prefer using RichText directly!

[src]

pub fn strong(self) -> Self

Prefer using RichText directly!

[src]

pub fn weak(self) -> Self

Prefer using RichText directly!

[src]

pub fn underline(self) -> Self

Prefer using RichText directly!

[src]

pub fn strikethrough(self) -> Self

Prefer using RichText directly!

[src]

pub fn italics(self) -> Self

Prefer using RichText directly!

[src]

pub fn small(self) -> Self

Prefer using RichText directly!

[src]

pub fn small_raised(self) -> Self

Prefer using RichText directly!

[src]

pub fn raised(self) -> Self

Prefer using RichText directly!

[src]

pub fn background_color(self, background_color: impl Into<Color32>) -> Self

Prefer using RichText directly!

[src]

pub fn into_text_job(
    self,
    style: &Style,
    default_text_style: TextStyle,
    default_valign: Align
) -> WidgetTextJob

[src]

pub fn into_galley(
 self,
 ui: &Ui,
 wrap: Option<bool>,
 available_width: f32,
 default_text_style: TextStyle
) -> WidgetTextGalley

Layout with wrap mode based on the containing Ui.

wrap: override for Ui::wrap_text.

Trait Implementations

[src]

impl Default for WidgetText

[src]

fn default() -> Self

Returns the “default value” for a type. Read more

[src]

impl From<&'_ String> for WidgetText

[src]

fn from(text: &String) -> Self

Performs the conversion.

[src]

impl From<&'_ str> for WidgetText

[src]

fn from(text: &str) -> Self

Performs the conversion.

[src]

impl From<Arc<Galley>> for WidgetText

[src]

fn from(galley: Arc<Galley>) -> Self

Performs the conversion.

[src]

impl From<LayoutJob> for WidgetText

[src]

fn from(layout_job: LayoutJob) -> Self

Performs the conversion.

[src]

impl From<RichText> for WidgetText

[src]

fn from(rich_text: RichText) -> Self

Performs the conversion.

[src]

impl From<String> for WidgetText

[src]

fn from(text: String) -> Self

Performs the conversion.

Auto Trait Implementations

impl RefUnwindSafe for WidgetText

impl Send for WidgetText

impl Sync for WidgetText

impl Unpin for WidgetText

impl UnwindSafe for WidgetText

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum egui::WidgetText[−][src]

Variants

RichText(RichText)

Tuple Fields

LayoutJob(LayoutJob)

Tuple Fields

Galley(Arc<Galley>)

Tuple Fields

Implementations

impl WidgetText

pub fn is_empty(&self) -> bool

pub fn text(&self) -> &str

pub fn text_style(self, text_style: TextStyle) -> Self

pub fn fallback_text_style(self, text_style: TextStyle) -> Self

pub fn color(self, color: impl Into<Color32>) -> Self

pub fn heading(self) -> Self

pub fn monospace(self) -> Self

pub fn code(self) -> Self

pub fn strong(self) -> Self

pub fn weak(self) -> Self

pub fn underline(self) -> Self

pub fn strikethrough(self) -> Self

pub fn italics(self) -> Self

pub fn small(self) -> Self

pub fn small_raised(self) -> Self

pub fn raised(self) -> Self

pub fn background_color(self, background_color: impl Into<Color32>) -> Self

pub fn into_text_job( self, style: &Style, default_text_style: TextStyle, default_valign: Align) -> WidgetTextJob

pub fn into_galley( self, ui: &Ui, wrap: Option<bool>, available_width: f32, default_text_style: TextStyle) -> WidgetTextGalley

Trait Implementations

impl Default for WidgetText

fn default() -> Self

impl From<&'_ String> for WidgetText

fn from(text: &String) -> Self

impl From<&'_ str> for WidgetText

fn from(text: &str) -> Self

impl From<Arc<Galley>> for WidgetText

fn from(galley: Arc<Galley>) -> Self

impl From<LayoutJob> for WidgetText

fn from(layout_job: LayoutJob) -> Self

impl From<RichText> for WidgetText

fn from(rich_text: RichText) -> Self

impl From<String> for WidgetText

fn from(text: String) -> Self

Auto Trait Implementations

impl RefUnwindSafe for WidgetText

impl Send for WidgetText

impl Sync for WidgetText

impl Unpin for WidgetText

impl UnwindSafe for WidgetText

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

`RichText(RichText)`

`LayoutJob(LayoutJob)`

`Galley(Arc<Galley>)`

pub fn into_text_job(
self,
style: &Style,
default_text_style: TextStyle,
default_valign: Align
) -> WidgetTextJob

pub fn into_galley(
self,
ui: &Ui,
wrap: Option<bool>,
available_width: f32,
default_text_style: TextStyle
) -> WidgetTextGalley

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,