Struct components::elements::DrawerElement

pub struct DrawerElement {
    pub component: Rc<RefCell<WidgetComponent>>,
    pub child: Box<dyn Element>,
    pub focused: Option<Id>,
    pub marked: Option<Id>,
    pub captured: Option<Id>,
    pub focus_invalid: bool,
    pub scale: f32,
    pub onfocusedchange: Signal<Id>,
    pub onmarkedchange: Signal<Id>,
    pub oncapturedchange: Signal<Id>,
    pub onscalechange: Signal<ScaleChangeEvent>,
    pub node: Node,
    /* private fields */
}

A Drawer is a layout-only object and it do not requires a rendering instance. It and handles all incoming events, propagating them to the children. Additional Signals: none

Fields

component: Rc<RefCell<WidgetComponent>>

child: Box<dyn Element>

focused: Option<Id>

The current focused control, None if none

marked: Option<Id>

The current marked control, None if none

captured: Option<Id>

The current modal control, None if none

focus_invalid: bool

Whether or not the current focus needs refreshing.

scale: f32

The canvas scale factor. Note that this value is a hint for rendering the canvas, it does not affect any coordinates directly.

onfocusedchange: Signal<Id>

An event for when the focused state changes

onmarkedchange: Signal<Id>

An event for when the marked state changes

oncapturedchange: Signal<Id>

An event for when the captured state changes

onscalechange: Signal<ScaleChangeEvent>

On scale changed

node: Node

Implementations

impl DrawerElement

pub fn new(widget: &Drawer) -> Self

pub fn bring_to_front(&self, control: &dyn Element)

pub fn topmost_at_point(&self, x: f32, y: f32) -> Option<&Box<dyn Element>>

Get the top most control under the given point, or None if there is none (or is the canvas itself)

pub fn apply_depth(&self, control: &dyn Element)

pub fn sync_depth(&self)

pub fn scale(&self) -> f32

The canvas scale factor. Note that this value is a hint for rendering the canvas, it does not affect any coordinates directly.

pub fn set_scale(&mut self, value: f32)

The canvas scale factor. Note that this value is a hint for rendering the canvas, it does not affect any coordinates directly.

pub fn focused(&self) -> Option<&Box<dyn Element>>

The current focused control, None if none

pub fn set_focused(&mut self, control: Option<&dyn Element>)

pub fn captured(&self) -> Option<&Box<dyn Element>>

The current modal control, None if none

pub fn set_captured(&mut self, control: Option<&dyn Element>)

The current modal control, None if none

pub fn marked(&self) -> Option<&Box<dyn Element>>

The current marked control, None if none

pub fn set_marked(&mut self, control: Option<&dyn Element>)

The current marked control, None if none

Trait Implementations

impl AsRef<RefCell<WidgetComponent>> for DrawerElement

fn as_ref(&self) -> &RefCell<WidgetComponent>

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for DrawerElement

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

Formats the value using the given formatter.

impl Element for DrawerElement

fn mouseup(&self, e: &mut MouseEvent)

fn mousedown(&self, e: &mut MouseEvent)

fn mousemove(&self, e: &mut MouseEvent)

fn mousewheel(&self, e: &mut MouseEvent)

fn keyup(&self, e: &mut KeyEvent)

fn keydown(&self, e: &mut KeyEvent)

fn textinput(&self, e: &mut TextEvent)

fn update(&self, dt: f32)

fn render(&self)

fn destroy(&self)

fn node(&self) -> Option<Node>

fn relayout(&self, origin: Point2<f32>)

fn children_at_point(
    &self,
    x: f32,
    y: f32,
    into: Option<Vec<WidgetComponent>>
) -> Vec<WidgetComponent>

fn topmost_child_at_point(&self, x: f32, y: f32) -> Option<&Box<dyn Element>>

fn contains(&self, x: f32, y: f32) -> bool

fn onclipchanged(&self)

fn clip(&self) -> Option<Id>

The control this one is clipped by

fn set_clip(&self, other: Option<Id>)

The control this one is clipped by

fn set_visible_only(&self, visible: bool)

fn visible(&self) -> bool

If the control is visible

fn vis_state(&self) -> bool

If the control is visible

fn set_visible(&self, visible: bool)

If the control is visible

fn find_top_parent(
    &self,
    from: Option<&WidgetComponent>
) -> Option<WidgetComponent>

fn add(&self, child: &dyn Element)

fn remove(&self, child: Id)

The child must be sure that his parent reference is correct. The child must remove the parent reference by himself: child.set_parent(None);

fn children_bounds(&self) -> ChildBounds

fn mouseenter(&self, e: &mut MouseEvent)

fn mouseleave(&self, e: &mut MouseEvent)

fn destroy_children(&self)

fn focus(&self)

fn unfocus(&self)

fn capture(&self)

fn uncapture(&self)

fn mark(&self)

fn unmark(&self)

fn refresh_bounds(&self)

fn bounds_changed(&self, dx: f32, dy: f32, dw: f32, dh: f32)

fn set_pos(&self, x: f32, y: f32)

fn set_size(&self, w: f32, h: f32)

fn destroyed(&self) -> bool

fn right(&self) -> f32

fn bottom(&self) -> f32

fn x(&self) -> f32

The x position of the control bounds, world coordinate

fn set_x(&self, x: f32)

The x position of the control bounds, world coordinate

fn y(&self) -> f32

The y position of the control bounds, world coordinate

fn set_y(&self, y: f32)

The y position of the control bounds, world coordinate

fn w_min(&self) -> f32

The minimum width

fn set_w_min(&self, w_min: f32)

The minimum width

fn h_min(&self) -> f32

The minimum height

fn set_h_min(&self, h_min: f32)

The minimum height

fn w_max(&self) -> f32

The maximum width

fn set_w_max(&self, w_max: f32)

The maximum width

fn h_max(&self) -> f32

The maximum height

fn set_h_max(&self, _h_max: f32)

The maximum height

fn w(&self) -> f32

The width of the control bounds

fn set_w(&self, w: f32)

The width of the control bounds

fn h(&self) -> f32

The height of the control bounds

fn set_h(&self, h: f32)

The height of the control bounds

fn set_x_local(&self, x: f32)

The x position of the control bounds, relative to its container

fn set_y_local(&self, y: f32)

The y position of the control bounds, relative to its container

fn x_local(&self) -> f32

The x position of the control bounds, relative to its container

fn y_local(&self) -> f32

The y position of the control bounds, relative to its container

fn nodes(&self) -> i32

fn is_focused(&self) -> bool

fn set_focused(&self, focused: bool)

fn is_captured(&self) -> bool

fn set_captured(&self, captured: bool)

fn is_marked(&self) -> bool

fn set_marked(&self, marked: bool)

fn depth_offset(&self) -> f32

fn depth(&self) -> f32

fn set_depth(&self, depth: f32)

fn mouse_input(&self) -> bool

fn key_input(&self) -> bool

fn parent(&self) -> Option<&dyn Element>

fn set_parent(&self, p: Option<Id>)

fn id(&self) -> Id