Struct kas_widgets::Frame

pub struct Frame<W: Widget> {
    pub inner: W,
    // some fields omitted
}

A frame around content

This widget provides a simple abstraction: drawing a frame around its contents.

Fields

inner: W

Implementations

impl<W: Widget> Frame<W>

pub fn new(inner: W) -> Self

Construct a frame

Trait Implementations

impl<W: Clone + Widget> Clone for Frame<W>

fn clone(&self) -> Frame<W>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug + Widget> Debug for Frame<W>

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

Formats the value using the given formatter.

impl<W: Default + Widget> Default for Frame<W>

fn default() -> Frame<W>

Returns the “default value” for a type.

impl<W: Widget> Deref for Frame<W>

type Target = W

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<W: Widget> DerefMut for Frame<W>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<W: Widget> Handler for Frame<W>

type Msg = <W as Handler>::Msg

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn focus_on_key_nav(&self) -> bool

Generic handler: focus rect on key navigation

fn handle(&mut self, mgr: &mut Manager<'_>, event: Event) -> Response<Self::Msg>

Handle an event and return a user-defined message

impl<W: Widget> HasBool for Frame<W> where
    W: HasBool, 

fn get_bool(&self) -> bool

Get the widget’s state

fn set_bool(&mut self, state: bool) -> TkAction

Set the widget’s state

impl<W: Widget> HasStr for Frame<W> where
    W: HasStr, 

fn get_str(&self) -> &str

Get text by reference

fn get_string(&self) -> String

Get text as a String

impl<W: Widget> HasString for Frame<W> where
    W: HasString, 

fn set_str(&mut self, text: &str) -> TkAction

Set text from a &str

fn set_string(&mut self, text: String) -> TkAction

Set text from a string

impl<W: Widget> Layout for Frame<W>

fn size_rules(
    &mut self,
    size_handle: &mut dyn SizeHandle,
    axis: AxisInfo
) -> SizeRules

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

fn find_id(&self, coord: Coord) -> Option<WidgetId>

Find a widget by coordinate

fn draw(
    &self,
    draw_handle: &mut dyn DrawHandle,
    mgr: &ManagerState,
    disabled: bool
)

Draw a widget and its children

fn translation(&self, _child_index: usize) -> Offset

Get translation of a child

fn spatial_nav(
    &mut self,
    mgr: &mut Manager<'_>,
    reverse: bool,
    from: Option<usize>
) -> Option<usize>

Navigation in spatial order

impl<W: Widget> SendEvent for Frame<W>

fn send(
    &mut self,
    mgr: &mut Manager<'_>,
    id: WidgetId,
    event: Event
) -> Response<Self::Msg>

Send an event

impl<W: Widget> SetAccel for Frame<W> where
    W: SetAccel, 

fn set_accel_string(&mut self, accel: AccelString) -> TkAction

Set accel string

fn set_accel<T>(&mut self, accel: T) -> TkAction where
    T: Into<AccelString>, 

Set text

impl<W: Widget> WidgetChildren for Frame<W>

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, _index: usize) -> Option<&dyn WidgetConfig>

Get a reference to a child widget by index, or None if the index is out of bounds.

fn get_child_mut(&mut self, _index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

fn is_ancestor_of(&self, id: WidgetId) -> bool

Check whether id is a descendant

fn find_child(&self, id: WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn find_leaf(&self, id: WidgetId) -> Option<&(dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn find_leaf_mut(
    &mut self,
    id: WidgetId
) -> Option<&mut (dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn walk_children<F>(&self, f: F) where
    F: FnMut(&(dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

fn walk_children_mut<F>(&mut self, f: F) where
    F: FnMut(&mut (dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

impl<W: Widget> WidgetConfig for Frame<W>

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

fn configure(&mut self, &mut Manager<'_>)

Configure widget

fn configure_recurse(&mut self, cmgr: ConfigureManager<'_, '_>)

Configure self and children

impl<W: Widget> WidgetCore for Frame<W>

fn as_any(&self) -> &dyn Any

Get self as type Any

fn as_any_mut(&mut self) -> &mut dyn Any

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

fn core_data_mut(&mut self) -> &mut CoreData

fn widget_name(&self) -> &'static str

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

fn as_widget_mut(&mut self) -> &mut dyn WidgetConfig

Erase type

fn id(&self) -> WidgetId

Get the widget’s numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

fn set_disabled(&mut self, disabled: bool) -> TkAction

Set the disabled state of a widget

fn with_disabled(self, disabled: bool) -> Self

Set disabled state (chaining)

fn rect(&self) -> Rect

Get the widget’s region, relative to its parent.

fn input_state(&self, mgr: &ManagerState, disabled: bool) -> InputState

Construct InputState

impl<W: Widget> Widget for Frame<W>