Struct DockRef

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

Implementations

impl DockRef

pub fn has_widget(&self, widget: &WidgetRef) -> DockRef

pub fn borrow(&self) -> Option<Ref<'_, Dock>>

pub fn borrow_mut(&self) -> Option<RefMut<'_, Dock>>

pub fn borrow_if_eq(&self, widget: &WidgetRef) -> Option<Ref<'_, Dock>>

pub fn borrow_mut_if_eq(&self, widget: &WidgetRef) -> Option<RefMut<'_, Dock>>

impl DockRef

pub fn item(&self, entry_id: LiveId) -> WidgetRef

pub fn item_or_create( &self, cx: &mut Cx, entry_id: LiveId, template: LiveId, ) -> Option<WidgetRef>

pub fn close_tab(&self, cx: &mut Cx, tab_id: LiveId)

pub fn accept_drag(&self, cx: &mut Cx, dh: DragHitEvent, dr: DragResponse)

pub fn drawing_item_id(&self) -> Option<LiveId>

pub fn drop_clone( &self, cx: &mut Cx, abs: DVec2, old_item: LiveId, new_item: LiveId, template: LiveId, )

pub fn drop_move(&self, cx: &mut Cx, abs: DVec2, item: LiveId)

pub fn drop_create( &self, cx: &mut Cx, abs: DVec2, item: LiveId, kind: LiveId, name: String, template: LiveId, )

pub fn create_and_select_tab( &self, cx: &mut Cx, parent: LiveId, item: LiveId, kind: LiveId, name: String, template: LiveId, insert_after: Option<usize>, ) -> Option<WidgetRef>

pub fn create_tab( &self, cx: &mut Cx, parent: LiveId, item: LiveId, kind: LiveId, name: String, template: LiveId, insert_after: Option<usize>, ) -> Option<WidgetRef>

pub fn replace_tab( &self, cx: &mut Cx, tab_item_id: LiveId, new_kind: LiveId, new_name: Option<String>, select: bool, ) -> Option<(WidgetRef, bool)>

See Dock::replace_tab().

pub fn set_tab_title(&self, cx: &mut Cx, tab: LiveId, title: String)

pub fn find_tab_bar_of_tab(&self, tab_id: LiveId) -> Option<(LiveId, usize)>

pub fn select_tab(&self, cx: &mut Cx, item: LiveId)

pub fn redraw_tab(&self, cx: &mut Cx, tab_id: LiveId)

pub fn unique_id(&self, base: u64) -> LiveId

pub fn check_and_clear_need_save(&self) -> bool

pub fn clone_state(&self) -> Option<HashMap<LiveId, DockItem>>

pub fn tab_start_drag(&self, cx: &mut Cx, _tab_id: LiveId, item: DragItem)

Methods from Deref<Target = WidgetRef>

pub fn is_empty(&self) -> bool

pub fn handle_event_with( &self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, sweep_area: Area, )

handle event with a sweep area

this is used for the sweep event, this fn can help to pass the event into popup, the widget should implement the handle_event_with fn in impl Widget for $Widget

Example

impl Widget for Button {
fn handle_event_with(&mut self, cx: &mut Cx, event: &Event, scope: &mut Scope, sweep_area: Area) {
    let uid = self.widget_uid();

    if self.animator_handle_event(cx, event).must_redraw() {
        self.draw_button.redraw(cx);
    }
    match event.hits_with_options(cx, self.draw_button.area(), HitOptions::new().with_sweep_area(sweep_area) ) {
        Hit::FingerDown(f_down) => {
            if self.grab_key_focus {
                 cx.set_key_focus(self.sweep_area);
            }
            cx.widget_action(uid, &scope.path, GButtonEvent::Pressed(f_down.modifiers));
            self.animator_play(cx, id!(hover.pressed));
        }
        _ =>()
    }
}

Details

See Flexible Popup

pub fn handle_event( &self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, )

pub fn widget_uid(&self) -> WidgetUid

Returns the unique ID (UID) of this widget.

Returns WidgetUid(0) if the widget is currently borrowed or is empty.

pub fn area(&self) -> Area

pub fn widget_to_data( &self, cx: &mut Cx, actions: &Actions, nodes: &mut LiveNodeVec, path: &[LiveId], ) -> bool

pub fn set_action_data<T: ActionTrait + PartialEq>(&self, data: T)

pub fn set_action_data_always<T: ActionTrait>(&self, data: T)

pub fn data_to_widget(&self, cx: &mut Cx, nodes: &[LiveNode], path: &[LiveId])

pub fn uid_to_widget(&self, uid: WidgetUid) -> WidgetRef

pub fn clear_query_cache(&self)

pub fn find_widgets( &self, path: &[LiveId], cached: WidgetCache, results: &mut WidgetSet, )

pub fn widget(&self, path: &[LiveId]) -> WidgetRef

pub fn widgets(&self, paths: &[&[LiveId]]) -> WidgetSet

pub fn widget_set(&self, paths: &[&[LiveId]]) -> WidgetSet

pub fn draw_walk( &self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, ) -> DrawStep

pub fn draw_walk_all( &self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, walk: Walk, )

pub fn draw_3d_all(&self, cx: &mut Cx3d<'_, '_>, scope: &mut Scope<'_, '_>)

pub fn draw_3d( &mut self, cx: &mut Cx3d<'_, '_>, scope: &mut Scope<'_, '_>, ) -> DrawStep

pub fn draw( &mut self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>, ) -> DrawStep

pub fn draw_unscoped(&mut self, cx: &mut Cx2d<'_, '_>) -> DrawStep

pub fn walk(&self, cx: &mut Cx) -> Walk

pub fn redraw(&self, cx: &mut Cx)

pub fn set_visible(&self, cx: &mut Cx, visible: bool)

pub fn visible(&self) -> bool

pub fn text(&self) -> String

pub fn set_text(&self, cx: &mut Cx, v: &str)

pub fn key_focus(&self, cx: &Cx) -> bool

pub fn set_key_focus(&self, cx: &mut Cx)

pub fn set_disabled(&self, cx: &mut Cx, disabled: bool)

pub fn disabled(&self, cx: &Cx) -> bool

pub fn draw_all(&self, cx: &mut Cx2d<'_, '_>, scope: &mut Scope<'_, '_>)

pub fn action_data(&self) -> Option<Arc<dyn ActionTrait>>

pub fn filter_actions<'a>( &'a self, actions: &'a Actions, ) -> impl Iterator<Item = &'a WidgetAction>

pub fn draw_all_unscoped(&self, cx: &mut Cx2d<'_, '_>)

pub fn borrow_mut<T: 'static + Widget>(&self) -> Option<RefMut<'_, T>>

pub fn borrow<T: 'static + Widget>(&self) -> Option<Ref<'_, T>>

pub fn apply_over(&self, cx: &mut Cx, nodes: &[LiveNode])

Trait Implementations

impl Clone for DockRef

fn clone(&self) -> DockRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DockRef

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

Formats the value using the given formatter.

impl Default for DockRef

fn default() -> Self

Returns the “default value” for a type.

impl Deref for DockRef

type Target = WidgetRef

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for DockRef

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

Mutably dereferences the value.