Struct kas_widgets::view::ListView

pub struct ListView<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Driver<T::Item> = Default> { /* fields omitted */ }

List view widget

This widget supports a view over a list of shared data items.

The shared data type T must support ListData and UpdatableAll, the latter with key type T::Key and message type matching the widget’s message. One may use kas::updatable::SharedRc or a custom shared data type.

The driver V must implement Driver, with data type <T as ListData>::Item. Several implementations are available in the driver module or a custom implementation may be used.

This widget is Scrollable, supporting keyboard, wheel and drag scrolling. You may wish to wrap this widget with ScrollBars.

Implementations

impl<D: Directional + Default, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item> + Default> ListView<D, T, V>

pub fn new(data: T) -> Self

Construct a new instance

This constructor is available where the direction is determined by the type: for D: Directional + Default. In other cases, use ListView::new_with_direction.

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item> + Default> ListView<D, T, V>

pub fn new_with_direction(direction: D, data: T) -> Self

Construct a new instance with explicit direction

impl<D: Directional + Default, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> ListView<D, T, V>

pub fn new_with_driver(view: V, data: T) -> Self

Construct a new instance with explicit view

impl<T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> ListView<Direction, T, V>

pub fn set_direction(&mut self, direction: Direction) -> TkAction

Set the direction of contents

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> ListView<D, T, V>

pub fn new_with_dir_driver(direction: D, view: V, data: T) -> Self

Construct a new instance with explicit direction and view

pub fn data(&self) -> &T

Access the stored data

pub fn data_mut(&mut self) -> &mut T

Mutably access the stored data

It may be necessary to use ListView::update_view to update the view of this data.

pub fn get_value(&self, key: &T::Key) -> Option<T::Item>

Get a copy of the shared value at key

pub fn set_value(&self, mgr: &mut Manager<'_>, key: &T::Key, data: T::Item)

Set shared data

This method updates the shared data, if supported (see ListData::update). Other widgets sharing this data are notified of the update, if data is changed.

pub fn update_value<F: Fn(T::Item) -> T::Item>(
    &self,
    mgr: &mut Manager<'_>,
    key: &T::Key,
    f: F
)

Update shared data

This is purely a convenience method over ListView::set_value. It does nothing if no value is found at key. It notifies other widgets of updates to the shared data.

pub fn selection_mode(&self) -> SelectionMode

Get the current selection mode

pub fn set_selection_mode(&mut self, mode: SelectionMode) -> TkAction

Set the current selection mode

pub fn with_selection_mode(self, mode: SelectionMode) -> Self

Set the selection mode (inline)

pub fn selected_iter(&self) -> impl Iterator<Item = &T::Key> + '_

Read the list of selected entries

With mode SelectionMode::Single this may contain zero or one entry; use selected_iter().next() to extract only the first (optional) entry.

pub fn is_selected(&self, key: &T::Key) -> bool

Check whether an entry is selected

pub fn clear_selected(&mut self)

Clear all selected items

Does not send ChildMsg responses.

pub fn select(&mut self, key: T::Key) -> Result<bool, SelectionError>

Directly select an item

Returns true if selected, false if already selected. Fails if selection mode does not permit selection or if the key is invalid.

Does not send ChildMsg responses.

pub fn deselect(&mut self, key: &T::Key) -> bool

Directly deselect an item

Returns true if deselected, false if not previously selected. Also returns false on invalid keys.

Does not send ChildMsg responses.

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

Manually trigger an update to handle changed data

pub fn direction(&self) -> Direction

Get the direction of contents

pub fn with_num_visible(self, number: i32) -> Self

Set the preferred number of items visible (inline)

This affects the (ideal) size request and whether children are sized according to their ideal or minimum size but not the minimum size.

Trait Implementations

impl<D: Clone + Directional, T: Clone + ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Clone + Driver<T::Item>> Clone for ListView<D, T, V> where
    T::Key: Clone,
    V::Widget: Clone,
    T::Key: Clone,
    T::Key: Clone, 

fn clone(&self) -> ListView<D, T, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Directional, T: Debug + ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Debug + Driver<T::Item>> Debug for ListView<D, T, V> where
    T::Key: Debug,
    V::Widget: Debug,
    T::Key: Debug,
    T::Key: Debug, 

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

Formats the value using the given formatter.

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Driver<T::Item>> Handler for ListView<D, T, V>

type Msg = ChildMsg<T::Key, <V::Widget as Handler>::Msg>

Type of message returned by this widget

fn activation_via_press(&self) -> bool

Generic handler: translate presses to activations

fn focus_on_key_nav(&self) -> bool

Generic handler: focus rect on key navigation

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

Handle an event and return a user-defined message

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> Layout for ListView<D, T, V>

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

Get size rules for the given axis

fn set_rect(&mut self, mgr: &mut Manager<'_>, rect: Rect, align: AlignHints)

Apply a given rect to self

fn spatial_nav(
    &mut self,
    mgr: &mut Manager<'_>,
    reverse: bool,
    from: Option<usize>
) -> Option<usize>

Navigation in spatial order

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

Find a widget by coordinate

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

Draw a widget and its children

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

Get translation of a child

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> Scrollable for ListView<D, T, V>

fn scroll_axes(&self, size: Size) -> (bool, bool)

Given size size, returns whether (horiz, vert) scrolling is required

fn max_scroll_offset(&self) -> Offset

Get the maximum scroll offset

fn scroll_offset(&self) -> Offset

Get the current scroll offset

fn set_scroll_offset(&mut self, mgr: &mut Manager<'_>, offset: Offset) -> Offset

Set the scroll offset

fn scroll_by_delta(&mut self, mgr: &mut Manager<'_>, delta: Offset) -> Offset

Scroll by a delta

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> SendEvent for ListView<D, T, V>

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

Send an event

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> WidgetChildren for ListView<D, T, V>

fn first_id(&self) -> WidgetId

Get the first identifier of self or any children

fn record_first_id(&mut self, id: WidgetId)

Record first identifier

fn num_children(&self) -> usize

Get the number of child widgets

fn get_child(&self, index: usize) -> Option<&dyn WidgetConfig>

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

fn get_child_mut(&mut self, index: usize) -> Option<&mut dyn WidgetConfig>

Mutable variant of get

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

Check whether id is a descendant

fn find_child(&self, id: WidgetId) -> Option<usize>

Find the child which is an ancestor of this id, if any

fn find_leaf(&self, id: WidgetId) -> Option<&(dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn find_leaf_mut(
    &mut self,
    id: WidgetId
) -> Option<&mut (dyn WidgetConfig + 'static)>

Find the leaf (lowest descendant) with this id, if any

fn walk_children<F>(&self, f: F) where
    F: FnMut(&(dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

fn walk_children_mut<F>(&mut self, f: F) where
    F: FnMut(&mut (dyn WidgetConfig + 'static)), 

Walk through all widgets, calling f once on each.

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg>, V: Driver<T::Item>> WidgetConfig for ListView<D, T, V>

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

Configure widget

fn configure_recurse(&mut self, cmgr: ConfigureManager<'_, '_>)

Configure self and children

fn key_nav(&self) -> bool

Is this widget navigable via Tab key?

fn hover_highlight(&self) -> bool

Does this widget have hover-state highlighting?

fn cursor_icon(&self) -> CursorIcon

Which cursor icon should be used on hover?

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Driver<T::Item>> WidgetCore for ListView<D, T, V>

fn as_any(&self) -> &dyn Any

Get self as type Any

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

Get self as type Any (mutable)

fn core_data(&self) -> &CoreData

Get direct access to the CoreData providing property storage.

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

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

Get the name of the widget struct

fn as_widget(&self) -> &dyn WidgetConfig

Erase type

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

Erase type

fn id(&self) -> WidgetId

Get the widget’s numeric identifier

fn is_disabled(&self) -> bool

Get whether the widget is disabled

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

Set the disabled state of a widget

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

Set disabled state (chaining)

fn rect(&self) -> Rect

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

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

Construct InputState

impl<D: Directional, T: ListData + UpdatableAll<T::Key, V::Msg> + 'static, V: Driver<T::Item>> Widget for ListView<D, T, V>