ism/src/isf_info_manager.h

   1 /**
   2  * @file isf_info_manager.h
   3  * @brief Defines scim::InfoManager and their related types.
   4  *
   5  * scim::InfoManager is a class used to write Panel daemons.
   6  * issues.
   7  */
   8
   9 /* ISF is based on SCIM 1.4.7 and extended for supporting more mobile fitable. */
  10
  11 /*
  12  * Smart Common Input Method
  13  *
  14  * Copyright (c) 2004-2005 James Su <suzhe@tsinghua.org.cn>
  15  * Copyright (c) 2012-2016 Samsung Electronics Co., Ltd.
  16  *
  17  *
  18  * This library is free software; you can redistribute it and/or
  19  * modify it under the terms of the GNU Lesser General Public
  20  * License as published by the Free Software Foundation; either
  21  * version 2 of the License, or (at your option) any later version.
  22  *
  23  * This library is distributed in the hope that it will be useful,
  24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  * GNU Lesser General Public License for more details.
  27  *
  28  * You should have received a copy of the GNU Lesser General Public
  29  * License along with this program; if not, write to the
  30  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  31  * Boston, MA  02111-1307  USA
  32  *
  33  * Modifications by Samsung Electronics Co., Ltd.
  34  * 1. Add new signals
  35  *    a. m_signal_set_keyboard_ise and m_signal_get_keyboard_ise
  36  *    b. m_signal_focus_in and m_signal_focus_out
  37  *    c. m_signal_expand_candidate, m_signal_contract_candidate and m_signal_set_candidate_ui
  38  *    d. m_signal_get_ise_list, m_signal_get_keyboard_ise_list, m_signal_update_ise_geometry and m_signal_get_ise_information
  39  *    e. m_signal_set_active_ise_by_uuid and m_signal_get_ise_info_by_uuid
  40  *    f. m_signal_accept_connection, m_signal_close_connection and m_signal_exit
  41  * 2. Add new interface APIs in PanelClient class
  42  *    a. get_helper_manager_id (), has_helper_manager_pending_event () and filter_helper_manager_event ()
  43  *    b. update_candidate_panel_event (), update_input_panel_event () and select_aux ()
  44  *    c. candidate_more_window_show () and candidate_more_window_hide ()
  45  *    d. update_displayed_candidate_number () and update_candidate_item_layout ()
  46  *    e. stop_helper (), send_longpress_event () and update_ise_list ()
  47  *    f. filter_event (), filter_exception_event () and get_server_id ()
  48  * 3. Donot use thread to receive message
  49  * 4. Monitor socket frontend for self-recovery function
  50  *
  51  * $Id: scim_panel_agent.h,v 1.2 2005/06/11 14:50:31 suzhe Exp $
  52  */
  53
  54 #ifndef __ISF_INFO_MANAGER_H
  55 #define __ISF_INFO_MANAGER_H
  56
  57 #include <scim_panel_common.h>
  58 #ifndef _OUT_
  59 #define _OUT_
  60 #endif
  61
  62 namespace scim
  63 {
  64
  65 enum ClientType {
  66     UNKNOWN_CLIENT,
  67     FRONTEND_CLIENT,
  68     FRONTEND_ACT_CLIENT,
  69     HELPER_CLIENT,
  70     HELPER_ACT_CLIENT,
  71     IMCONTROL_ACT_CLIENT,
  72     IMCONTROL_CLIENT,
  73     REMOTEINPUT_ACT_CLIENT,
  74     REMOTEINPUT_CLIENT,
  75     CONFIG_CLIENT
  76 };
  77
  78 struct ClientInfo {
  79     uint32       key;
  80     ClientType   type;
  81 };
  82
  83 /**
  84  * @addtogroup Panel
  85  * @ingroup InputServiceFramework
  86  * The accessory classes to help develop Panel daemons and FrontEnds
  87  * which need to communicate with Panel daemons.
  88  * @{
  89  */
  90
  91 typedef Slot0<void>
  92 InfoManagerSlotVoid;
  93
  94 typedef Slot1<void, int>
  95 InfoManagerSlotInt;
  96
  97 typedef Slot1<void, int&>
  98 InfoManagerSlotInt2;
  99
 100 typedef Slot1<void, const String&>
 101 InfoManagerSlotString;
 102
 103 typedef Slot2<void, String&, String&>
 104 InfoManagerSlotString2;
 105
 106 typedef Slot2<void, int, const String&>
 107 InfoManagerSlotIntString;
 108
 109 typedef Slot1<void, const PanelFactoryInfo&>
 110 InfoManagerSlotFactoryInfo;
 111
 112 typedef Slot1<void, const std::vector <PanelFactoryInfo> &>
 113 InfoManagerSlotFactoryInfoVector;
 114
 115 typedef Slot1<void, const LookupTable&>
 116 InfoManagerSlotLookupTable;
 117
 118 typedef Slot1<void, const Property&>
 119 InfoManagerSlotProperty;
 120
 121 typedef Slot1<void, const PropertyList&>
 122 InfoManagerSlotPropertyList;
 123
 124 typedef Slot2<void, int, int>
 125 InfoManagerSlotIntInt;
 126
 127 typedef Slot2<void, int&, int&>
 128 InfoManagerSlotIntInt2;
 129
 130 typedef Slot3<void, int, int, int>
 131 InfoManagerSlotIntIntInt;
 132
 133 typedef Slot3<void, const String &, const String &, const String &>
 134 InfoManagerSlotString3;
 135
 136 typedef Slot4<void, int, int, int, int>
 137 InfoManagerSlotIntIntIntInt;
 138
 139 typedef Slot2<void, int, const Property&>
 140 InfoManagerSlotIntProperty;
 141
 142 typedef Slot2<void, int, const PropertyList&>
 143 InfoManagerSlotIntPropertyList;
 144
 145 typedef Slot2<void, int, const HelperInfo&>
 146 InfoManagerSlotIntHelperInfo;
 147
 148 typedef Slot2<void, const String&, const AttributeList&>
 149 InfoManagerSlotAttributeString;
 150
 151 typedef Slot3<void, const String&, const AttributeList&, int>
 152 InfoManagerSlotAttributeStringInt;
 153
 154 typedef Slot5<void, int, int, const String&, const String&, const AttributeList&>
 155 InfoManagerSlotAttributeInt2String2;
 156
 157 typedef Slot1<void, std::vector<String> &>
 158 InfoManagerSlotStringVector;
 159
 160 typedef Slot1<bool, HELPER_ISE_INFO&>
 161 InfoManagerSlotBoolHelperInfo;
 162
 163 typedef Slot1<bool, std::vector<String> &>
 164 InfoManagerSlotBoolStringVector;
 165
 166 typedef Slot2<void, char*, std::vector<String> &>
 167 InfoManagerSlotStrStringVector;
 168
 169 typedef Slot2<bool, const String&, ISE_INFO&>
 170 InfoManagerSlotStringISEINFO;
 171
 172 typedef Slot2<bool, String, int&>
 173 InfoManagerSlotStringInt;
 174
 175 typedef Slot1<void, const KeyEvent&>
 176 InfoManagerSlotKeyEvent;
 177
 178 typedef Slot1<void, struct rectinfo&>
 179 InfoManagerSlotRect;
 180
 181 typedef Slot2<void, const String&, bool>
 182 InfoManagerSlotStringBool;
 183
 184 typedef Slot6<bool, String, String&, String&, int&, int&, String&>
 185 InfoManagerSlotBoolString4int2;
 186
 187 typedef Slot2<void, int, struct rectinfo&>
 188 InfoManagerSlotIntRect;
 189
 190 typedef Slot2<bool, int, String>
 191 InfoManagerSlotIntString2;
 192
 193 typedef Slot1<bool, String>
 194 InfoManagerSlotBoolString;
 195
 196 /**
 197  * @brief The class to implement all socket protocol in Panel.
 198  *
 199  * This class acts like a stand alone SocketServer.
 200  * It has its own dedicated main loop, and will be blocked when run () is called.
 201  * So run () must be called within a separated thread, in order to not block
 202  * the main loop of the Panel program itself.
 203  *
 204  * Before calling run (), the panel must hook the callback functions to the
 205  * corresponding signals.
 206  *
 207  * Note that, there are two special signals: lock(void) and unlock(void). These
 208  * two signals are used to provide a thread lock to InfoManager, so that InfoManager
 209  * can run correctly within a multi-threading Panel program.
 210  */
 211 class EXAPI InfoManager
 212 {
 213     class InfoManagerImpl;
 214     InfoManagerImpl* m_impl;
 215
 216     InfoManager (const HelperAgent&);
 217     const InfoManager& operator = (const HelperAgent&);
 218
 219 public:
 220     InfoManager ();
 221     ~InfoManager ();
 222
 223     /**
 224      * @brief Initialize this InfoManager.
 225      *
 226      * @param config The name of the config module to be used by Helpers.
 227      * @param display The name of display, on which the Panel should run.
 228      * @param resident If this is true then this InfoManager will keep running
 229      *                 even if there is no more client connected.
 230      *
 231      * @return true if the InfoManager is initialized correctly and ready to run.
 232      */
 233     bool initialize (InfoManager* info_manager, const ConfigPointer& config, const String& display, bool resident = false);
 234
 235     /**
 236      * @brief Check if this InfoManager is initialized correctly and ready to run.
 237      *
 238      * @return true if this InfoManager is ready to run.
 239      */
 240     bool valid (void) const;
 241
 242     /**
 243      * @brief Stop this InfoManager.
 244      */
 245     void stop (void);
 246
 247 public:
 248
 249     const ClientInfo& socket_get_client_info (int client) const;
 250
 251     /**
 252      * @brief Get current ISE type.
 253      *
 254      * @return the current ISE type.
 255      */
 256     TOOLBAR_MODE_T get_current_toolbar_mode (void) const;
 257
 258     /**
 259      * @brief Get current helper ISE uuid.
 260      *
 261      * @return the current helper ISE uuid.
 262      */
 263     String get_current_helper_uuid (void) const;
 264
 265     /**
 266      * @brief Get current ISE name.
 267      *
 268      * @return the current ISE name.
 269      */
 270     String get_current_ise_name (void) const;
 271
 272     /**
 273      * @brief Set current ISE name.
 274      *
 275      * @param name The current ISE name.
 276      */
 277     void set_current_ise_name (String& name);
 278
 279     /**
 280      * @brief Set current ISE type.
 281      *
 282      * @param mode The current ISE type.
 283      */
 284     void set_current_toolbar_mode (TOOLBAR_MODE_T mode);
 285
 286     /**
 287      * @brief Set current helper ISE option.
 288      *
 289      * @param mode The current helper ISE option.
 290      */
 291     void set_current_helper_option (uint32 option);
 292     /**
 293      * @brief Get current ISE size and position.
 294      *
 295      * @param rect It contains ISE size and position.
 296      */
 297     void get_current_ise_geometry (rectinfo& rect);
 298
 299     /**
 300      * @brief Send candidate panel event to IM Control.
 301      *
 302      * @param nType  The candidate panel event type.
 303      * @param nValue The candidate panel event value.
 304      */
 305     void update_candidate_panel_event (uint32 nType, uint32 nValue);
 306
 307     /**
 308      * @brief Send input panel event to IM Control.
 309      *
 310      * @param nType  The input panel event type.
 311      * @param nValue The input panel event value.
 312      */
 313     void update_input_panel_event (uint32 nType, uint32 nValue);
 314
 315     /**
 316      * @brief Notice helper ISE to focus out.
 317      *
 318      * @param uuid The helper ISE uuid.
 319      */
 320     void focus_out_helper (const String& uuid);
 321
 322     /**
 323      * @brief Notice helper ISE to focus in.
 324      *
 325      * @param uuid The helper ISE uuid.
 326      */
 327     void focus_in_helper (const String& uuid);
 328
 329     /**
 330      * @brief Notice helper ISE to show window.
 331      *
 332      * @param uuid The helper ISE uuid.
 333      */
 334     bool show_helper (const String& uuid);
 335
 336     /**
 337      * @brief Notice helper ISE to hide window.
 338      *
 339      * @param uuid The helper ISE uuid.
 340      */
 341     void hide_helper (const String& uuid);
 342
 343
 344     /**
 345      * @brief Set default ISE.
 346      *
 347      * @param ise The variable contains the information of default ISE.
 348      */
 349     void set_default_ise (const DEFAULT_ISE_T& ise);
 350
 351     /**
 352      * @brief Set whether shared ISE is for all applications.
 353      *
 354      * @param should_shared_ise The indicator for shared ISE.
 355      */
 356     void set_should_shared_ise (const bool should_shared_ise);
 357
 358     /**
 359      * @brief Request helper ISE to show window again.
 360      */
 361     void reshow_input_panel ();
 362
 363
 364 public:
 365     /**
 366      * @brief Let the focused IMEngineInstance object move the preedit caret.
 367      *
 368      * @param position The new preedit caret position.
 369      * @return true if the command was sent correctly.
 370      */
 371     bool move_preedit_caret (uint32         position);
 372
 373 #if 0
 374     /**
 375      * @brief Request help information from the focused IMEngineInstance object.
 376      * @return true if the command was sent correctly.
 377      */
 378     bool request_help (void);
 379
 380     /**
 381      * @brief Request factory menu from the focused FrontEnd.
 382      * @return true if the command was sent correctly.
 383      */
 384     bool request_factory_menu (void);
 385 #endif
 386
 387     /**
 388      * @brief Change the factory used by the focused IMEngineInstance object.
 389      *
 390      * @param uuid The uuid of the new factory.
 391      * @return true if the command was sent correctly.
 392      */
 393     bool change_factory (const String&  uuid);
 394
 395     /**
 396      * @brief Notice Helper ISE that candidate more window is showed.
 397      * @return true if the command was sent correctly.
 398      */
 399     bool candidate_more_window_show (void);
 400
 401     /**
 402      * @brief Notice Helper ISE that candidate more window is hidden.
 403      * @return true if the command was sent correctly.
 404      */
 405     bool candidate_more_window_hide (void);
 406
 407     /**
 408      * @brief Notice Helper ISE that show candidate.
 409      * @return true if the command was sent correctly.
 410      */
 411     bool helper_candidate_show (void);
 412
 413     /**
 414      * @brief Notice Helper ISE that hide candidate.
 415      * @return true if the command was sent correctly.
 416      */
 417     bool helper_candidate_hide (void);
 418
 419     /**
 420      * @brief Update helper lookup table.
 421      * @return true if the command was sent correctly.
 422      */
 423     bool update_helper_lookup_table (const LookupTable& table);
 424
 425     /**
 426      * @brief Let the focused IMEngineInstance object
 427      *        select a aux in current aux string.
 428      *
 429      * @param item The index of the selected aux.
 430      * @return true if the command was sent correctly.
 431      */
 432     bool select_aux (uint32         item);
 433
 434     /**
 435      * @brief Let the focused IMEngineInstance object
 436      *        select a candidate in current lookup table.
 437      *
 438      * @param item The index of the selected candidate.
 439      * @return true if the command was sent correctly.
 440      */
 441     bool select_candidate (uint32         item);
 442
 443     /**
 444      * @brief Let the focused IMEngineInstance object
 445      *        flip the LookupTable to previous page.
 446      * @return true if the command was sent correctly.
 447      */
 448     bool lookup_table_page_up (void);
 449
 450     /**
 451      * @brief Let the focused IMEngineInstance object
 452      *        flip the LookupTable to next page.
 453      * @return true if the command was sent correctly.
 454      */
 455     bool lookup_table_page_down (void);
 456
 457     /**
 458      * @brief Let the focused IMEngineInstance object
 459      *        update the page size of the LookupTable.
 460      *
 461      * @param size The new page size.
 462      * @return true if the command was sent correctly.
 463      */
 464     bool update_lookup_table_page_size (uint32         size);
 465
 466     /**
 467      * @brief Let the focused IMEngineInstance object
 468      *        update candidate items layout.
 469      *
 470      * @param row_items The items of each row.
 471      * @return true if the command was sent correctly.
 472      */
 473     bool update_candidate_item_layout (const std::vector<uint32>& row_items);
 474
 475     /**
 476      * @brief Let the focused IMEngineInstance object
 477      *        select a associate in current associate table.
 478      *
 479      * @param item The index of the selected associate.
 480      * @return true if the command was sent correctly.
 481      */
 482     bool select_associate (uint32         item);
 483
 484     /**
 485      * @brief Let the focused IMEngineInstance object
 486      *        flip the AssociateTable to previous page.
 487      * @return true if the command was sent correctly.
 488      */
 489     bool associate_table_page_up (void);
 490
 491     /**
 492      * @brief Let the focused IMEngineInstance object
 493      *        flip the AssociateTable to next page.
 494      * @return true if the command was sent correctly.
 495      */
 496     bool associate_table_page_down (void);
 497
 498     /**
 499      * @brief Let the focused IMEngineInstance object
 500      *        update the page size of the AssociateTable.
 501      *
 502      * @param size The new page size.
 503      * @return true if the command was sent correctly.
 504      */
 505     bool update_associate_table_page_size (uint32       size);
 506
 507     /**
 508      * @brief Inform helper ISE to update displayed candidate number.
 509      *
 510      * @param size The displayed candidate number.
 511      * @return true if the command was sent correctly.
 512      */
 513     bool update_displayed_candidate_number (uint32      size);
 514
 515     /**
 516      * @brief Trigger a property of the focused IMEngineInstance object.
 517      *
 518      * @param property The property key to be triggered.
 519      * @return true if the command was sent correctly.
 520      */
 521     bool trigger_property (const String&  property);
 522
 523     /**
 524      * @brief Start a stand alone helper.
 525      *
 526      * @param uuid The uuid of the Helper object to be started.
 527      * @return true if the command was sent correctly.
 528      */
 529     bool start_helper (const String&  uuid);
 530
 531     /**
 532      * @brief Stop a stand alone helper.
 533      *
 534      * @param uuid The uuid of the Helper object to be stopped.
 535      * @return true if the command was sent correctly.
 536      */
 537     bool stop_helper (const String&  uuid);
 538
 539     /**
 540      * @brief Let all FrontEnds and Helpers reload configuration.
 541      * @return true if the command was sent correctly.
 542      */
 543     void reload_config                  (void);
 544
 545     /**
 546      * @brief Let all FrontEnds, Helpers and this Panel exit.
 547      * @return true if the command was sent correctly.
 548      */
 549     bool exit (void);
 550
 551     /**
 552      * @brief Send candidate longpress event to ISE.
 553      *
 554      * @param type The candidate object type.
 555      * @param index The candidate object index.
 556      *
 557      * @return none.
 558      */
 559     void send_longpress_event (int type, int index);
 560
 561     /**
 562      * @brief Request to update ISE list.
 563      *
 564      * @return none.
 565      */
 566     void update_ise_list (std::vector<String>& strList);
 567
 568
 569     bool remoteinput_update_preedit_string (WideString str, AttributeList &attrs, uint32 caret);
 570
 571     bool remoteinput_commit_string (const WideString &str);
 572
 573     bool remoteinput_send_key_event (const KeyEvent &key);
 574
 575     bool remoteinput_forward_key_event (const KeyEvent &key);
 576
 577     bool remoteinput_send_input_message (int client_id, char*  buf, size_t  len);
 578
 579     bool remoteinput_delete_surrounding_text (uint32 offset, uint32 len);
 580
 581     void remoteinput_send_surrounding_text (const char* text, uint32 cursor);
 582
 583     void remoteinput_callback_focus_in (void);
 584
 585     void remoteinput_callback_focus_out (void);
 586
 587     void remoteinput_callback_entry_metadata (uint32 hint, uint32 layout, int variation, uint32 autocapital_type, int return_key_disabled);
 588
 589     void remoteinput_callback_surrounding_text (String text, uint32 cursor);
 590
 591     void remoteinput_callback_input_resource (uint32 input_resource);
 592
 593 /////////////////////////////////Message function begin/////////////////////////////////////////
 594
 595 //ISM_TRANS_CMD_PANEL_RESET_KEYBOARD_ISE
 596     /**
 597      * @brief Reset keyboard ISE.
 598      *
 599      * @return true if this operation is successful, otherwise return false.
 600      */
 601     bool reset_keyboard_ise (void);
 602
 603     //ISM_TRANS_CMD_SHOW_ISF_CONTROL
 604     void show_isf_panel (int client_id);
 605
 606     //ISM_TRANS_CMD_HIDE_ISF_CONTROL
 607     void hide_isf_panel (int client_id);
 608
 609     //ISM_TRANS_CMD_SHOW_ISE_PANEL
 610     void show_ise_panel (int client_id, uint32 client, uint32 context, char*   data, size_t  len);
 611
 612     //ISM_TRANS_CMD_HIDE_ISE_PANEL
 613     void hide_ise_panel (int client_id, uint32 client, uint32 context);
 614
 615     //ISM_TRANS_CMD_HIDE_ISE_PANEL from ISF control
 616     void hide_helper_ise (void);
 617
 618     //ISM_TRANS_CMD_LAUNCH_ISE
 619     void launch_helper_ise (void);
 620
 621     //SCIM_TRANS_CMD_PROCESS_KEY_EVENT
 622     bool process_key_event (KeyEvent& key, uint32 serial);
 623
 624     //ISM_TRANS_CMD_GET_ACTIVE_ISE_GEOMETRY
 625     void get_input_panel_geometry (int client_id, _OUT_ struct rectinfo& info);
 626
 627     //ISM_TRANS_CMD_GET_CANDIDATE_GEOMETRY
 628     void get_candidate_window_geometry (int client_id, _OUT_ struct rectinfo& info);
 629
 630     //ISM_TRANS_CMD_GET_ISE_LANGUAGE_LOCALE
 631     void get_ise_language_locale (int client_id, _OUT_ char** data, _OUT_ size_t& len);
 632
 633     //ISM_TRANS_CMD_SET_LAYOUT
 634     void set_ise_layout (int client_id, uint32 layout);
 635
 636     //ISM_TRANS_CMD_SET_INPUT_MODE
 637     void set_ise_input_mode (int client_id, uint32 input_mode);
 638
 639     //ISM_TRANS_CMD_SET_INPUT_HINT
 640     void set_ise_input_hint (int client_id, uint32 input_hint);
 641
 642     //ISM_TRANS_CMD_UPDATE_BIDI_DIRECTION
 643     void update_ise_bidi_direction (int client_id, uint32 bidi_direction);
 644
 645     //ISM_TRANS_CMD_SET_ISE_LANGUAGE
 646     void set_ise_language (int client_id, uint32 language);
 647
 648     //ISM_TRANS_CMD_SET_ISE_IMDATA
 649     void set_ise_imdata (int client_id, const char*   imdata, size_t  len);
 650
 651     //ISM_TRANS_CMD_GET_ISE_IMDATA
 652     bool get_ise_imdata (int client_id, _OUT_ char** imdata, _OUT_ size_t& len);
 653
 654     //ISM_TRANS_CMD_GET_LAYOUT
 655     bool get_ise_layout (int client_id, _OUT_ uint32& layout);
 656
 657     //ISM_TRANS_CMD_GET_ISE_STATE
 658     void get_ise_state (int client_id, _OUT_ int& state);
 659
 660     //ISM_TRANS_CMD_GET_ACTIVE_ISE
 661     void get_active_ise (int client_id, _OUT_ String& default_uuid);
 662
 663     //ISM_TRANS_CMD_GET_ISE_LIST
 664     void get_ise_list (int client_id, _OUT_ std::vector<String>& strlist);
 665
 666     //ISM_TRANS_CMD_GET_ALL_HELPER_ISE_INFO
 667     void get_all_helper_ise_info (int client_id, _OUT_ HELPER_ISE_INFO& info);
 668
 669     //ISM_TRANS_CMD_SET_ENABLE_HELPER_ISE_INFO
 670     //reply SCIM_TRANS_CMD_FAIL or SCIM_TRANS_CMD_OK
 671     void set_enable_helper_ise_info (int client_id, String appid, uint32 is_enabled);
 672
 673     //ISM_TRANS_CMD_SHOW_HELPER_ISE_LIST
 674     //reply SCIM_TRANS_CMD_FAIL or SCIM_TRANS_CMD_OK
 675     void show_helper_ise_list (int client_id);
 676
 677     //ISM_TRANS_CMD_SHOW_HELPER_ISE_SELECTOR
 678     //reply SCIM_TRANS_CMD_FAIL or SCIM_TRANS_CMD_OK
 679     void show_helper_ise_selector (int client_id);
 680
 681     //ISM_TRANS_CMD_IS_HELPER_ISE_ENABLED
 682     //reply
 683     void is_helper_ise_enabled (int client_id, String strAppid, _OUT_ uint32& nEnabled);
 684
 685     //ISM_TRANS_CMD_GET_ISE_INFORMATION
 686     void get_ise_information (int client_id, String strUuid, _OUT_ String& strName, _OUT_ String& strLanguage,
 687                               _OUT_ int& nType, _OUT_ int& nOption, _OUT_ String& strModuleName);
 688
 689     //ISM_TRANS_CMD_RESET_ISE_OPTION
 690     //reply SCIM_TRANS_CMD_OK
 691     bool reset_ise_option (int client_id);
 692
 693     //ISM_TRANS_CMD_SET_ACTIVE_ISE_BY_UUID
 694     //reply
 695     bool set_active_ise_by_uuid (int client_id, char*  buf, size_t  len);
 696
 697     //ISM_TRANS_CMD_SET_INITIAL_ISE_BY_UUID
 698     //reply SCIM_TRANS_CMD_FAIL or SCIM_TRANS_CMD_OK
 699     void set_initial_ise_by_uuid (int client_id, char*  buf, size_t  len);
 700
 701     //ISM_TRANS_CMD_SET_RETURN_KEY_TYPE
 702     void set_ise_return_key_type (int client_id, uint32 type);
 703
 704     //ISM_TRANS_CMD_GET_RETURN_KEY_TYPE
 705     //reply
 706     bool get_ise_return_key_type (int client_id, _OUT_ uint32& type);
 707
 708     //ISM_TRANS_CMD_SET_RETURN_KEY_DISABLE
 709     void set_ise_return_key_disable (int client_id, uint32 disabled);
 710
 711     //ISM_TRANS_CMD_GET_RETURN_KEY_DISABLE
 712     bool get_ise_return_key_disable (int client_id, _OUT_ uint32& disabled);
 713
 714     //ISM_TRANS_CMD_SET_CAPS_MODE
 715     void set_ise_caps_mode (int client_id, uint32 mode);
 716
 717     //ISM_TRANS_CMD_SEND_WILL_SHOW_ACK
 718     void will_show_ack (int client_id);
 719
 720     //ISM_TRANS_CMD_SEND_WILL_HIDE_ACK
 721     void will_hide_ack (int client_id);
 722
 723     //ISM_TRANS_CMD_RESET_DEFAULT_ISE
 724     void reset_default_ise (int client_id);
 725
 726     //ISM_TRANS_CMD_SET_HARDWARE_KEYBOARD_MODE
 727     void set_keyboard_mode (int client_id, uint32 mode);
 728
 729     //ISM_TRANS_CMD_SEND_CANDIDATE_WILL_HIDE_ACK
 730     void candidate_will_hide_ack (int client_id);
 731
 732     //ISM_TRANS_CMD_GET_ACTIVE_HELPER_OPTION
 733     void get_active_helper_option (int client_id, _OUT_ uint32& option);
 734
 735     //ISM_TRANS_CMD_SHOW_ISE_OPTION_WINDOW
 736     void show_ise_option_window (int client_id);
 737
 738     //ISM_TRANS_CMD_RESUME_ISE_OPTION_WINDOW
 739     void resume_ise_option_window (int client_id);
 740
 741     //ISM_TRANS_CMD_SET_KEYBOARD_MODE
 742     void set_ise_keyboard_mode (int client_id, uint32 mode);
 743
 744     //ISM_TRANS_CMD_SET_PREDICTION_HINT
 745     void set_prediction_hint (int client_id, String prediction_hint);
 746
 747     //ISM_TRANS_CMD_SET_MIME_TYPE
 748     void set_ise_mime_type (int client_id, String mime_type);
 749
 750     //ISM_TRANS_CMD_FINALIZE_CONTENT
 751     void finalize_content(int client_id, String text, uint32 cursor_pos);
 752
 753     //ISM_TRANS_CMD_SET_PREDICTION_HINT_DATA
 754     void set_prediction_hint_data (int client_id, String key, String value);
 755
 756     //ISM_TRANS_CMD_EXPAND_CANDIDATE
 757     void expand_candidate ();
 758
 759     //ISM_TRANS_CMD_CONTRACT_CANDIDATE
 760     void contract_candidate ();
 761
 762     //ISM_TRANS_CMD_GET_RECENT_ISE_GEOMETRY
 763     void get_recent_ise_geometry (int client_id, uint32 angle, _OUT_ struct rectinfo& info);
 764
 765     //ISM_TRANS_CMD_REGISTER_PANEL_CLIENT
 766     void register_panel_client (uint32 client_id, uint32 id);
 767
 768     //SCIM_TRANS_CMD_PANEL_REGISTER_INPUT_CONTEXT
 769     void register_input_context (uint32 client_id, uint32 context, String  uuid);
 770
 771     //SCIM_TRANS_CMD_PANEL_REMOVE_INPUT_CONTEXT
 772     void remove_input_context (uint32 client_id, uint32 context);
 773
 774     //SCIM_TRANS_CMD_PANEL_RESET_INPUT_CONTEXT
 775     void socket_reset_input_context (int client_id, uint32 context);
 776
 777     //SCIM_TRANS_CMD_FOCUS_IN
 778     void focus_in (int client_id, uint32 context,  String  uuid);
 779
 780     //SCIM_TRANS_CMD_FOCUS_OUT
 781     void focus_out (int client_id, uint32 context);
 782
 783     //ISM_TRANS_CMD_PROCESS_INPUT_DEVICE_EVENT
 784     bool process_input_device_event(int client_id, uint32 type, const char *data, size_t len, _OUT_ uint32& result);
 785
 786     //ISM_TRANS_CMD_TURN_ON_LOG
 787     void socket_turn_on_log (uint32 isOn);
 788
 789     //SCIM_TRANS_CMD_PANEL_TURN_ON
 790     void socket_turn_on (void);
 791
 792     //SCIM_TRANS_CMD_PANEL_TURN_OFF
 793     void socket_turn_off (void);
 794
 795     //SCIM_TRANS_CMD_UPDATE_SCREEN
 796     void socket_update_screen (int client_id, uint32 num);
 797
 798     //SCIM_TRANS_CMD_UPDATE_SPOT_LOCATION
 799     void socket_update_spot_location (uint32 x, uint32 y, uint32 top_y);
 800
 801     //ISM_TRANS_CMD_UPDATE_CURSOR_POSITION
 802     void socket_update_cursor_position (uint32 cursor_pos);
 803
 804     //ISM_TRANS_CMD_UPDATE_SURROUNDING_TEXT
 805     void socket_update_surrounding_text (String text, uint32 cursor);
 806
 807     //ISM_TRANS_CMD_UPDATE_SELECTION
 808     void socket_update_selection (String text);
 809
 810     //SCIM_TRANS_CMD_PANEL_UPDATE_FACTORY_INFO
 811     void socket_update_factory_info (PanelFactoryInfo& info);
 812
 813     //SCIM_TRANS_CMD_PANEL_SHOW_HELP
 814     void socket_show_help (String help);
 815
 816     //SCIM_TRANS_CMD_PANEL_SHOW_FACTORY_MENU
 817     void socket_show_factory_menu (std::vector <PanelFactoryInfo>& vec);
 818
 819     //SCIM_TRANS_CMD_SHOW_PREEDIT_STRING
 820     void socket_show_preedit_string (void);
 821
 822     //SCIM_TRANS_CMD_SHOW_AUX_STRING
 823     void socket_show_aux_string (void);
 824
 825     //SCIM_TRANS_CMD_SHOW_LOOKUP_TABLE
 826     void socket_show_lookup_table (void);
 827
 828     //ISM_TRANS_CMD_SHOW_ASSOCIATE_TABLE
 829     void socket_show_associate_table (void);
 830
 831     //SCIM_TRANS_CMD_HIDE_PREEDIT_STRING
 832     void socket_hide_preedit_string (void);
 833
 834     //SCIM_TRANS_CMD_HIDE_AUX_STRING
 835     void socket_hide_aux_string (void);
 836
 837     //SCIM_TRANS_CMD_HIDE_LOOKUP_TABLE
 838     void socket_hide_lookup_table (void);
 839
 840     //ISM_TRANS_CMD_HIDE_ASSOCIATE_TABLE
 841     void socket_hide_associate_table (void);
 842
 843     //SCIM_TRANS_CMD_UPDATE_PREEDIT_STRING
 844     void socket_update_preedit_string (String& str, const AttributeList& attrs, uint32 caret);
 845
 846     //SCIM_TRANS_CMD_UPDATE_PREEDIT_CARET
 847     void socket_update_preedit_caret (uint32 caret);
 848
 849     //SCIM_TRANS_CMD_UPDATE_AUX_STRING
 850     void socket_update_aux_string (String& str, const AttributeList& attrs);
 851
 852     //ISM_TRANS_CMD_RECAPTURE_STRING
 853     void socket_recapture_string (int offset, int len, String& preedit, String& commit, const AttributeList& attrs);
 854
 855     //SCIM_TRANS_CMD_UPDATE_LOOKUP_TABLE
 856     void socket_update_lookup_table (const LookupTable& table);
 857
 858     //ISM_TRANS_CMD_UPDATE_ASSOCIATE_TABLE
 859     void socket_update_associate_table (const LookupTable& table);
 860
 861     //SCIM_TRANS_CMD_REGISTER_PROPERTIES
 862     void socket_register_properties (const PropertyList& properties);
 863
 864     //SCIM_TRANS_CMD_UPDATE_PROPERTY
 865     void socket_update_property (const Property& property);
 866
 867     //ISM_TRANS_CMD_GET_KEYBOARD_ISE_LIST
 868     void socket_get_keyboard_ise_list (String& uuid);
 869
 870     //ISM_TRANS_CMD_SET_CANDIDATE_UI
 871     void socket_set_candidate_ui (uint32 portrait_line, uint32 mode);
 872
 873     //ISM_TRANS_CMD_GET_CANDIDATE_UI
 874     void socket_get_candidate_ui (String uuid);
 875
 876     //ISM_TRANS_CMD_SET_CANDIDATE_POSITION
 877     void socket_set_candidate_position (uint32 left, uint32 top);
 878
 879     //ISM_TRANS_CMD_HIDE_CANDIDATE
 880     void socket_hide_candidate (void);
 881
 882     //ISM_TRANS_CMD_GET_CANDIDATE_GEOMETRY
 883     void socket_get_candidate_geometry (String& uuid);
 884
 885     //ISM_TRANS_CMD_SET_KEYBOARD_ISE_BY_UUID
 886     void socket_set_keyboard_ise (String uuid);
 887
 888     //ISM_TRANS_CMD_SELECT_CANDIDATE
 889     void socket_helper_select_candidate (uint32 index);
 890
 891     //ISM_TRANS_CMD_UPDATE_ISE_GEOMETRY
 892     void socket_helper_update_ise_geometry (int client, uint32 x, uint32 y, uint32 width, uint32 height);
 893
 894     //ISM_TRANS_CMD_GET_KEYBOARD_ISE
 895     void socket_get_keyboard_ise (String uuid);
 896
 897     //SCIM_TRANS_CMD_START_HELPER
 898     void socket_start_helper (int client_id, uint32 context, String uuid);
 899
 900     //SCIM_TRANS_CMD_STOP_HELPER
 901     void socket_stop_helper (int client_id, uint32 context, String uuid);
 902
 903     //SCIM_TRANS_CMD_SEND_HELPER_EVENT
 904     void socket_send_helper_event (int client_id, uint32 context, String uuid, const Transaction& _nest_trans);
 905
 906     //SCIM_TRANS_CMD_REGISTER_PROPERTIES
 907     void socket_helper_register_properties (int client, PropertyList& properties);
 908
 909     //SCIM_TRANS_CMD_UPDATE_PROPERTY
 910     void socket_helper_update_property (int client, Property& property);
 911
 912     //SCIM_TRANS_CMD_PANEL_SEND_IMENGINE_EVENT
 913     void socket_helper_send_imengine_event (int client, uint32 target_ic, String target_uuid , Transaction& nest_trans);
 914
 915     //SCIM_TRANS_CMD_PROCESS_KEY_EVENT
 916     //SCIM_TRANS_CMD_PANEL_SEND_KEY_EVENT
 917     void socket_helper_send_key_event (int client, uint32 target_ic, String target_uuid, KeyEvent key);
 918
 919     //SCIM_TRANS_CMD_FORWARD_KEY_EVENT
 920     void socket_helper_forward_key_event (int client, uint32 target_ic, String target_uuid, KeyEvent key);
 921
 922     //SCIM_TRANS_CMD_COMMIT_STRING
 923     void socket_helper_commit_string (int client, uint32 target_ic, String target_uuid, WideString wstr);
 924
 925     //SCIM_TRANS_CMD_GET_SURROUNDING_TEXT
 926     void socket_helper_get_surrounding_text (int client, String uuid, uint32 maxlen_before, uint32 maxlen_after);
 927
 928     //SCIM_TRANS_CMD_DELETE_SURROUNDING_TEXT
 929     void socket_helper_delete_surrounding_text (int client, uint32 offset, uint32 len);
 930
 931     //SCIM_TRANS_CMD_GET_SELECTION
 932     void socket_helper_get_selection (int client, String uuid);
 933
 934     //SCIM_TRANS_CMD_SET_SELECTION
 935     void socket_helper_set_selection (int client, uint32 start, uint32 end);
 936
 937     //SCIM_TRANS_CMD_SHOW_PREEDIT_STRING
 938     void socket_helper_show_preedit_string (int client, uint32 target_ic, String target_uuid);
 939
 940     //SCIM_TRANS_CMD_HIDE_PREEDIT_STRING
 941     void socket_helper_hide_preedit_string (int client, uint32 target_ic, String target_uuid);
 942
 943     //SCIM_TRANS_CMD_UPDATE_PREEDIT_STRING
 944     void socket_helper_update_preedit_string (int client, uint32 target_ic, String target_uuid, WideString preedit, WideString commit, AttributeList& attrs, uint32 caret);
 945
 946     //SCIM_TRANS_CMD_UPDATE_PREEDIT_CARET
 947     void socket_helper_update_preedit_caret (int client, uint32 caret);
 948
 949     //ISM_TRANS_CMD_RECAPTURE_STRING
 950     void socket_helper_recapture_string (int client, uint32 target_ic, String target_uuid, int offset, int len, WideString preedit, WideString commit, AttributeList& attrs);
 951
 952     //SCIM_TRANS_CMD_PANEL_REGISTER_HELPER
 953     void socket_helper_register_helper (int client, HelperInfo& info);
 954
 955     //SCIM_TRANS_CMD_PANEL_REGISTER_ACTIVE_HELPER
 956     void socket_helper_register_helper_passive (int client, HelperInfo& info);
 957
 958     //ISM_TRANS_CMD_UPDATE_ISE_INPUT_CONTEXT
 959     void socket_helper_update_input_context (int client, uint32 type, uint32 value);
 960
 961     //ISM_TRANS_CMD_UPDATE_ISE_LANGUAGE_LOCALE
 962     void socket_helper_update_language_locale(int client, String locale);
 963
 964     //SCIM_TRANS_CMD_SEND_PRIVATE_COMMAND
 965     void socket_helper_send_private_command (int client, String command);
 966
 967     //SCIM_TRANS_CMD_SEND_COMMIT_CONTENT
 968     void socket_helper_commit_content (int client, String content, String description, String mime_types);
 969
 970     //ISM_TRANS_CMD_UPDATE_ISE_EXIT
 971     //void UPDATE_ISE_EXIT (int client);
 972
 973     //ISM_TRANS_CMD_PROCESS_KEY_EVENT_DONE
 974     void process_key_event_done (KeyEvent &key, uint32 ret, uint32 serial);
 975
 976     //ISM_TRANS_CMD_REQUEST_ISE_HIDE
 977     void request_ise_hide ();
 978
 979     bool check_privilege_by_sockfd (int client_id, const String& privilege);
 980
 981     void add_client (int client_id, uint32 key, ClientType type);
 982
 983     void del_client (int client_id);
 984
 985     bool set_autocapital_type (int mode);
 986
 987     void set_prediction_allow (int client, bool mode);
 988
 989 //////////////////////////////////Message function end/////////////////////////////////////////
 990
 991
 992 public:
 993
 994     /**
 995      * @brief Signal: Turn on.
 996      *
 997      * slot prototype: void turn_on (void);
 998      */
 999     Connection signal_connect_turn_on (InfoManagerSlotVoid*                slot);
1000
1001     /**
1002      * @brief Signal: Turn off.
1003      *
1004      * slot prototype: void turn_off (void);
1005      */
1006     Connection signal_connect_turn_off (InfoManagerSlotVoid*                slot);
1007
1008     /**
1009      * @brief Signal: Show panel.
1010      *
1011      * slot prototype: void show_panel (void);
1012      */
1013     Connection signal_connect_show_panel (InfoManagerSlotVoid*                slot);
1014
1015     /**
1016      * @brief Signal: Hide panel.
1017      *
1018      * slot prototype: void hide_panel (void);
1019      */
1020     Connection signal_connect_hide_panel (InfoManagerSlotVoid*                slot);
1021
1022     /**
1023      * @brief Signal: Update screen.
1024      *
1025      * slot prototype: void update_screen (int screen);
1026      */
1027     Connection signal_connect_update_screen (InfoManagerSlotInt*                 slot);
1028
1029     /**
1030      * @brief Signal: Update spot location.
1031      *
1032      * slot prototype: void update_spot_location (int x, int y, int top_y);
1033      */
1034     Connection signal_connect_update_spot_location (InfoManagerSlotIntIntInt*           slot);
1035
1036     /**
1037      * @brief Signal: Update factory information.
1038      *
1039      * slot prototype: void update_factory_info (const PanelFactoryInfo &info);
1040      */
1041     Connection signal_connect_update_factory_info (InfoManagerSlotFactoryInfo*         slot);
1042
1043     /**
1044      * @brief Signal: start default ise.
1045      *
1046      * slot prototype: void start_default_ise (void);
1047      */
1048     Connection signal_connect_start_default_ise (InfoManagerSlotVoid*                slot);
1049
1050     /**
1051      * @brief Signal: stop default ise.
1052      *
1053      * slot prototype: void stop_default_ise (void);
1054      */
1055     Connection signal_connect_stop_default_ise (InfoManagerSlotVoid*                slot);
1056
1057     /**
1058      * @brief Signal: Get the list of keyboard ise name.
1059      *
1060      * slot prototype: bool get_keyboard_ise_list (std::vector<String> &);
1061      */
1062     Connection signal_connect_get_keyboard_ise_list (InfoManagerSlotBoolStringVector*    slot);
1063
1064     /**
1065      * @brief Signal: Set candidate ui.
1066      *
1067      * slot prototype: void set_candidate_ui (int style, int mode);
1068      */
1069     Connection signal_connect_set_candidate_ui (InfoManagerSlotIntInt*              slot);
1070
1071     /**
1072      * @brief Signal: Get candidate ui.
1073      *
1074      * slot prototype: void get_candidate_ui (int &style, int &mode);
1075      */
1076     Connection signal_connect_get_candidate_ui (InfoManagerSlotIntInt2*             slot);
1077
1078     /**
1079      * @brief Signal: Get candidate window geometry information.
1080      *
1081      * slot prototype: void get_candidate_geometry (rectinfo &info);
1082      */
1083     Connection signal_connect_get_candidate_geometry (InfoManagerSlotRect*                slot);
1084
1085     /**
1086      * @brief Signal: Get input panel geometry information.
1087      *
1088      * slot prototype: void get_input_panel_geometry (rectinfo &info);
1089      */
1090     Connection signal_connect_get_input_panel_geometry (InfoManagerSlotRect*                slot);
1091
1092     /**
1093      * @brief Signal: Set candidate position.
1094      *
1095      * slot prototype: void set_candidate_position (int left, int top);
1096      */
1097     Connection signal_connect_set_candidate_position (InfoManagerSlotIntInt*              slot);
1098
1099     /**
1100      * @brief Signal: Set keyboard ise.
1101      *
1102      * slot prototype: void set_keyboard_ise (const String &uuid);
1103      */
1104     Connection signal_connect_set_keyboard_ise (InfoManagerSlotString*              slot);
1105
1106     /**
1107      * @brief Signal: Get keyboard ise.
1108      *
1109      * slot prototype: void get_keyboard_ise (String &ise_name, String &ise_uuid);
1110      */
1111     Connection signal_connect_get_keyboard_ise (InfoManagerSlotString2*             slot);
1112
1113     /**
1114      * @brief Signal: Update ise geometry.
1115      *
1116      * slot prototype: void update_ise_geometry (int x, int y, int width, int height);
1117      */
1118     Connection signal_connect_update_ise_geometry (InfoManagerSlotIntIntIntInt*        slot);
1119
1120     /**
1121      * @brief Signal: Show help.
1122      *
1123      * slot prototype: void show_help (const String &help);
1124      */
1125     Connection signal_connect_show_help (InfoManagerSlotString*              slot);
1126
1127     /**
1128      * @brief Signal: Show factory menu.
1129      *
1130      * slot prototype: void show_factory_menu (const std::vector <PanelFactoryInfo> &menu);
1131      */
1132     Connection signal_connect_show_factory_menu (InfoManagerSlotFactoryInfoVector*   slot);
1133
1134     /**
1135      * @brief Signal: Show preedit string.
1136      *
1137      * slot prototype: void show_preedit_string (void):
1138      */
1139     Connection signal_connect_show_preedit_string (InfoManagerSlotVoid*                slot);
1140
1141     /**
1142      * @brief Signal: Show aux string.
1143      *
1144      * slot prototype: void show_aux_string (void):
1145      */
1146     Connection signal_connect_show_aux_string (InfoManagerSlotVoid*                slot);
1147
1148     /**
1149      * @brief Signal: Show lookup table.
1150      *
1151      * slot prototype: void show_lookup_table (void):
1152      */
1153     Connection signal_connect_show_lookup_table (InfoManagerSlotVoid*                slot);
1154
1155     /**
1156      * @brief Signal: Show associate table.
1157      *
1158      * slot prototype: void show_associate_table (void):
1159      */
1160     Connection signal_connect_show_associate_table (InfoManagerSlotVoid*                slot);
1161
1162     /**
1163      * @brief Signal: Hide preedit string.
1164      *
1165      * slot prototype: void hide_preedit_string (void);
1166      */
1167     Connection signal_connect_hide_preedit_string (InfoManagerSlotVoid*                slot);
1168
1169     /**
1170      * @brief Signal: Hide aux string.
1171      *
1172      * slot prototype: void hide_aux_string (void);
1173      */
1174     Connection signal_connect_hide_aux_string (InfoManagerSlotVoid*                slot);
1175
1176     /**
1177      * @brief Signal: Hide lookup table.
1178      *
1179      * slot prototype: void hide_lookup_table (void);
1180      */
1181     Connection signal_connect_hide_lookup_table (InfoManagerSlotVoid*                slot);
1182
1183     /**
1184      * @brief Signal: Hide associate table.
1185      *
1186      * slot prototype: void hide_associate_table (void);
1187      */
1188     Connection signal_connect_hide_associate_table (InfoManagerSlotVoid*                slot);
1189
1190     /**
1191      * @brief Signal: Update preedit string.
1192      *
1193      * slot prototype: void update_preedit_string (const String &str, const AttributeList &attrs, int caret);
1194      * - str   -- The UTF-8 encoded string to be displayed in preedit area.
1195      * - attrs -- The attributes of the string.
1196      */
1197     Connection signal_connect_update_preedit_string (InfoManagerSlotAttributeStringInt*  slot);
1198
1199     /**
1200      * @brief Signal: Update preedit caret.
1201      *
1202      * slot prototype: void update_preedit_caret (int caret);
1203      */
1204     Connection signal_connect_update_preedit_caret (InfoManagerSlotInt*                 slot);
1205
1206     /**
1207      * @brief Signal: Recapture string.
1208      *
1209      * slot prototype: void recapture_string (int offset, int length, String preedit, String commit, Attribute &attrs);
1210      */
1211     Connection signal_connect_recapture_string (InfoManagerSlotAttributeInt2String2*  slot);
1212
1213     /**
1214      * @brief Signal: Update aux string.
1215      *
1216      * slot prototype: void update_aux_string (const String &str, const AttributeList &attrs);
1217      * - str   -- The UTF-8 encoded string to be displayed in aux area.
1218      * - attrs -- The attributes of the string.
1219      */
1220     Connection signal_connect_update_aux_string (InfoManagerSlotAttributeString*     slot);
1221
1222     /**
1223      * @brief Signal: Update lookup table.
1224      *
1225      * slot prototype: void update_lookup_table (const LookupTable &table);
1226      * - table -- The new LookupTable object.
1227      */
1228     Connection signal_connect_update_lookup_table (InfoManagerSlotLookupTable*         slot);
1229
1230     /**
1231      * @brief Signal: Update associate table.
1232      *
1233      * slot prototype: void update_associate_table (const LookupTable &table);
1234      * - table -- The new LookupTable object.
1235      */
1236     Connection signal_connect_update_associate_table (InfoManagerSlotLookupTable*         slot);
1237
1238     /**
1239      * @brief Signal: Register properties.
1240      *
1241      * Register properties of the focused instance.
1242      *
1243      * slot prototype: void register_properties (const PropertyList &props);
1244      * - props -- The properties to be registered.
1245      */
1246     Connection signal_connect_register_properties (InfoManagerSlotPropertyList*        slot);
1247
1248     /**
1249      * @brief Signal: Update property.
1250      *
1251      * Update a property of the focused instance.
1252      *
1253      * slot prototype: void update_property (const Property &prop);
1254      * - prop -- The property to be updated.
1255      */
1256     Connection signal_connect_update_property (InfoManagerSlotProperty*            slot);
1257
1258     /**
1259      * @brief Signal: Register properties of a helper.
1260      *
1261      * slot prototype: void register_helper_properties (int id, const PropertyList &props);
1262      * - id    -- The client id of the helper object.
1263      * - props -- The properties to be registered.
1264      */
1265     Connection signal_connect_register_helper_properties (InfoManagerSlotIntPropertyList*     slot);
1266
1267     /**
1268      * @brief Signal: Update helper property.
1269      *
1270      * slot prototype: void update_helper_property (int id, const Property &prop);
1271      * - id   -- The client id of the helper object.
1272      * - prop -- The property to be updated.
1273      */
1274     Connection signal_connect_update_helper_property (InfoManagerSlotIntProperty*         slot);
1275
1276     /**
1277      * @brief Signal: Register a helper object.
1278      *
1279      * A newly started helper object will send this event to Panel.
1280      *
1281      * slot prototype: register_helper (int id, const HelperInfo &helper);
1282      * - id     -- The client id of the helper object.
1283      * - helper -- The information of the helper object.
1284      */
1285     Connection signal_connect_register_helper (InfoManagerSlotIntHelperInfo*       slot);
1286
1287     /**
1288      * @brief Signal: Remove a helper object.
1289      *
1290      * If a running helper close its connection to Panel, then this signal will be triggered to
1291      * tell Panel to remove all data associated to this helper.
1292      *
1293      * slot prototype: void remove_helper (int id);
1294      * - id -- The client id of the helper object to be removed.
1295      */
1296     Connection signal_connect_remove_helper (InfoManagerSlotInt*                 slot);
1297
1298     /**
1299      * @brief Signal: Start an ise with the speficied uuid
1300      *
1301      * slot prototype: void set_active_ise_by_uuid (const String& uuid);
1302      * - uuid -- the uuid of the ise object
1303      */
1304     Connection signal_connect_set_active_ise_by_uuid (InfoManagerSlotStringBool*          slot);
1305
1306     /**
1307      * @brief Signal: Focus in panel.
1308      *
1309      * slot prototype: void focus_in (void);
1310      */
1311     Connection signal_connect_focus_in (InfoManagerSlotVoid*                slot);
1312
1313     /**
1314      * @brief Signal: Focus out panel.
1315      *
1316      * slot prototype: void focus_out (void);
1317      */
1318     Connection signal_connect_focus_out (InfoManagerSlotVoid*                slot);
1319
1320     /**
1321      * @brief Signal: Expand candidate panel.
1322      *
1323      * slot prototype: void expand_candidate (void);
1324      */
1325     Connection signal_connect_expand_candidate (InfoManagerSlotVoid*                slot);
1326
1327     /**
1328      * @brief Signal: Contract candidate panel.
1329      *
1330      * slot prototype: void contract_candidate (void);
1331      */
1332     Connection signal_connect_contract_candidate (InfoManagerSlotVoid*                slot);
1333
1334     /**
1335      * @brief Signal: Select candidate string index.
1336      *
1337      * slot prototype: void select_candidate (int index);
1338      */
1339     Connection signal_connect_select_candidate (InfoManagerSlotInt*                 slot);
1340
1341     /**
1342      * @brief Signal: Get the list of ise name.
1343      *
1344      * slot prototype: bool get_ise_list (std::vector<String> &);
1345      */
1346     Connection signal_connect_get_ise_list (InfoManagerSlotBoolStringVector*    slot);
1347
1348     /**
1349      * @brief Signal: Get the info of all helper ise.
1350      *
1351      * slot prototype: bool get_all_helper_ise_info (HELPER_ISE_INFO &);
1352      */
1353     Connection signal_connect_get_all_helper_ise_info (InfoManagerSlotBoolHelperInfo*     slot);
1354
1355     /**
1356      * @brief Signal: Update "has_option" column of ime_info DB by Application ID
1357      *
1358      * slot prototype: void set_enable_helper_ise_info (const String &, bool );
1359      */
1360     Connection signal_connect_set_has_option_helper_ise_info (InfoManagerSlotStringBool*     slot);
1361
1362     /**
1363      * @brief Signal: Update "is_enable" column of ime_info DB by Application ID
1364      *
1365      * slot prototype: void set_enable_helper_ise_info (const String &, bool );
1366      */
1367     Connection signal_connect_set_enable_helper_ise_info (InfoManagerSlotStringBool*     slot);
1368
1369     /**
1370      * @brief Signal: Launch inputmethod-setting-list application
1371      *
1372      * slot prototype: void show_helper_ise_list (void);
1373      */
1374     Connection signal_connect_show_helper_ise_list (InfoManagerSlotVoid*       slot);
1375
1376     /**
1377      * @brief Signal: Launch inputmethod-setting-selector application
1378      *
1379      * slot prototype: void show_helper_ise_selector (void);
1380      */
1381     Connection signal_connect_show_helper_ise_selector (InfoManagerSlotVoid*   slot);
1382
1383     /**
1384      * @brief Signal: Checks if the specific IME is enabled or disabled in the system keyboard setting
1385      *
1386      * slot prototype: bool is_helper_ise_enabled (const String, int &);
1387      */
1388     Connection signal_connect_is_helper_ise_enabled (InfoManagerSlotStringInt*   slot);
1389
1390     /**
1391      * @brief Signal: Get the ISE information according to UUID.
1392      *
1393      * slot prototype: bool get_ise_information (String, String &, String &, int &, int &);
1394      */
1395     Connection signal_connect_get_ise_information (InfoManagerSlotBoolString4int2*     slot);
1396
1397     /**
1398      * @brief Signal: Get the list of selected language name.
1399      *
1400      * slot prototype: void get_language_list (std::vector<String> &);
1401      */
1402     Connection signal_connect_get_language_list (InfoManagerSlotStringVector*        slot);
1403
1404     /**
1405      * @brief Signal: Get the all languages name.
1406      *
1407      * slot prototype: void get_all_language (std::vector<String> &);
1408      */
1409     Connection signal_connect_get_all_language (InfoManagerSlotStringVector*        slot);
1410     /**
1411      * @brief Signal: Get the language list of a specified ise.
1412      *
1413      * slot prototype: void get_ise_language (char *, std::vector<String> &);
1414      */
1415     Connection signal_connect_get_ise_language (InfoManagerSlotStrStringVector*     slot);
1416
1417     /**
1418      * @brief Signal: Get the ise information by uuid.
1419      *
1420      * slot prototype: bool get_ise_info_by_uuid (const String &, ISE_INFO &);
1421      */
1422     Connection signal_connect_get_ise_info_by_uuid (InfoManagerSlotStringISEINFO*       slot);
1423
1424     /**
1425      * @brief Signal: send key event in panel.
1426      *
1427      * slot prototype: void send_key_event (const KeyEvent &);
1428      */
1429     Connection signal_connect_send_key_event (InfoManagerSlotKeyEvent*            slot);
1430
1431     /**
1432      * @brief Signal: A transaction is started.
1433      *
1434      * This signal infers that the Panel should disable update before this transaction finishes.
1435      *
1436      * slot prototype: void signal_connect_transaction_start (void);
1437      */
1438     Connection signal_connect_transaction_start (InfoManagerSlotVoid*                slot);
1439
1440     /**
1441      * @brief Signal: Accept connection for this InfoManager.
1442      *
1443      * slot prototype: void accept_connection (int fd);
1444      * - fd -- the file description for connection
1445      */
1446     Connection signal_connect_accept_connection (InfoManagerSlotInt*                 slot);
1447
1448     /**
1449      * @brief Signal: Close connection for this InfoManager.
1450      *
1451      * slot prototype: void close_connection (int fd);
1452      * - fd -- the file description for connection
1453      */
1454     Connection signal_connect_close_connection (InfoManagerSlotInt*                 slot);
1455
1456     /**
1457      * @brief Signal: Exit application for this InfoManager.
1458      *
1459      * slot prototype: void app_exit (void);
1460      */
1461     Connection signal_connect_exit (InfoManagerSlotVoid*                slot);
1462
1463     /**
1464      * @brief Signal: A transaction is finished.
1465      *
1466      * This signal will get emitted when a transaction is finished. This implys to re-enable
1467      * panel GUI update
1468      *
1469      * slot prototype: void signal_connect_transaction_end (void);
1470      */
1471     Connection signal_connect_transaction_end (InfoManagerSlotVoid*                slot);
1472
1473     /**
1474      * @brief Signal: Lock the exclusive lock for this InfoManager.
1475      *
1476      * The panel program should provide a thread lock and hook a slot into this signal to lock it.
1477      * InfoManager will use this lock to ensure the data integrity.
1478      *
1479      * slot prototype: void lock (void);
1480      */
1481     Connection signal_connect_lock (InfoManagerSlotVoid*                slot);
1482
1483     /**
1484      * @brief Signal: Unlock the exclusive lock for this InfoManager.
1485      *
1486      * slot prototype: void unlock (void);
1487      */
1488     Connection signal_connect_unlock (InfoManagerSlotVoid*                slot);
1489
1490     /**
1491      * @brief Signal: The input context of ISE is changed.
1492      *
1493      * slot prototype: void update_input_context (int type, int value);
1494      */
1495     Connection signal_connect_update_input_context (InfoManagerSlotIntInt*              slot);
1496
1497     /**
1498      * @brief Signal: Show ISE.
1499      *
1500      * slot prototype: void show_ise (void);
1501      */
1502     Connection signal_connect_show_ise (InfoManagerSlotVoid*                slot);
1503
1504     /**
1505      * @brief Signal: Hide ISE.
1506      *
1507      * slot prototype: void hide_ise (void);
1508      */
1509     Connection signal_connect_hide_ise (InfoManagerSlotVoid*                slot);
1510
1511     /**
1512      * @brief Signal: Notifies the client finished handling WILL_SHOW event
1513      *
1514      * slot prototype: void will_show_ack (void);
1515      */
1516     Connection signal_connect_will_show_ack (InfoManagerSlotVoid*                slot);
1517
1518     /**
1519      * @brief Signal: Notifies the client finished handling WILL_HIDE event
1520      *
1521      * slot prototype: void will_hide_ack (void);
1522      */
1523     Connection signal_connect_will_hide_ack (InfoManagerSlotVoid*                slot);
1524
1525     /**
1526      * @brief Signal: Set hardware mode
1527      *
1528      * slot prototype: void set_keyboard_mode (void);
1529      */
1530     Connection signal_connect_set_keyboard_mode (InfoManagerSlotInt*                 slot);
1531
1532     /**
1533      * @brief Signal: Notifies the client finished handling WILL_HIDE event for candidate
1534      *
1535      * slot prototype: void candidate_will_hide_ack (void);
1536      */
1537     Connection signal_connect_candidate_will_hide_ack (InfoManagerSlotVoid*                slot);
1538
1539     /**
1540      * @brief Signal: Get ISE state.
1541      *
1542      * slot prototype: void get_ise_state (int &state);
1543      */
1544     Connection signal_connect_get_ise_state (InfoManagerSlotInt2*                slot);
1545
1546     /**
1547      * @brief Signal: run helper.
1548      *
1549      * slot prototype: bool run_helper (const String &uuid, const String &config, const String &display);
1550      */
1551     Connection signal_connect_run_helper (InfoManagerSlotString3*                slot);
1552
1553     Connection signal_connect_launch_option_application (InfoManagerSlotBoolString*                slot);
1554
1555     /**
1556      * @brief Signal: Get the recent input panel geometry information.
1557      *
1558      * slot prototype: void get_recent_ise_geometry (int angle, rectinfo &info);
1559      */
1560     Connection signal_connect_get_recent_ise_geometry (InfoManagerSlotIntRect*             slot);
1561
1562     Connection signal_connect_check_privilege_by_sockfd  (InfoManagerSlotIntString2* slot);
1563
1564     Connection signal_connect_remoteinput_send_input_message (InfoManagerSlotStringBool*          slot);
1565
1566     Connection signal_connect_remoteinput_send_surrounding_text (InfoManagerSlotIntString*          slot);
1567 };
1568
1569 /**  @} */
1570
1571 } /* namespace scim */
1572
1573 #endif /* __ISF_INFO_MANAGER_H */
1574
1575 /*
1576 vi:ts=4:nowrap:ai:expandtab
1577 */