wrapper/ibus/src/sunpinyin_engine.h

   1 /*
   2  * Copyright (c) 2009 Kov Chai <tchaikov@gmail.com>
   3  *
   4  * The contents of this file are subject to the terms of either the GNU Lesser
   5  * General Public License Version 2.1 only ("LGPL") or the Common Development and
   6  * Distribution License ("CDDL")(collectively, the "License"). You may not use this
   7  * file except in compliance with the License. You can obtain a copy of the CDDL at
   8  * http://www.opensource.org/licenses/cddl1.php and a copy of the LGPLv2.1 at
   9  * http://www.opensource.org/licenses/lgpl-license.php. See the License for the
  10  * specific language governing permissions and limitations under the License. When
  11  * distributing the software, include this License Header Notice in each file and
  12  * include the full text of the License in the License file as well as the
  13  * following notice:
  14  *
  15  * NOTICE PURSUANT TO SECTION 9 OF THE COMMON DEVELOPMENT AND DISTRIBUTION LICENSE
  16  * (CDDL)
  17  * For Covered Software in this distribution, this License shall be governed by the
  18  * laws of the State of California (excluding conflict-of-law provisions).
  19  * Any litigation relating to this License shall be subject to the jurisdiction of
  20  * the Federal Courts of the Northern District of California and the state courts
  21  * of the State of California, with venue lying in Santa Clara County, California.
  22  *
  23  * Contributor(s):
  24  *
  25  * If you wish your version of this file to be governed by only the CDDL or only
  26  * the LGPL Version 2.1, indicate your decision by adding "[Contributor]" elects to
  27  * include this software in this distribution under the [CDDL or LGPL Version 2.1]
  28  * license." If you don't indicate a single choice of license, a recipient has the
  29  * option to distribute your version of this file under either the CDDL or the LGPL
  30  * Version 2.1, or to extend the choice of license to its licensees as provided
  31  * above. However, if you add LGPL Version 2.1 code and therefore, elected the LGPL
  32  * Version 2 license, then the option applies only if the new code is made subject
  33  * to such option by the copyright holder.
  34  */
  35
  36 #ifndef SUNPINYIN_ENGINE_H
  37 #define SUNPINYIN_ENGINE_H
  38
  39 #include <string>
  40 #include <ibus.h>
  41 #include <ime-core/imi_option_event.h>
  42 #include "sunpinyin_config.h"
  43 #include "sunpinyin_property.h"
  44 #include "sunpinyin_lookup_table.h"
  45
  46 class ICandidateList;
  47 class IPreeditString;
  48 class CIBusWinHandler;
  49 class CIMIView;
  50 class CHotkeyProfile;
  51
  52 class SunPinyinEngine : public IConfigurable
  53 {
  54 public:
  55     SunPinyinEngine(IBusEngine *);
  56     virtual ~SunPinyinEngine();
  57
  58     void init ();
  59     void destroy ();
  60     /* @{ */
  61     gboolean process_key_event (guint key_val, guint key_code, guint modifiers);
  62     void focus_in ();
  63     void focus_out ();
  64     void reset ();
  65     void enable ();
  66     void disable ();
  67     void page_up ();
  68     void page_down ();
  69     void cursor_up ();
  70     void cursor_down ();
  71     void commit_string (const std::wstring&);
  72     void property_activate (const std::string& name, unsigned state = PROP_STATE_UNCHECKED);
  73     void candidate_clicked (guint index);
  74     /* @} */
  75
  76     /* helpers for @ref CIBusWinHandler */
  77     /* @{ */
  78     void update_candidates(const ICandidateList&);
  79     void update_preedit_string(const IPreeditString&);
  80     void update_status_property(bool);
  81     void update_punct_property(bool);
  82     void update_letter_property(bool);
  83     /* @} */
  84
  85     /* for implemented class */
  86     bool is_valid() const;
  87
  88     virtual bool onConfigChanged(const COptionEvent& event);
  89
  90 private:
  91     void update_config();
  92     void update_history_power();
  93     void update_cand_window_size();
  94     void update_mode_key();
  95     void update_punct_key();
  96     void update_page_key_minus();
  97     void update_page_key_comma();
  98     void update_page_key_bracket();
  99     void update_page_key(const char* conf_key, bool default_val,
 100                          unsigned page_up, unsigned page_down);
 101     void update_candi_delete_key();
 102     void update_cancel_with_backspace();
 103     void update_smart_punc();
 104     void update_max_best();
 105     void update_max_tail_candidate();
 106
 107     void update_charset_level();
 108     void update_user_data_dir();
 109     void update_punct_mappings();
 110     void update_fuzzy_pinyins();
 111     void update_correction_pinyins();
 112     void update_fuzzy_segs();
 113     void update_shuangpin_type();
 114
 115     void update_lookup_table();
 116
 117 private:
 118     ibus::Engine           m_engine;
 119     ibus::PropList         m_prop_list;
 120
 121     SunPinyinProperty m_status_prop;
 122     SunPinyinProperty m_letter_prop;
 123     SunPinyinProperty m_punct_prop;
 124     SetupLauncher     m_setup_prop;
 125
 126     SunPinyinLookupTable m_lookup_table;
 127
 128     CIBusWinHandler *m_wh;
 129     CIMIView        *m_pv;
 130     CHotkeyProfile  *m_hotkey_profile;
 131
 132     SunPinyinConfig  m_config;
 133 };
 134
 135 #endif // SUNPINYIN_ENGINE_H