Fcitx
Public Member Functions | List of all members
fcitx::TabbedCandidateList Class Referenceabstract

Interface for tab-related actions on candidate list. More...

#include <fcitx/candidatelist.h>

Public Member Functions

virtual std::span< const CandidateActiontabActions ()=0
 Return a list of tab actions. More...
 
virtual void triggerTabAction (int id)=0
 Trigger the tab action based on the index returned from tabActions. More...
 

Detailed Description

Interface for tab-related actions on candidate list.

Since
5.1.20

Definition at line 274 of file candidatelist.h.

Member Function Documentation

◆ tabActions()

virtual std::span<const CandidateAction> fcitx::TabbedCandidateList::tabActions ( )
pure virtual

Return a list of tab actions.

From UI perspective, the returned vector is expected to be small (less than 10). The text should at most be 6 latin-letters or 2 Chinese characters.

The return value is only valid at the time the function is called. The caller should not keep reference.

The implementatino can choose lazily construct the return value upon calling the function.

Returns
vector of CandidateAction.
Since
5.1.20

◆ triggerTabAction()

virtual void fcitx::TabbedCandidateList::triggerTabAction ( int  id)
pure virtual

Trigger the tab action based on the index returned from tabActions.

Parameters
idaction index.
Since
5.1.20

The documentation for this class was generated from the following files: