wrapper/ibus/src/sunpinyin_lookup_table.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_LOOKUP_TABLE_H
  37 #define SUNPINYIN_LOOKUP_TABLE_H
  38
  39 #include <ibus.h>
  40 #include "ibus_common.h"
  41
  42 class ICandidateList;
  43
  44 /**
  45  * a helper class to maintain the IBusLookupTable
  46  */
  47 class SunPinyinLookupTable : public ibus::LookupTable
  48 {
  49 public:
  50     SunPinyinLookupTable();
  51     virtual ~SunPinyinLookupTable();
  52     /**
  53      * update lookup table with given candidate list
  54      * @param cl candidate list
  55      * @return the number of candidates updated
  56      */
  57     int update_candidates(const ICandidateList& cl);
  58     bool cursor_up();
  59     bool cursor_down();
  60     size_t get_cursor_pos() const;
  61
  62 private:
  63     /**
  64      * set the candidate in lookup table
  65      * @param cl the candidate list including all available candidates in current page
  66      * @param index the candidate's index in page
  67      * @param begin the begin position in candidates
  68      * @return the length of candidate string
  69      */
  70     int append_candidate(const ICandidateList& cl, int index, int begin);
  71
  72     /**
  73      * get the index of current page's start point
  74      * @return the index where current page starts
  75      */
  76     int get_current_page_start() const;
  77
  78     /**
  79      * update text's attributes according to the type of candidate
  80      * @param text
  81      * @param type
  82      */
  83     void decorate_candidate(ibus::Text text, int type);
  84 };
  85
  86 #endif // SUNPINYIN_LOOKUP_TABLE_H