Fcitx
Public Member Functions | List of all members
fcitx::KeyEvent Class Reference
Inheritance diagram for fcitx::KeyEvent:
Inheritance graph
[legend]
Collaboration diagram for fcitx::KeyEvent:
Collaboration graph
[legend]

Public Member Functions

 KeyEvent (InputContext *context, Key rawKey, bool isRelease=false, int time=0)
 
void filter ()
 
bool filtered () const override
 Whether a event is filtered by handler. More...
 
void filterAndAccept ()
 
- Public Member Functions inherited from fcitx::KeyEventBase
 KeyEventBase (EventType type, InputContext *context, Key rawKey, bool isRelease=false, int time=0)
 
 KeyEventBase (const KeyEventBase &)=default
 
Key key () const
 Normalized key event. More...
 
void setKey (const Key &key)
 It will automatically be called if input method layout does not match the system keyboard layout. More...
 
void setRawKey (const Key &key)
 It is designed for faking the key event. More...
 
void setForward (bool forward)
 It is designed for overriding the key forward option. More...
 
Key origKey () const
 Key event regardless of keyboard layout conversion. More...
 
Key rawKey () const
 Key event after layout conversion. More...
 
bool isRelease () const
 
int time () const
 
bool forward () const
 If true, the key that produce character will commit a string. More...
 
- Public Member Functions inherited from fcitx::InputContextEvent
 InputContextEvent (InputContext *context, EventType type)
 
InputContextinputContext () const
 
- Public Member Functions inherited from fcitx::Event
 Event (EventType type)
 
EventType type () const
 Type of event, can be used to decide event class. More...
 
void accept ()
 
bool accepted () const
 Return value used by Instance::postEvent. More...
 
bool isInputContextEvent () const
 A helper function to check if a event is input context event. More...
 

Additional Inherited Members

- Protected Attributes inherited from fcitx::KeyEventBase
Key key_
 
Key origKey_
 
Key rawKey_
 
bool isRelease_
 
int time_
 
bool forward_ = false
 
- Protected Attributes inherited from fcitx::InputContextEvent
InputContextic_
 
- Protected Attributes inherited from fcitx::Event
EventType type_
 
bool accepted_ = false
 

Detailed Description

Definition at line 312 of file event.h.

Member Function Documentation

◆ filtered()

bool fcitx::KeyEvent::filtered ( ) const
inlineoverridevirtual

Whether a event is filtered by handler.

If event is filtered, it will not send to another handler. For now only keyevent from input context can be filtered.

Returns
bool

Reimplemented from fcitx::Event.

Definition at line 320 of file event.h.


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