Fcitx
|
A common simple candidate list that serves most of the purpose. More...
#include <fcitx/candidatelist.h>
Public Member Functions | |
void | clear () |
void | setLabels (const std::vector< std::string > &labels={}) |
Set the label of candidate list. More... | |
void | setSelectionKey (const KeyList &keyList) |
Set the label of candidate list by key. More... | |
void | setPageSize (int size) |
int | pageSize () const |
void | setLayoutHint (CandidateLayoutHint hint) |
void | setGlobalCursorIndex (int index) |
int | globalCursorIndex () const |
Return Global cursor index. More... | |
void | setCursorIndex (int index) |
Set cursor index on current page. More... | |
const fcitx::Text & | label (int idx) const override |
const CandidateWord & | candidate (int idx) const override |
int | cursorIndex () const override |
int | size () const override |
bool | hasPrev () const override |
bool | hasNext () const override |
void | prev () override |
void | next () override |
bool | usedNextBefore () const override |
int | totalPages () const override |
int | currentPage () const override |
void | setPage (int page) override |
CandidateLayoutHint | layoutHint () const override |
const CandidateWord & | candidateFromAll (int idx) const override |
If idx is out of range, it may raise exception. More... | |
int | totalSize () const override |
It's possible for this function to return -1 if the implement has no clear number how many candidates are available. | |
void | insert (int idx, std::unique_ptr< CandidateWord > word) override |
void | remove (int idx) override |
void | replace (int idx, std::unique_ptr< CandidateWord > word) override |
void | move (int from, int to) override |
void | prevCandidate () override |
void | nextCandidate () override |
void | setCursorIncludeUnselected (bool) |
void | setCursorKeepInSamePage (bool) |
void | setCursorPositionAfterPaging (CursorPositionAfterPaging afterPaging) |
void | setActionableImpl (std::unique_ptr< ActionableCandidateList > actionable) |
Set an optional implemenation of actionable candidate list. More... | |
![]() | |
bool | empty () const |
PageableCandidateList * | toPageable () const |
BulkCandidateList * | toBulk () const |
ModifiableCandidateList * | toModifiable () const |
CursorMovableCandidateList * | toCursorMovable () const |
CursorModifiableCandidateList * | toCursorModifiable () const |
BulkCursorCandidateList * | toBulkCursor () const |
ActionableCandidateList * | toActionable () const |
![]() | |
void | append (std::unique_ptr< CandidateWord > word) |
template<typename CandidateWordType , typename... Args> | |
void | append (Args &&...args) |
Additional Inherited Members | |
![]() | |
void | setPageable (PageableCandidateList *list) |
void | setBulk (BulkCandidateList *list) |
void | setModifiable (ModifiableCandidateList *list) |
void | setCursorMovable (CursorMovableCandidateList *list) |
void | setCursorModifiable (CursorModifiableCandidateList *list) |
void | setBulkCursor (BulkCursorCandidateList *list) |
void | setActionable (ActionableCandidateList *list) |
A common simple candidate list that serves most of the purpose.
Definition at line 264 of file candidatelist.h.
|
overridevirtual |
If idx is out of range, it may raise exception.
Catching the exception is useful to iterate over all candidate list for candidate list has no total size.
Implements fcitx::BulkCandidateList.
Definition at line 620 of file candidatelist.cpp.
int fcitx::CommonCandidateList::globalCursorIndex | ( | ) | const |
Return Global cursor index.
-1 means it is not selected.
Definition at line 610 of file candidatelist.cpp.
void fcitx::CommonCandidateList::setActionableImpl | ( | std::unique_ptr< ActionableCandidateList > | actionable | ) |
Set an optional implemenation of actionable candidate list.
Definition at line 748 of file candidatelist.cpp.
void fcitx::CommonCandidateList::setCursorIndex | ( | int | index | ) |
Set cursor index on current page.
index | index on current page; |
Definition at line 603 of file candidatelist.cpp.
void fcitx::CommonCandidateList::setLabels | ( | const std::vector< std::string > & | labels = {} | ) |
Set the label of candidate list.
The labels less than 10 will be automatically filled with to empty ones up to 10 to be more error prone.
labels | list of labels. |
Definition at line 460 of file candidatelist.cpp.
void fcitx::CommonCandidateList::setSelectionKey | ( | const KeyList & | keyList | ) |
Set the label of candidate list by key.
keyList | list of selection key |
Definition at line 465 of file candidatelist.cpp.