ltk

Struct WindowButton

Source
pub struct WindowButton<Msg: Clone> {
    pub kind: WindowButtonKind,
    pub on_press: Option<Msg>,
    pub size: f32,
    pub id: Option<WidgetId>,
    pub focusable: bool,
}
Expand description

Button styled for compositor / window decorations.

The widget is intentionally policy-free: it paints a standard control and emits the message supplied by the caller. Forge remains responsible for deciding what that message does to the window.

Fields§

§kind: WindowButtonKind

Which decoration role this button paints.

§on_press: Option<Msg>

Message emitted on activation. None greys the button and skips the hover / pressed surface — useful for “maximize disabled” on fixed-size windows.

§size: f32

Square hit-target size in logical pixels. Clamped to a 20 px floor by Self::size so the button stays touchable.

§id: Option<WidgetId>

Optional stable identifier for focus management.

§focusable: bool

Whether this button takes part in the Tab / Shift+Tab cycle. Defaults to false to match desktop convention — title-bar chrome on macOS, GNOME and Windows is click/touch-only and never steals keyboard focus from window content. Opt in with Self::focusable for shells where keyboard reachability of decorations matters (accessibility, no-mouse kiosks). Pointer / touch hit testing is unaffected by this flag.

Implementations§

Source§

impl<Msg: Clone> WindowButton<Msg>

Source

pub fn new(kind: WindowButtonKind) -> Self

Create a window-decoration button of the given kind. The button is inert (no callback) until Self::on_press is configured.

Source

pub fn on_press(self, msg: Msg) -> Self

Set the message emitted when the button is activated.

Source

pub fn on_press_maybe(self, msg: Option<Msg>) -> Self

Like Self::on_press but keeps the disabled state when None is passed — useful when the message depends on a runtime condition (e.g. maximize is disabled for fixed-size windows).

Source

pub fn size(self, size: f32) -> Self

Override the square hit-target size in logical pixels. Clamped to a 20 px floor so the button remains touchable.

Source

pub fn id(self, id: WidgetId) -> Self

Assign a stable identifier for focus management.

Source

pub fn focusable(self, yes: bool) -> Self

Opt into keyboard focus traversal. Defaults to false so the button does not steal Tab focus from window content.

Source

pub fn preferred_size(&self, max_width: f32, _canvas: &Canvas) -> (f32, f32)

Source

pub fn paint_bounds(&self, rect: Rect) -> Rect

Source

pub fn draw( &self, canvas: &mut Canvas, rect: Rect, focused: bool, hovered: bool, pressed: bool, )

Trait Implementations§

Source§

impl<Msg: Clone + 'static> From<WindowButton<Msg>> for Element<Msg>

Source§

fn from(b: WindowButton<Msg>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<Msg> Freeze for WindowButton<Msg>
where Msg: Freeze,

§

impl<Msg> RefUnwindSafe for WindowButton<Msg>
where Msg: RefUnwindSafe,

§

impl<Msg> Send for WindowButton<Msg>
where Msg: Send,

§

impl<Msg> Sync for WindowButton<Msg>
where Msg: Sync,

§

impl<Msg> Unpin for WindowButton<Msg>
where Msg: Unpin,

§

impl<Msg> UnwindSafe for WindowButton<Msg>
where Msg: UnwindSafe,

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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