pub struct DirListBox { /* private fields */ }Expand description
A concrete ListViewer over a Vec<DirEntry> that renders the current
working directory as a tree-indented listing of its ancestors and immediate
subdirectories.
§Why it is a parallel ListViewer, not a ListBox
This is a second, parallel, direct ListViewer impl — exactly like
ListBox is — over its own Vec<DirEntry>
storage. It does not embed or delegate through a ListBox: if it
delegated View::draw, draw would run with the
inner ListBox as self and call its text accessor over Vec<String>,
never consulting the Vec<DirEntry>.
§Native paths
The listing is built from native /-separated paths; there are no drive
letters or backslashes.
§Turbo Vision heritage
Ports TDirListBox (fileopen.cpp/dialogs.h), a list-box subclass; here it
becomes a parallel ListViewer impl over its own storage (deviation D2),
native /-paths replace the DOS drive model (deviation D14), and persistence
is dropped (deviation D12).
Implementations§
Source§impl DirListBox
impl DirListBox
Sourcepub fn new(bounds: Rect, h: Option<ViewId>, v: Option<ViewId>) -> Self
pub fn new(bounds: Rect, h: Option<ViewId>, v: Option<ViewId>) -> Self
Construct an empty single-column dir list box, ready to be populated by
new_directory.
Only the vertical scrollbar v is used; h is accepted for API parity
with ListBox::new — pass None for
h. Wire the Chdir button after construction via
set_chdir_button (needed by
ChDirDialog::new only; FileDialog never wires one).
Sourcepub fn list(&self) -> &[DirEntry]
pub fn list(&self) -> &[DirEntry]
Borrow the current directory-tree listing as a slice of DirEntry items.
Populated by new_directory; empty until
the first call. Use focused_entry to
read the cursor’s current entry.
Wire the owning change-directory dialog’s change-dir button id (set after
assembly, once the button’s id is known). Read only by
set_state to make that button (un-)default on a
focus change.
Sourcepub fn focused_entry(&self) -> Option<&DirEntry>
pub fn focused_entry(&self) -> Option<&DirEntry>
The focused DirEntry, or None when the list is empty / the focus is
out of range. Read by the change-directory dialog when it handles a
change-dir request.
Sourcepub fn new_directory(&mut self, dir: &str, ctx: &mut Context<'_>)
pub fn new_directory(&mut self, dir: &str, ctx: &mut Context<'_>)
Read dir’s subdirectories from the filesystem, build the tree via the
private build_tree, then publish the new list to the list-viewer
machinery and focus the current-directory entry.
The only impure operation (filesystem read) is isolated here; all tree
construction is in the pure build_tree.
Trait Implementations§
Source§impl ListViewer for DirListBox
impl ListViewer for DirListBox
Source§fn get_text(&self, item: i32) -> String
fn get_text(&self, item: i32) -> String
Return the display string for item item — the entry’s stored
DirEntry::display_text, which may carry tree-glyph prefixes.
Called on every redraw by the shared list-viewer draw routine. Returns
an empty string for out-of-bounds indices (never panics). Callers that
need the raw path should call DirListBox::focused_entry instead.
Source§fn is_selected(&self, item: i32) -> bool
fn is_selected(&self, item: i32) -> bool
Return true when item is the current-directory ancestor entry.
Overrides the default (which would highlight only the cursor): the dir
list keeps the cursor on the ancestor entry (cur) even while the user
browses subdirs, so the current directory is always visually distinct
from the item under the cursor. Set by new_directory; moves only on a
confirmed directory change.
Source§fn select_item(&mut self, _item: i32, ctx: &mut Context<'_>)
fn select_item(&mut self, _item: i32, ctx: &mut Context<'_>)
Selecting an item (double-click / Enter) posts a change-directory command
(Command::CHANGE_DIR) to the
owning dialog.
The command is payload-less: the dialog re-reads the focused entry itself.
Selection always follows focus (the list focuses an item before selecting
it), so focused == item here and the dialog reads the same entry.
Source§fn lv(&self) -> &ListViewerState
fn lv(&self) -> &ListViewerState
ListViewerState.Source§fn lv_mut(&mut self) -> &mut ListViewerState
fn lv_mut(&mut self) -> &mut ListViewerState
ListViewerState.Source§fn list_roles(&self) -> ListRoles
fn list_roles(&self) -> ListRoles
Source§fn item_role(&self, _item: i32) -> Option<Role>
fn item_role(&self, _item: i32) -> Option<Role>
Role for a normal row — one that is neither
the focused cursor item nor selected. Only the role’s foreground is
used: the row keeps the list’s surface background, so a tinted row
still reads as part of the list. None (the default) keeps the plain
surface colour. A table uses it to tint a whole row (a dimmed or an
error row); the focused and selected colours always win over it.Source§fn on_focus_changed(&mut self, _ctx: &mut Context<'_>)
fn on_focus_changed(&mut self, _ctx: &mut Context<'_>)
focus_item free fn
calls this after moving focused (and adjusting top_item), so an
override fires on EVERY focus change (keyboard, mouse, scrollbar sync, …).
Default: no-op. A file list overrides it to broadcast that the focused
file changed.Source§fn find_query(&self) -> Option<&str>
fn find_query(&self) -> Option<&str>
None when find mode is Off or
the query is empty. The shared draw reads this to highlight matches;
hosts read it to mirror the query elsewhere.Source§fn set_find_query(&mut self, query: &str, ctx: &mut Context<'_>)
fn set_find_query(&mut self, query: &str, ctx: &mut Context<'_>)
InputLine that
owns the text and drives an unfocused list’s incremental find (a combobox).
The mirror image of typed find, minus the keystrokes: a whole-string setter
because a text source always holds the complete string. Read moreSource§fn clear_find(&mut self, ctx: &mut Context<'_>)
fn clear_find(&mut self, ctx: &mut Context<'_>)
set_find_query("", ctx): no-op when find is Off or already empty,
else fires Command::LIST_FIND_CHANGED and runs Self::on_query_changed.Source§fn on_query_changed(&mut self, _ctx: &mut Context<'_>)
fn on_query_changed(&mut self, _ctx: &mut Context<'_>)
handle_event and by Self::set_find_query
(including Self::clear_find).Source§impl View for DirListBox
impl View for DirListBox
Source§fn handle_event(&mut self, ev: &mut Event, ctx: &mut Context<'_>)
fn handle_event(&mut self, ev: &mut Event, ctx: &mut Context<'_>)
Dispatch mouse and keyboard events to the shared list-viewer handler.
Handles arrow keys, Page Up/Down, Home/End, and mouse clicks/drags to
move the cursor through the directory tree. A double-click or Enter fires
select_item,
which posts Command::CHANGE_DIR to the owning dialog. The event loop
drives this; callers do not call it directly.
Source§fn set_state(&mut self, flag: StateFlag, enable: bool, ctx: &mut Context<'_>)
fn set_state(&mut self, flag: StateFlag, enable: bool, ctx: &mut Context<'_>)
On a focus change the dir list grabs the dialog’s default button when it gains focus and releases it when it loses focus.
The leaf list cannot poke its sibling button directly, so it requests the
change through the pump’s
MakeButtonDefault broker via
Context::make_button_default. chdir_button is None when there is no
change-directory owner, so this is then a no-op.
Source§fn on_bounds_changed(&mut self, ctx: &mut Context<'_>)
fn on_bounds_changed(&mut self, ctx: &mut Context<'_>)
Republish the scrollbar range on resize.
Source§fn value(&self) -> Option<FieldValue>
fn value(&self) -> Option<FieldValue>
The view’s value is its focused item index (same as a plain list box).
Source§fn draw(&mut self, ctx: &mut DrawCtx<'_>)
fn draw(&mut self, ctx: &mut DrawCtx<'_>)
ctx. Must be overridden. Read moreSource§fn cursor_request(&self) -> Option<Point>
fn cursor_request(&self) -> Option<Point>
None to
hide it. Base: Some(cursor) iff the view is focused with a visible cursor,
else None. Read moreSource§fn apply_scroll_sync(
&mut self,
h: Option<i32>,
v: Option<i32>,
ctx: &mut Context<'_>,
)
fn apply_scroll_sync( &mut self, h: Option<i32>, v: Option<i32>, ctx: &mut Context<'_>, )
None if that bar
is absent or unresolved), each read via View::value. Overridden by the
list viewers (delegate to
list_viewer::apply_scroll),
Scroller, the outline viewer, and the editor —
every sibling-scrollbar read sync routes through this one method instead of
a pump downcast. Read moreSource§fn as_any_mut(&mut self) -> Option<&mut dyn Any>
fn as_any_mut(&mut self) -> Option<&mut dyn Any>
None;
only views that must be reached concretely override it. (Any requires
'static, which every view is.)Source§fn valid(&mut self, _cmd: Command, _ctx: &mut Context<'_>) -> bool
fn valid(&mut self, _cmd: Command, _ctx: &mut Context<'_>) -> bool
cmd (e.g. a modal end / focus
release). Base is always true. Read moreSource§fn set_modal_answer(&mut self, _cmd: Command)
fn set_modal_answer(&mut self, _cmd: Command)
Context::request_message_box (the
answer_to/RouteModalAnswer round-trip). Default: no-op. Overridden by
views that drive a Yes/No/Cancel prompt out of valid (e.g.
FileEditor caches it for the re-validate).Source§fn set_value(&mut self, _v: FieldValue)
fn set_value(&mut self, _v: FieldValue)
FieldValue into this control. Read moreSource§fn set_modal_data(&mut self, _data: FieldValue)
fn set_modal_data(&mut self, _data: FieldValue)
Source§fn set_value_ctx(&mut self, v: FieldValue, ctx: &mut Context<'_>)
fn set_value_ctx(&mut self, v: FieldValue, ctx: &mut Context<'_>)
FieldValue into this control with a Context. Default:
calls set_value (the context-free setter). Override
when scatter needs deferred publishing (e.g.
ListBox republishes its vertical scrollbar via
focus_item).Source§fn awaken(&mut self)
fn awaken(&mut self)
Source§fn calc_bounds(&mut self, owner_size: Point, delta: Point) -> Rect
fn calc_bounds(&mut self, owner_size: Point, delta: Point) -> Rect
owner_size (delta = new - old). Computes the size limits via the overridable
size_limits hook — so a widget override (e.g. a
window’s minimum) participates — then delegates the grow math to
ViewState::calc_bounds (the single source). Returns the bounds; it does
not apply them (change_bounds does).Source§fn change_bounds(&mut self, bounds: Rect)
fn change_bounds(&mut self, bounds: Rect)
bounds to this view and propagate as needed. Read moreSource§fn caret_size(&self) -> u8
fn caret_size(&self) -> u8
CARET_INSERT (a block) when the
cursor_ins state is set, else
CARET_NORMAL (the normal caret).
The event loop reads it along the same focused chain as
cursor_request;
Group overrides it to descend into its current
child. Read moreSource§fn find_mut(&mut self, id: ViewId) -> Option<&mut dyn View>
fn find_mut(&mut self, id: ViewId) -> Option<&mut dyn View>
id to a descendant of this view (never self — the parent
identifies a view by id). A leaf has no descendants, so the base returns
None; a Group overrides to search its children
and recurse; a Group-embedding view delegates to its inner group. This is
the “tree-walk via Context” — the uniform way the event loop
/ a capture handler acts on a view it holds only by id (move a window’s
bounds, flip the dragging flag, …).Source§fn remove_descendant(&mut self, id: ViewId, ctx: &mut Context<'_>) -> bool
fn remove_descendant(&mut self, id: ViewId, ctx: &mut Context<'_>) -> bool
id from whichever group owns it.
Returns true if it was found+removed. Distinct
from find_mut because removal happens in the owner’s
child Vec (a view cannot remove itself — it doesn’t know its owner)
and must run the owning group’s reset_current. Base: false (a leaf owns
nothing).Source§fn focus_descendant(&mut self, id: ViewId, ctx: &mut Context<'_>) -> bool
fn focus_descendant(&mut self, id: ViewId, ctx: &mut Context<'_>) -> bool
id within whichever group owns it
— the tree-op behind a label focusing its linked control. Returns true
if id was found in this subtree (selectable or not — finding it stops the
walk). Distinct from find_mut because focusing happens in
the owning group (a view cannot select itself within itself): the
owning Group calls focus_child after applying the
selectable gate. Base: false (a leaf owns nothing). Read moreSource§fn has_focusable_leaf(&self) -> bool
fn has_focusable_leaf(&self) -> bool
Group
overrides to recurse into children; wrapper views delegate. Used by the
hierarchical Tab traversal to skip selectable-but-empty subtrees.Source§fn focus_to_edge(&mut self, backward: bool, ctx: &mut Context<'_>) -> bool
fn focus_to_edge(&mut self, backward: bool, ctx: &mut Context<'_>) -> bool
backward = false) or last (Shift-Tab,
backward = true) focusable leaf in this view’s subtree, establishing the
full focus path down to it. Returns true if a focusable leaf was focused. Read moreSource§fn reset_current(&mut self, _ctx: &mut Context<'_>)
fn reset_current(&mut self, _ctx: &mut Context<'_>)
Group::insert, so
exec_view calls this on a freshly-inserted modal BEFORE focusing it, so
the modal’s first selectable child is current on open (otherwise the modal
is keyboard-dead until a nav event — see the seam note in exec_view).
Base: no-op (a leaf has no internal currency); Group overrides;
Window/Dialog delegate.Source§fn settle_currency(&mut self, _ctx: &mut Context<'_>)
fn settle_currency(&mut self, _ctx: &mut Context<'_>)
Source§fn set_visible_descendant(
&mut self,
id: ViewId,
visible: bool,
ctx: &mut Context<'_>,
) -> bool
fn set_visible_descendant( &mut self, id: ViewId, visible: bool, ctx: &mut Context<'_>, ) -> bool
visible flag of the descendant named by id from its
OWNING group, running the owning group’s currency tail. Toggling
visibility on a selectable view re-picks the owner’s current child, in both
directions (show and hide). Returns true if id was found in this
subtree. Read moreSource§fn number(&self) -> Option<i16>
fn number(&self) -> Option<i16>
None);
Window overrides to return its number when > 0
(0 means unnumbered → None).Source§fn grabs_focus_on_click(&self) -> bool
fn grabs_focus_on_click(&self) -> bool
Group::route_event). Default true (the common case); a
Button overrides to return its grab-focus flag.
A view returning false is not focused by a click but still
receives the click (so it can act, e.g. press, without becoming the
current view).Source§fn select_window_num(&mut self, num: i16, ctx: &mut Context<'_>) -> bool
fn select_window_num(&mut self, num: i16, ctx: &mut Context<'_>) -> bool
num. Returns
whether one matched. Consistent with the find_mut /
remove_descendant tree-op family: the live
loop holds a subtree only by id (here, the desktop) and asks it to act.
Default: no-op (false). Desktop overrides.Source§fn tile(&mut self, _r: Rect)
fn tile(&mut self, _r: Rect)
Desktop lays out
windows). r is the desktop-local layout rect. Mirrors
select_window_num: the live loop drives the
desktop by id through &mut dyn View.Source§fn cascade(&mut self, _r: Rect)
fn cascade(&mut self, _r: Rect)
Desktop overrides.menu::menu_view::update_menu_commands
implements the re-gray walk. Read moreMenuBar / MenuBox)
override to set their
MenuViewState::current — the write-only
display cache their draw reads to pick the selected colour. Read moreSource§fn get_help_ctx(&self) -> HelpCtx
fn get_help_ctx(&self) -> HelpCtx
HelpCtx::DRAGGING while the view is being dragged, otherwise the
view’s own ViewState::help_ctx. Read moreSource§fn descendant_global_bounds(&self, _id: ViewId, _acc: Point) -> Option<Rect>
fn descendant_global_bounds(&self, _id: ViewId, _acc: Point) -> Option<Rect>
id to its absolute bounds, given acc = this
view’s own absolute origin. Base returns None (a leaf owns no
descendants); a Group overrides to walk its children
accumulating origins, and a Group-embedding view delegates to its inner
group. The THistory open path needs its linked
input line’s bounds in the root/absolute frame, because exec_view
root-inserts the modal and the modal frame hit-tests in absolute coords (the
documented ROOT-INSERT + (0,0) caveat). Mirrors
find_mut’s recursion but returns geometry, not a borrow.Source§fn set_indicator_value(&mut self, _location: Point, _modified: bool)
fn set_indicator_value(&mut self, _location: Point, _modified: bool)
Indicator overrides it to store the new
cursor location + modified flag. Driven by
Deferred::IndicatorSetValue:
the editor (a leaf) cannot reach its indicator sibling inline, so it requests
this and the pump calls the method by id — virtual dispatch, not a downcast.Source§fn apply_page_sync(&mut self, _idx: usize, _ctx: &mut Context<'_>)
fn apply_page_sync(&mut self, _idx: usize, _ctx: &mut Context<'_>)
PageStack overrides it to make page idx
active. Driven by
Deferred::PageStackSync: the pump
reads the bound tab bar’s value and calls this method by id — virtual
dispatch, not a downcast.Auto Trait Implementations§
impl Freeze for DirListBox
impl RefUnwindSafe for DirListBox
impl Send for DirListBox
impl Sync for DirListBox
impl Unpin for DirListBox
impl UnsafeUnpin for DirListBox
impl UnwindSafe for DirListBox
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.