Struct kas::widget::Window

pub struct Window<W: Widget + 'static> { /* fields omitted */ }

The main instantiation of the Window trait.

Implementations

impl<W: Widget> Window<W>

pub fn new<T: ToString>(title: T, w: W) -> Window<W>

Create

pub fn set_restrict_dimensions(&mut self, min: bool, max: bool)

Configure whether min/max dimensions are forced

By default, the min size is enforced but not the max.

pub fn on_drop<T>(
    &mut self,
    consume: Box<dyn FnMut(&mut W) -> T>
) -> (Future<T>, UpdateHandle)

Set a closure to be called on destruction, and return a future

The closure consume is called when the window is destroyed, and yields a user-defined value. This value is returned through the returned Future object. In order to be notified when the future completes, its owner should call Manager::update_on_handle with the returned UpdateHandle.

Currently it is not possible for this closure to actually drop the widget, but it may alter its contents: it is the last method call on the widget. (TODO: given unsized rvalues (rfc#1909), the closure should consume self.)

Panics if called more than once. In case the window is cloned, this closure is not inherited by the clone: in that case, on_drop may be called on the clone.

Trait Implementations

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

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Widget> Debug for Window<W>

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

Formats the value using the given formatter.

impl<W: Widget + 'static> Handler for Window<W> where
    W: Widget<Msg = VoidMsg>, 

type Msg = VoidMsg

Type of message returned by this widget

pub fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

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

Handle an event and return a user-defined message

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

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

Get size rules for the given axis

pub fn set_rect(&mut self, rect: Rect, align: AlignHints)

Apply a given rect to self

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

Find a widget by coordinate

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

Draw a widget and its children

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

Get translation of a child

pub fn spatial_range(&self) -> (usize, usize)

Iterate through children in spatial order

impl<W: Widget<Msg = VoidMsg> + 'static> SendEvent for Window<W>

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

Send an event

impl<W: Widget + 'static> Widget for Window<W> where
    W: Widget<Msg = VoidMsg>, 

impl<W: Widget + 'static> WidgetChildren for Window<W>

pub fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

pub fn len(&self) -> usize

Get the number of child widgets

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

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

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

Mutable variant of get

pub fn record_first_id(&mut self, _id: WidgetId)

Record first identifier

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

Check whether id is a descendant

pub fn find(&self, id: WidgetId) -> Option<&dyn WidgetConfig>

Find a child widget by identifier

pub fn find_mut(&mut self, id: WidgetId) -> Option<&mut dyn WidgetConfig>

Find a child widget by identifier

pub fn walk<F: FnMut(&dyn WidgetConfig)>(&self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

pub fn walk_mut<F: FnMut(&mut dyn WidgetConfig)>(&mut self, f: F) where
    Self: Sized, 

Walk through all widgets, calling f once on each.

impl<W: Widget + 'static> WidgetConfig for Window<W>

pub fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

pub fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

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

Configure widget

pub fn configure_recurse<'a, 'b>(&mut self, cmgr: ConfigureManager<'a, 'b>)

Configure self and children

impl<W: Widget + 'static> WidgetCore for Window<W>

pub fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

pub fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

pub fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

pub fn id(&self) -> WidgetId

Get the widget's numeric identifier

pub fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Set the disabled state of a widget

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

Set disabled state (chaining)

pub fn rect(&self) -> Rect

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

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

Construct InputState

impl<W: Widget<Msg = VoidMsg> + 'static> Window for Window<W>

pub fn title(&self) -> &str

Get the window title

pub fn restrict_dimensions(&self) -> (bool, bool)

Whether to limit the maximum size of a window

pub fn add_popup(&mut self, mgr: &mut Manager<'_>, id: WindowId, popup: Popup)

Add a pop-up as a layer in the current window

pub fn remove_popup(&mut self, mgr: &mut Manager<'_>, id: WindowId)

Trigger closure of a pop-up

pub fn resize_popups(&mut self, size_handle: &mut dyn SizeHandle)

Resize popups

pub fn handle_closure(&mut self, mgr: &mut Manager<'_>)

Handle closure of self