Skip to main content

Textbox

Struct Textbox 

Source
pub struct Textbox {
    pub anchor: Option<Anchor>,
    pub rect: Option<LogicalRect>,
    pub display_id: Option<DisplayId>,
    pub text: String,
    pub style: Option<TextboxStyle>,
    pub ttl_ms: Option<u64>,
}
Expand description

Place a text box.

Display only. Arin never renders an editable input, and the overlay is fully click through. This is not negotiable within 0.x.

Fields§

§anchor: Option<Anchor>

Where to pin the box. Preferred form.

§rect: Option<LogicalRect>

Shorthand for an anchor, used with display_id.

§display_id: Option<DisplayId>

Required when rect is used instead of anchor.

§text: String

The text to render.

§style: Option<TextboxStyle>

What the text is for, which decides how loudly it is drawn.

Omit for TextboxStyle::Note.

§ttl_ms: Option<u64>

How long the box should live, in milliseconds.

Omit to draw until cleared, invalidated, or the session ends.

Implementations§

Source§

impl Textbox

Source

pub fn new(anchor: Anchor, text: impl Into<String>) -> Self

Pin text to a region.

Source

pub fn with_style(self, style: TextboxStyle) -> Self

Say what the text is for.

Source

pub fn with_ttl_ms(self, ttl_ms: Option<u64>) -> Self

Set how long the box lives, in milliseconds.

Source

pub fn resolved_anchor(&self) -> Result<Anchor, ValidationError>

The anchor, whichever form was sent.

Trait Implementations§

Source§

impl Clone for Textbox

Source§

fn clone(&self) -> Textbox

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Textbox

Source§

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

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

impl<'de> Deserialize<'de> for Textbox

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Textbox

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Textbox

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Textbox

Source§

impl Validate for Textbox

Source§

fn validate(&self) -> Result<(), ValidationError>

Check the message. Called by the daemon before anything is rendered.

Auto Trait Implementations§

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§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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,

Source§

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>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.