Struct penrose_ui::bar::widgets::Text

source ·
pub struct Text { /* private fields */ }
Expand description

A simple piece of static text with an optional background color.

Can be used as a simple static element in a status bar or as an inner element for rendering more complex text based widgets.

Implementations§

source§

impl Text

source

pub fn new( txt: impl Into<String>, style: TextStyle, is_greedy: bool, right_justified: bool, ) -> Self

Construct a new Text

source

pub fn get_text(&self) -> &String

Borrow the current contents of the widget.

source

pub fn get_text_mut(&mut self) -> &mut String

Mutably borrow the current contents of the widget.

source

pub fn set_text(&mut self, txt: impl Into<String>)

Set the rendered text and trigger a redraw

Trait Implementations§

source§

impl Clone for Text

source§

fn clone(&self) -> Text

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Text

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl PartialEq for Text

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<X: XConn> Widget<X> for Text

source§

fn draw( &mut self, ctx: &mut Context<'_>, _: usize, _: bool, w: u32, h: u32, ) -> Result<()>

Render the current state of the widget to the status bar window.
source§

fn current_extent( &mut self, ctx: &mut Context<'_>, _h: u32, ) -> Result<(u32, u32)>

Current required width and height for this widget due to its content
source§

fn require_draw(&self) -> bool

Does this widget currently require re-rendering? (should be reset to false when ‘draw’ is called)
source§

fn is_greedy(&self) -> bool

If true, this widget will expand to fill remaining available space after layout has been computed. If multiple greedy widgets are present in a given StatusBar then the available space will be split evenly between all widgets.
source§

fn update_schedule(&mut self) -> Option<UpdateSchedule>

An UpdateSchedule to allow for external updates to this Widget’s state independently of the window manager event loop.
source§

fn on_startup(&mut self, state: &mut State<X>, x: &X) -> Result<()>

A startup hook to be run in order to initialise this Widget
source§

fn on_event( &mut self, event: &XEvent, state: &mut State<X>, x: &X, ) -> Result<()>

An event hook to be run in order to update this Widget
source§

fn on_refresh(&mut self, state: &mut State<X>, x: &X) -> Result<()>

A refresh hook to be run in order to update this Widget
source§

fn on_new_client(&mut self, id: Xid, state: &mut State<X>, x: &X) -> Result<()>

A manage hook to be run in order to update this Widget
source§

impl StructuralPartialEq for Text

Auto Trait Implementations§

§

impl Freeze for Text

§

impl RefUnwindSafe for Text

§

impl Send for Text

§

impl Sync for Text

§

impl Unpin for Text

§

impl UnwindSafe for Text

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Any for T
where T: Any,

§

impl<T> CloneAny for T
where T: Any + Clone,