CandidateList

---

Object Hierarchy:

Description:

Content:

Properties:

• public abstract int cursor_pos { get; }
  Current cursor position.
• public abstract uint page_size { get; set; }
  Page size.
• public abstract uint page_start { get; set; }
  Starting index of paging.
• public abstract bool page_visible { get; }
  Flag to indicate whether page (lookup table) is visible.
• public abstract int size { get; }
  The number of candidate in the candidate list.

Methods:

• public abstract Candidate @get (int index = -1)
  Get the current candidate at the given index.
• public abstract bool cursor_down ()
  Move cursor to the next candidate.
• public abstract bool cursor_up ()
  Move cursor to the previous candidate.
• public virtual bool next ()
  Move cursor forward.
• public abstract bool page_down ()
  Move cursor to the next page.
• public abstract bool page_up ()
  Move cursor to the previous page.
• public virtual bool previous ()
  Move cursor backward.
• public abstract void select ()
  Select the current candidate.
• public abstract bool select_at (uint index_in_page)
  Select a candidate in the current page.

Signals:

• public signal void populated ()
  Signal emitted when candidates are filled and ready for traversal.
• public signal void selected (Candidate candidate)
  Signal emitted when a candidate is selected.

Inherited Members: