Fcitx
Public Member Functions | List of all members
fcitx::InputPanel Class Reference

Input Panel is usually a floating window that is display at the cursor of input. More...

#include <fcitx/inputpanel.h>

Public Member Functions

 InputPanel (InputContext *ic)
 Construct a Input Panel associated with given input context.
 
const Textpreedit () const
 
void setPreedit (const Text &text)
 
const TextauxUp () const
 
void setAuxUp (const Text &text)
 
const TextauxDown () const
 
void setAuxDown (const Text &text)
 
const TextclientPreedit () const
 The preedit text embedded in client window.
 
void setClientPreedit (const Text &clientPreedit)
 
std::shared_ptr< CandidateListcandidateList () const
 
void setCandidateList (std::unique_ptr< CandidateList > candidate)
 
const CustomInputPanelCallback & customInputPanelCallback () const
 Return the current input panel display callback. More...
 
void setCustomInputPanelCallback (CustomInputPanelCallback callback)
 Set a custom callback to display the input panel. More...
 
const CustomInputPanelCallback & customVirtualKeyboardCallback () const
 
void setCustomVirtualKeyboardCallback (CustomInputPanelCallback callback)
 
void reset ()
 
bool empty () const
 Whether input panel is totally empty.
 

Detailed Description

Input Panel is usually a floating window that is display at the cursor of input.

But it can also be a embedded fixed window. The actual representation is implementation-defined. In certain cases, all the information input panel is forwarded to client and will be drawn by client.

A common input panel is shown as

Aux Up Preedit
Aux down Candidate 1, 2..

Or

Aux Up Preedit
Aux down
Candidate 1
Candidate 2
...
Candidate n

Definition at line 48 of file inputpanel.h.


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