Struct SuggestionList 

pub struct SuggestionList { /* private fields */ }

A floating list of suggestions under (or, without room, above) an anchor: the one list behind Autocomplete and a code editor’s caret completion.

It is a floating Panel (surface::panel, radii.panel, the floating shadow) placed by floating_surface::place_anchored, so it flips above its anchor near the window’s bottom and shifts to stay inside it. Rows are menu rows with the armed-row lift, an optional leading icon and an optional trailing detail column. More suggestions than fit scroll, the armed row always in view. A status line (and a spinner while busy) stands in for rows while there are none.

Implementations

impl SuggestionList

pub fn new() -> SuggestionList

pub fn with_text_role(self, role: TextRole) -> SuggestionList

Set the rows’ labels in role (a code completion’s labels are Code).

pub fn with_max_visible(self, rows: usize) -> SuggestionList

Rows beyond this scroll instead of growing the panel.

pub fn set_text_role(&mut self, role: TextRole)

Set the rows’ label role; see Self::with_text_role.

pub fn set_suggestions(&mut self, suggestions: Vec<Suggestion>)

Replace the suggestions. Keeps the armed row when it still exists and clears the status line once there are rows.

pub fn suggestions(&self) -> &[Suggestion]

pub fn highlight(&self) -> Option<usize>

The armed row’s index.

pub fn highlighted(&self) -> Option<&Suggestion>

pub fn set_highlight(&mut self, index: Option<usize>)

Arm row index (clamped; None disarms) and scroll it into view.

pub fn move_highlight(&mut self, forward: bool)

Arm the next (or previous) row, wrapping at both ends.

pub fn set_status(&mut self, status: Option<String>)

A line shown while there are no rows (“Searching…”, “No matches”); None clears it.

pub fn set_busy(&mut self, busy: bool)

Results are on their way: the status line carries a spinner.

pub fn is_busy(&self) -> bool

pub fn set_anchor(&mut self, anchor: Rect)

The rect the list opens from (a field, or the caret’s line).

pub fn set_viewport(&mut self, viewport: Rect)

The bounds the list stays inside, normally the window.

pub fn has_content(&self) -> bool

Whether there is anything to show: rows, a status line or a spinner.

pub fn clear(&mut self)

Clear rows, status and armed row.

pub fn rect(&self) -> Option<Rect>

The panel’s rect: under the anchor, or above it when there is more room there, inside the viewport. None with nothing to show.

pub fn row_rect(&self, index: usize) -> Option<Rect>

The rect of suggestion index, when it is in view.

pub fn row_at(&self, point: Point) -> Option<usize>

The suggestion under point, if any.

pub fn hover_at(&mut self, point: Point) -> bool

Track the pointer for the hover lift; returns whether it changed.

pub fn scroll_by(&mut self, rows: i32)

Scroll by rows (positive scrolls down), within the rows.

pub fn paint( &mut self, scene: &mut Scene, transform: Affine, text: &mut TextRenderer, theme: &Theme, )

Paint the list in the window’s top layer.

Trait Implementations

impl Default for SuggestionList

fn default() -> SuggestionList

Returns the “default value” for a type.