ibus-qt  1.3.2
 All Classes Namespaces Functions Enumerations Enumerator
Signals | Public Member Functions | List of all members
IBus::Engine Class Reference
Inheritance diagram for IBus::Engine:
IBus::Object

Signals

void CommitText (const QDBusVariant &text)
 
void CursorDownLookupTable ()
 
void CursorUpLookupTable ()
 
void ForwardKeyEvent (uint keyval, uint keycode, uint state)
 
void HideAuxiliaryText ()
 
void HideLookupTable ()
 
void HidePreeditText ()
 
void PageDownLookupTable ()
 
void PageUpLookupTable ()
 
void RegisterProperties (const QDBusVariant &props)
 
void ShowAuxiliaryText ()
 
void ShowLookupTable ()
 
void ShowPreeditText ()
 
void UpdateAuxiliaryText (const QDBusVariant &text, bool visible)
 
void UpdateLookupTable (const QDBusVariant &lookup_table, bool visible)
 
void UpdatePreeditText (const QDBusVariant &text, uint cursor_pos, bool visible, uint mode)
 
void UpdateProperty (const QDBusVariant &prop)
 

Public Member Functions

 Engine (const QString &engineName)
 Constructor of Engine object. More...
 
virtual ~Engine ()
 Destructor of Engine object. More...
 
const QString & engineName () const
 Gets name of the engine object. More...
 
void updateLookupTableFast (const LookupTablePointer &lookupTable, bool visible)
 Updates the lookup table in fast mode, it only sends candidates in current page. More...
 
void commitText (const TextPointer &text)
 Commits text to client application. More...
 
void cursorDownLookupTable ()
 Moves down the cursor of lookup table. More...
 
void cursorUpLookupTable ()
 Moves up the cursor of lookup table. More...
 
void forwardKeyEvent (uint keyval, uint keycode, uint state)
 Forwards keyevents to client application. More...
 
void hideAuxiliaryText ()
 Hides the auxiliary text in UI. More...
 
void hideLookupTable ()
 Hides the lookup table in UI. More...
 
void hidePreeditText ()
 Hides the preedit text in UI. More...
 
void pageDownLookupTable ()
 Page down the lookup table. More...
 
void pageUpLookupTable ()
 Page up the lookup table. More...
 
void registerProperties (const PropListPointer &props)
 Registers properties. More...
 
void showAuxiliaryText ()
 Shows the auxiliary text in UI. More...
 
void showLookupTable ()
 Shows the lookup table in UI. More...
 
void showPreeditText ()
 Shows the preedit text in UI. More...
 
void updateAuxiliaryText (const TextPointer &text, bool visible)
 Updates the auxiliary text. More...
 
void updateLookupTable (const LookupTablePointer &lookupTable, bool visible)
 Updates the lookup table. More...
 
void updatePreeditText (const TextPointer &text, uint cursorPos, bool visible, uint mode=EnginePreeditClear)
 Updates the preedit text. More...
 
void updateProperty (const PropertyPointer &prop)
 Updates the property. More...
 
virtual void candidateClicked (uint index, uint button, uint state)
 Candidate is clicked. More...
 
virtual void cursorDown ()
 Cursor is moved down. More...
 
virtual void cursorUp ()
 Cursor is moved up. More...
 
virtual void destroy ()
 Destroy the object. More...
 
virtual void disable ()
 Disables the engine. More...
 
virtual void enable ()
 Enables the engine. More...
 
virtual void focusIn ()
 Sets the focus of the engine. More...
 
virtual void focusOut ()
 Unsets the focus of the engine. More...
 
virtual void pageDown ()
 Moves cursor of lookup table to next page. More...
 
virtual void pageUp ()
 Moves cursor of lookup tabele to previous page. More...
 
virtual bool processKeyEvent (uint keyval, uint keycode, uint state)
 Moves cursor of lookup tabele to previous page. More...
 
virtual void propertyActivate (const QString &prop_name, int prop_state)
 The property with given name is clicked. More...
 
virtual void propertyHide (const QString &prop_name)
 Hides the property with given name. More...
 
virtual void propertyShow (const QString &prop_name)
 Shows the property with given name. More...
 
virtual void reset ()
 Resets the engine. More...
 
virtual void setCapabilities (uint cap)
 Sets the capabilities from client application. More...
 
virtual void setCursorLocation (int x, int y, int w, int h)
 Sets the cursor location from client applicaion. More...
 
- Public Member Functions inherited from IBus::Object
virtual ~Object ()
 Destructor of Object. More...
 

Constructor & Destructor Documentation

IBus::Engine::Engine ( const QString &  engineName)

Constructor of Engine object.

Returns
IBus::Engine::~Engine ( )
virtual

Destructor of Engine object.

Returns

Member Function Documentation

void IBus::Engine::candidateClicked ( uint  index,
uint  button,
uint  state 
)
virtual

Candidate is clicked.

Implement this virtual function to handle candidate clicked event.

Parameters
[in]indexThe index of candidate clicked
[in]buttonThe button of the clicked event.
[in]stateThe current state of keyboard.
Returns
void IBus::Engine::commitText ( const TextPointer text)
inline

Commits text to client application.

Parameters
[in]textA text object.
Returns
void IBus::Engine::CommitText ( const QDBusVariant &  text)
signal

FIXME need hide signals in doxygen

void IBus::Engine::cursorDown ( )
virtual

Cursor is moved down.

Returns
void IBus::Engine::cursorDownLookupTable ( )
inline

Moves down the cursor of lookup table.

Returns
void IBus::Engine::cursorUp ( )
virtual

Cursor is moved up.

Returns
void IBus::Engine::cursorUpLookupTable ( )
inline

Moves up the cursor of lookup table.

Returns
void IBus::Engine::destroy ( void  )
virtual

Destroy the object.

Returns

Reimplemented from IBus::Object.

void IBus::Engine::disable ( )
virtual

Disables the engine.

Returns
void IBus::Engine::enable ( )
virtual

Enables the engine.

Returns
const QString & IBus::Engine::engineName ( ) const

Gets name of the engine object.

Returns
The name of the engine object.
void IBus::Engine::focusIn ( )
virtual

Sets the focus of the engine.

Returns
void IBus::Engine::focusOut ( )
virtual

Unsets the focus of the engine.

Returns
void IBus::Engine::forwardKeyEvent ( uint  keyval,
uint  keycode,
uint  state 
)
inline

Forwards keyevents to client application.

Parameters
[in]keyval
[in]keycode
[in]state
Returns
void IBus::Engine::hideAuxiliaryText ( )
inline

Hides the auxiliary text in UI.

Returns
void IBus::Engine::hideLookupTable ( )
inline

Hides the lookup table in UI.

Returns
void IBus::Engine::hidePreeditText ( )
inline

Hides the preedit text in UI.

Returns
void IBus::Engine::pageDown ( )
virtual

Moves cursor of lookup table to next page.

Returns
void IBus::Engine::pageDownLookupTable ( )
inline

Page down the lookup table.

Returns
void IBus::Engine::pageUp ( )
virtual

Moves cursor of lookup tabele to previous page.

Returns
void IBus::Engine::pageUpLookupTable ( )
inline

Page up the lookup table.

Returns
bool IBus::Engine::processKeyEvent ( uint  keyval,
uint  keycode,
uint  state 
)
virtual

Moves cursor of lookup tabele to previous page.

Parameters
[in]keyvalThe keyval of the key event.
[in]keycodeThe keycode of the key event.
[in]stateThe modifiers of the key event.
Returns
If engine returns true, the client application will ignore this key event, otherwise client application will continue process this key event.
void IBus::Engine::propertyActivate ( const QString &  prop_name,
int  prop_state 
)
virtual

The property with given name is clicked.

Parameters
[in]prop_nameThe name of the property.
[in]prop_stateThe state of the property.
Returns
void IBus::Engine::propertyHide ( const QString &  prop_name)
virtual

Hides the property with given name.

Parameters
[in]prop_nameThe name of the property.
Returns
void IBus::Engine::propertyShow ( const QString &  prop_name)
virtual

Shows the property with given name.

Parameters
[in]prop_nameThe name of the property.
Returns
void IBus::Engine::registerProperties ( const PropListPointer props)
inline

Registers properties.

Parameters
[in]propsA PropList object contains some properties.
Returns
void IBus::Engine::reset ( void  )
virtual

Resets the engine.

Returns
void IBus::Engine::setCapabilities ( uint  cap)
virtual

Sets the capabilities from client application.

Parameters
[in]capThe capabilities of client application.
Returns
void IBus::Engine::setCursorLocation ( int  x,
int  y,
int  w,
int  h 
)
virtual

Sets the cursor location from client applicaion.

Parameters
[in]x
[in]y
[in]w
[in]h
Returns
void IBus::Engine::showAuxiliaryText ( )
inline

Shows the auxiliary text in UI.

Returns
void IBus::Engine::showLookupTable ( )
inline

Shows the lookup table in UI.

Returns
void IBus::Engine::showPreeditText ( )
inline

Shows the preedit text in UI.

Returns
void IBus::Engine::updateAuxiliaryText ( const TextPointer text,
bool  visible 
)
inline

Updates the auxiliary text.

Parameters
[in]textA text object.
[in]visibleWhether the auxiliary text is visible.
Returns
void IBus::Engine::updateLookupTable ( const LookupTablePointer lookupTable,
bool  visible 
)
inline

Updates the lookup table.

Parameters
[in]lookupTableA lookup table object.
[in]visibleWhether the lookup table is visible.
Returns
void IBus::Engine::updateLookupTableFast ( const LookupTablePointer lookupTable,
bool  visible 
)

Updates the lookup table in fast mode, it only sends candidates in current page.

Parameters
[in]lookupTableA lookup table object.
[in]visibleWhether the lookup table is visible.
Returns
void IBus::Engine::updatePreeditText ( const TextPointer text,
uint  cursorPos,
bool  visible,
uint  mode = EnginePreeditClear 
)
inline

Updates the preedit text.

Parameters
[in]textA text object.
[in]cursorPosThe cursor position in the given text.
[in]visibleWhether the preedit text is visible.
[in]modepreedit focus mode.
Returns
void IBus::Engine::updateProperty ( const PropertyPointer prop)
inline

Updates the property.

Parameters
[in]propA propeerty object
Returns

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