#include <scim_panel.h>
This class acts like a stand alone SocketServer. It has its own dedicated main loop, and will be blocked when run () is called. So run () must be called within a separated thread, in order to not block the main loop of the Panel program itself.
Before calling run (), the panel must hook the callback functions to the corresponding signals.
Note that, there are two special signals: lock(void) and unlock(void). These two signals are used to provide a thread lock to PanelAgent, so that PanelAgent can run correctly within a multi-threading Panel program.
|
|
|
|
|
Initialize this PanelAgent.
|
|
Check if this PanelAgent is initialized correctly and ready to run.
|
|
Run this PanelAgent. This method has its own dedicated main loop, so it should be run in a separated thread.
|
|
Stop this PanelAgent.
|
|
Get the list of all helpers. Panel program should provide a menu which contains all stand alone but not auto start Helpers, so that users can activate the Helpers by clicking in the menu. All auto start Helpers should be started by Panel after running PanelAgent by calling PanelAgent::start_helper().
|
|
Let the focused IMEngineInstance object move the preedit caret.
|
|
Request help information from the focused IMEngineInstance object.
|
|
Request factory menu from the focused FrontEnd.
|
|
Change the factory used by the focused IMEngineInstance object.
|
|
Let the focused IMEngineInstance object select a candidate in current lookup table.
|
|
Let the focused IMEngineInstance object flip the LookupTable to previous page.
|
|
Let the focused IMEngineInstance object flip the LookupTable to next page.
|
|
Let the focused IMEngineInstance object update the page size of the LookupTable.
|
|
Trigger a property of the focused IMEngineInstance object.
|
|
Trigger a property of a Helper object.
|
|
Start a stand alone helper.
|
|
Let all FrontEnds and Helpers reload configuration.
|
|
Let all FrontEnds, Helpers and this Panel exit.
|
|
Signal: Reload configuration. When a Helper object send a RELOAD_CONFIG event to this Panel, this signal will be emitted. Panel should reload all configuration here. |
|
Signal: Turn on. slot prototype: void turn_on (void); |
|
Signal: Turn off. slot prototype: void turn_off (void); |
|
Signal: Update screen. slot prototype: void update_screen (int screen); |
|
Signal: Update spot location. slot prototype: void update_spot_location (int x, int y); |
|
Signal: Update factory information. slot prototype: void update_factory_info (const PanelFactoryInfo &info); |
|
Signal: Show help. slot prototype: void show_help (const String &help); |
|
Signal: Show factory menu. slot prototype: void show_factory_menu (const std::vector <panelfactoryinfo> &menu); |
|
Signal: Show preedit string. slot prototype: void show_preedit_string (void): |
|
Signal: Show aux string. slot prototype: void show_aux_string (void): |
|
Signal: Show lookup table. slot prototype: void show_lookup_table (void): |
|
Signal: Hide preedit string. slot prototype: void hide_preedit_string (void); |
|
Signal: Hide aux string. slot prototype: void hide_aux_string (void); |
|
Signal: Hide lookup table. slot prototype: void hide_lookup_table (void); |
|
Signal: Update preedit string. slot prototype: void update_preedit_string (const String &str, const AttributeList &attrs);
|
|
Signal: Update preedit caret. slot prototype: void update_preedit_caret (int caret); |
|
Signal: Update aux string. slot prototype: void update_aux_string (const String &str, const AttributeList &attrs);
|
|
Signal: Update lookup table. slot prototype: void update_lookup_table (const LookupTable &table);
|
|
Signal: Register properties. Register properties of the focused instance. slot prototype: void register_properties (const PropertyList &props);
|
|
Signal: Update property. Update a property of the focused instance. slot prototype: void update_property (const Property &prop);
|
|
Signal: Register properties of a helper. slot prototype: void register_helper_properties (int id, const PropertyList &props);
|
|
Signal: Update helper property. slot prototype: void update_helper_property (int id, const Property &prop);
|
|
Signal: Register a helper object. A newly started helper object will send this event to Panel. slot prototype: register_helper (int id, const HelperInfo &helper);
|
|
Signal: Remove a helper object. If a running helper close its connection to Panel, then this signal will be triggered to tell Panel to remove all data associated to this helper. slot prototype: void remove_helper (int id);
|
|
Signal: Lock the exclusive lock for this PanelAgent. The panel program should provide a thread lock and hook a slot into this signal to lock it. PanelAgent will use this lock to ensure the data integrity. slot prototype: void lock (void); |
|
Signal: Unlock the exclusive lock for this PanelAgent. slot prototype: void unlock (void); |