Struct PortalList 

pub struct PortalList { /* private fields */ }

Implementations

impl PortalList

pub fn next_visible_item(&mut self, cx: &mut Cx2d<'_, '_>) -> Option<usize>

Returns the index of the next visible item that will be drawn by this PortalList.

pub fn item( &mut self, cx: &mut Cx, entry_id: usize, template: LiveId, ) -> WidgetRef

Creates a new widget from the given template or returns an existing widget, if one already exists with the same entry_id.

If you care whether the widget already existed or not, use PortalList::item_with_existed() instead.

Return

• If a widget already existed for the given entry_id and template, this returns a reference to that widget.
• If a new widget was created successfully, this returns a reference to that new widget.
• If the given template could not be found, this returns None.

pub fn item_with_existed( &mut self, cx: &mut Cx, entry_id: usize, template: LiveId, ) -> (WidgetRef, bool)

Creates a new widget from the given template or returns an existing widget, if one already exists with the same entry_id and template.

• If you only want to check whether the item already existed without creating one, use PortalList::get_item() instead.
• If you don’t care whether the widget already existed or not, use PortalList::item() instead.

Return

• If a widget of the same template already existed for the given entry_id, this returns a tuple of that widget and true.
• If a new widget was created successfully, either because an item with the given entry_id did not exist or because the existing item with the given entry_id did not use the given template, this returns a tuple of that widget and false.
• If the given template could not be found, this returns None.

pub fn position_of_item(&self, cx: &Cx, entry_id: usize) -> Option<f64>

Returns the “start” position of the item with the given entry_id relative to the “start” position of the PortalList.

• For vertical lists, the start position is the top of the item relative to the top of the PortalList.
• For horizontal lists, the start position is the left side of the item relative to the left side of the PortalList.

Returns None if the item with the given entry_id does not exist or if the item’s area rectangle is zero.

TODO: FIXME: this may not properly handle bottom-up lists or lists that go from right to left.

pub fn get_item(&self, entry_id: usize) -> Option<(LiveId, WidgetRef)>

Returns a reference to the template and widget for the given entry_id.

pub fn set_item_range( &mut self, cx: &mut Cx, range_start: usize, range_end: usize, )

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

pub fn is_at_end(&self) -> bool

Returns true if currently at the end of the list, meaning that the lasat item is visible in the viewport.

pub fn visible_items(&self) -> usize

Returns the number of items that are currently visible in the viewport, including partially visible items.

pub fn fails_sanity_check_first_id_within_item_range(&self) -> bool

Returns true if this sanity check fails: the first item ID is within the item range.

Returns false if the sanity check passes as expected.

pub fn smooth_scroll_to( &mut self, cx: &mut Cx, target_id: usize, speed: f64, max_items_to_show: Option<usize>, )

Initiates a smooth scrolling animation to the specified target item in the list.

Arguments

• target_id: The ID (index) of the item to scroll to.
• speed: A positive floating-point value that controls the speed of the animation. The speed will always be treated as an absolute value, with the direction of the scroll (up or down) determined by whether target_id is above or below the current item.
• max_items_to_show: The maximum number of items to show during the scrolling animation. If None, the default value of 20 is used.

Example

// Scrolls to item 42 at speed 100.0, including at most 30 items in the scroll animation.
smooth_scroll_to(&mut cx, 42, 100.0, Some(30));

pub fn smooth_scroll_to_end( &mut self, cx: &mut Cx, speed: f64, max_items_to_show: Option<usize>, )

Trigger an scrolling animation to the end of the list

Arguments

• speed: This value controls how fast the scrolling animation is. Note: This number should be large enough to reach the end, so it is important to test the passed number. TODO provide a better implementation to ensure that the end is always reached, no matter the speed value.
• max_items_to_show: The maximum number of items to show during the scrolling animation. If None, the default value of 20 is used.

Trait Implementations

impl LiveApply for PortalList

fn apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], ) -> usize

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

impl LiveApplyReset for PortalList

fn apply_reset( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, start_index: usize, nodes: &[LiveNode], )

impl LiveApplyValue for PortalList

fn apply_value( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

impl LiveHook for PortalList

fn before_apply( &mut self, _cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn apply_value_instance( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn after_apply( &mut self, _cx: &mut Cx, _applyl: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], )

fn apply_value_unknown( &mut self, cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> usize

fn skip_apply_animator( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> bool

fn skip_apply( &mut self, _cx: &mut Cx, _apply: &mut Apply<'_, '_, '_>, _index: usize, _nodes: &[LiveNode], ) -> Option<usize>

fn after_apply_from(&mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>)

fn after_new_from_doc(&mut self, _cx: &mut Cx)

fn after_update_from_doc(&mut self, _cx: &mut Cx)

fn after_apply_from_doc(&mut self, _cx: &mut Cx)

fn after_new_before_apply(&mut self, _cx: &mut Cx)

impl LiveHookDeref for PortalList

fn deref_before_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

fn deref_after_apply( &mut self, cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], )

impl LiveNew for PortalList

fn live_type_info(cx: &mut Cx) -> LiveTypeInfo

fn live_design_with(cx: &mut Cx)

fn new(cx: &mut Cx) -> Self

fn new_apply( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_apply_over(cx: &mut Cx, nodes: &[LiveNode]) -> Self

where Self: Sized,

fn new_apply_mut_index( cx: &mut Cx, apply: &mut Apply<'_, '_, '_>, index: &mut usize, nodes: &[LiveNode], ) -> Self

where Self: Sized,

fn new_from_ptr(cx: &mut Cx, live_ptr: Option<LivePtr>) -> Self

where Self: Sized,

fn update_from_ptr(&mut self, cx: &mut Cx, live_ptr: Option<LivePtr>)

fn update_from_ptr_with_scope( &mut self, cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, )

fn new_from_ptr_with_scope( cx: &mut Cx, live_ptr: Option<LivePtr>, scope: &mut Scope<'_, '_>, ) -> Self

where Self: Sized,

fn new_main(cx: &mut Cx) -> Option<Self>

where Self: Sized,

fn register_main_module(cx: &mut Cx)

fn update_main(&mut self, cx: &mut Cx)

fn new_local(cx: &mut Cx) -> Self

where Self: Sized,

fn new_from_module( cx: &mut Cx, module_id: LiveModuleId, id: LiveId, ) -> Option<Self>

where Self: Sized,

fn update_from_module( &mut self, cx: &mut Cx, module_id: LiveModuleId, id: LiveId, )

impl LiveRegister for PortalList

fn live_register(cx: &mut Cx)

impl Widget for PortalList

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

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

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

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

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

fn widget_uid(&self) -> WidgetUid

fn widget_to_data( &self, _cx: &mut Cx, _actions: &Actions, _nodes: &mut LiveNodeVec, _path: &[LiveId], ) -> bool

fn data_to_widget( &mut self, _cx: &mut Cx, _nodes: &[LiveNode], _path: &[LiveId], )

fn draw_3d( &mut self, _cx: &mut Cx3d<'_, '_>, _scope: &mut Scope<'_, '_>, ) -> DrawStep

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

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

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

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

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

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

fn text(&self) -> String

fn set_text(&mut self, _cx: &mut Cx, _v: &str)

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

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

fn set_disabled(&mut self, _cx: &mut Cx, _disabled: bool)

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

fn ref_cast_type_id(&self) -> LiveType

where Self: 'static,

fn ui_runner(&self) -> UiRunner<Self>

where Self: Sized + 'static,

impl WidgetNode for PortalList

fn area(&self) -> Area

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

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

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

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

fn widget_design(&mut self) -> Option<&mut dyn WidgetDesign>

fn set_action_data(&mut self, _data: Arc<dyn ActionTrait>)

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

fn set_visible(&mut self, _cx: &mut Cx, _visible: bool)

fn visible(&self) -> bool