Struct ViewId

pub struct ViewId(/* private fields */);

A small unique identifier for an instance of a View.

This id is how you can access and modify a view, including accessing children views and updating state.

Implementations

impl ViewId

pub fn new() -> ViewId

Create a new unique Viewid.

pub fn remove(&self)

Remove this view id and all of it’s children from the VIEW_STORAGE

pub fn new_taffy_node(&self) -> NodeId

Create a new taffy layout node

pub fn set_taffy_style(&self, node: NodeId, style: Style)

Set the layout properties on a taffy node

pub fn taffy_layout(&self, node: NodeId) -> Option<Layout>

Get the layout for a taffy node relative to it’s parent

pub fn taffy_node(&self) -> NodeId

Get the taffy node associated with this Id

pub fn add_child(&self, child: Box<dyn View>)

Add a child View to this Id’s list of children

pub fn set_children(&self, children: Vec<impl IntoView>)

Set the children views of this Id

pub fn set_view(&self, view: Box<dyn View>)

Set the view that should be associated with this Id

pub fn set_parent(&self, parent: ViewId)

Set the Id that should be used as the parent of this Id

pub fn set_children_ids(&self, children: Vec<ViewId>)

Set the Ids that should be used as the children of this Id

pub fn children(&self) -> Vec<ViewId>

Get the list of ViewIds that are associated with the children views of this ViewId

pub fn parent(&self) -> Option<ViewId>

Get the ViewId that has been set as this ViewId’s parent

pub fn layout_rect(&self) -> Rect

Get the computed rectangle that covers the area of this View

pub fn get_size(&self) -> Option<Size>

Get the size of this View

pub fn parent_size(&self) -> Option<Size>

Get the Size of the parent View

pub fn get_content_rect(&self) -> Rect

Returns the layout rect excluding borders, padding and position. This is relative to the view.

pub fn get_layout(&self) -> Option<Layout>

This gets the Taffy Layout and adjusts it to be relative to the parent View.

pub fn style_has_hidden(&self) -> bool

Returns true if the computed style for this view is marked as hidden (Display::None)

pub fn is_hidden_recursive(&self) -> bool

Is this view, or any parent view, marked as hidden

pub fn request_all(&self)

Request that this the id view be styled, laid out and painted again. This will recursively request this for all parents.

pub fn request_layout(&self)

Request that this view have it’s layout pass run

pub fn window_id(&self) -> Option<WindowId>

Get the window id of the window containing this view, if there is one.

pub fn request_paint(&self)

Request that this view have it’s paint pass run

pub fn request_style(&self)

request that this node be styled again This will recursively request style for all parents.

pub fn request_focus(&self)

Request that this view gain the window focus

pub fn clear_focus(&self)

Clear the focus from this window

pub fn update_context_menu(&self, menu: impl Fn() -> Menu + 'static)

Set the system context menu that should be shown when this view is right-clicked

pub fn update_popout_menu(&self, menu: impl Fn() -> Menu + 'static)

Set the system popout menu that should be shown when this view is clicked

Adds a primary-click context menu, which opens below the view.

pub fn request_active(&self)

Request that this view receive the active state (mark that this element is currently being interacted with)

When an View has Active, it will receive events such as mouse events, even if the mouse is not directly over this view. This is usefor for views such as Sliders, where the mouse event should be sent to the slider view as long as the mouse is pressed down, even if the mouse moves out of the view, or even out of the Window.

pub fn clear_active(&self)

Request that the active state be removed from this View

pub fn inspect(&self)

Send a message to the application to open the Inspector for this Window

pub fn scroll_to(&self, rect: Option<Rect>)

Scrolls the view and all direct and indirect children to bring the view to be visible. The optional rectangle can be used to add an additional offset and intersection.

pub fn update_state(&self, state: impl Any)

Send a state update to the update method of the associated View

pub fn add_event_listener( &self, listener: EventListener, action: Box<EventCallback>, )

Add an callback on an action for a given EventListener

pub fn update_resize_listener(&self, action: Box<ResizeCallback>)

Set a callback that should be run when the size of the view changes

pub fn update_move_listener(&self, action: Box<dyn Fn(Point)>)

Set a callback that should be run when the position of the view changes

pub fn update_cleanup_listener(&self, action: Box<dyn Fn()>)

Set a callback that should be run when the view is removed from the view tree

pub fn get_combined_style(&self) -> Style

Get the combined style that is associated with this View.

This will have all of the style properties set in it that are relevant to this view, including all properties from relevant classes.

Warning

The view styles do not store property transition states, only markers of which properties should be transitioned over time on change.

If you have a property that could be transitioned over time, make sure to use a prop extractor that is updated in a style method of the View to extract the property.

pub fn add_class(&self, class: StyleClassRef)

Add a class to the list of style classes that are associated with this ViewId

pub fn remove_class(&self, class: StyleClassRef)

Remove a class from the list of style classes that are associated with this ViewId

pub fn update_disabled(&self, is_disabled: bool)

Set whether this view should be marked as disabled or not.

When a view is disabled it will not receive events and it can be styled with the disabled style.

pub fn keyboard_navigable(&self)

Mark this view as a view that can be navigated to using the keyboard

pub fn remove_keyboard_navigatable(&self)

Mark this view as a view that can not be navigated to using the keyboard

pub fn disable_default_event(&self, event: EventListener)

Disables the default view behavior for the specified event.

Children will still see the event, but the view event function will not be called nor the event listeners on the view

pub fn remove_disable_default_event(&self, event: EventListener)

Re-enables the default view behavior for a previously disabled event.

pub fn pointer_events(&self, pointer_events: bool)

Set if the view should process pointer events

pub fn draggable(&self)

Mark this view as a view that can be dragged

You can customize the apearance of a view while dragging in the style

pub fn window_visible(&self, visible: bool)

Alter the visibility of the current window the view represented by this ID is in.

pub fn update_state_deferred(&self, state: impl Any)

Send a state update that will be placed in deferred messages

pub fn screen_layout(&self) -> Option<ScreenLayout>

Get a layout in screen-coordinates for this view, if possible.

Trait Implementations

impl Clone for ViewId

fn clone(&self) -> ViewId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewId

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

Formats the value using the given formatter.

impl Default for ViewId

fn default() -> ViewId

Returns the “default value” for a type.

impl From<KeyData> for ViewId

fn from(k: KeyData) -> Self

Converts to this type from the input type.

impl Hash for ViewId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Key for ViewId

fn data(&self) -> KeyData

Gets the KeyData stored in this key.

fn null() -> Self

Creates a new key that is always invalid and distinct from any non-null key. A null key can only be created through this method (or default initialization of keys made with new_key_type!, which calls this method).

fn is_null(&self) -> bool

Checks if a key is null. There is only a single null key, that is a.is_null() && b.is_null() implies a == b.

impl Ord for ViewId

fn cmp(&self, other: &ViewId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ViewId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ViewId

fn partial_cmp(&self, other: &ViewId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for ViewId

impl Eq for ViewId

impl StructuralPartialEq for ViewId