Fcitx
Public Member Functions | Protected Attributes | List of all members
fcitx::Event Class Reference

Base class for fcitx event. More...

#include <fcitx/event.h>

Inheritance diagram for fcitx::Event:
Inheritance graph
[legend]

Public Member Functions

 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...
 
virtual bool filtered () const
 Whether a event is filtered by handler. More...
 
bool isInputContextEvent () const
 A helper function to check if a event is input context event. More...
 

Protected Attributes

EventType type_
 
bool accepted_ = false
 

Detailed Description

Base class for fcitx event.

Definition at line 176 of file event.h.

Member Function Documentation

◆ accepted()

bool fcitx::Event::accepted ( ) const
inline

Return value used by Instance::postEvent.

See also
Instance::postEvent
Returns
bool

Definition at line 195 of file event.h.

◆ filtered()

virtual bool fcitx::Event::filtered ( ) const
inlinevirtual

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 in fcitx::CheckUpdateEvent, fcitx::InvokeActionEvent, and fcitx::KeyEvent.

Definition at line 205 of file event.h.

◆ isInputContextEvent()

bool fcitx::Event::isInputContextEvent ( ) const
inline

A helper function to check if a event is input context event.

Returns
bool

Definition at line 212 of file event.h.

◆ type()

EventType fcitx::Event::type ( ) const
inline

Type of event, can be used to decide event class.

Returns
fcitx::EventType

Definition at line 186 of file event.h.


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