/usr/include/fcitx/candidate.h is in fcitx-libs-dev 1:4.2.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 | /***************************************************************************
* Copyright (C) 2011~2011 by CSSlayer *
* wengxt@gmail.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef FCITX_CANDIDATE_H
#define FCITX_CANDIDATE_H
#include <fcitx-utils/utarray.h>
#include <fcitx-config/fcitx-config.h>
#include <fcitx/ime.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxCandidateWord;
struct _FcitxCandidateWordList;
typedef INPUT_RETURN_VALUE(*FcitxCandidateWordCommitCallback)(void* arg, struct _FcitxCandidateWord* candWord);
/**
* @brief A Single Candidate Word
**/
typedef struct _FcitxCandidateWord {
/**
* @brief String display in the front
**/
char* strWord;
/**
* @brief String display before strWord
**/
char* strExtra;
/**
* @brief Callback when string is going to commit
**/
FcitxCandidateWordCommitCallback callback;
/**
* @brief Store the candidateWord Type
**/
FcitxMessageType wordType;
/**
* @brief Store the extra Type
**/
FcitxMessageType extraType;
/**
* @brief Pointer can identify where the candidatework come from
**/
void* owner;
/**
* @brief Store a candidateWord Specific data, usually index of input method data
**/
void* priv;
} FcitxCandidateWord;
/**
* @brief Initialize a word list, should only used by runtime
*
* @return _FcitxCandidateWordList*
**/
struct _FcitxCandidateWordList* FcitxCandidateWordNewList();
/**
* @brief Insert a candidate to position
*
* @param candList candidate word list
* @param candWord candidate word
* @param position position to insert
* @return void
**/
void FcitxCandidateWordInsert(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord, int position);
/**
* @brief add a candidate word at last
*
* @param candList candidate word list
* @param candWord candidate word
* @return void
**/
void FcitxCandidateWordAppend(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* @brief remove a candidate word from list
*
* @param candList candidate word list
* @param candWord candidate word
* @return void
*
* @since 4.2
**/
void FcitxCandidateWordRemove(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* @brief Get first of current page
*
* @param candList candidate word list
* @return FcitxCandidateWord* first candidate word of current page
**/
FcitxCandidateWord* FcitxCandidateWordGetCurrentWindow(struct _FcitxCandidateWordList* candList);
/**
* @brief get next word of current page, useful when you want to iteration over current candidate words
*
* @param candList candidate word list
* @param candWord current cand word
* @return FcitxCandidateWord* next cand word
**/
FcitxCandidateWord* FcitxCandidateWordGetCurrentWindowNext(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* @brief get candidate word by index
*
* @param candList candidate word list
* @param index index of current page
* @return FcitxCandidateWord*
**/
FcitxCandidateWord* FcitxCandidateWordGetByIndex(struct _FcitxCandidateWordList* candList, int index);
/**
* @brief do the candidate word selection, will trigger the candidate word callback
*
* @param candList candidate word list
* @param index index of current page
* @return INPUT_RETURN_VALUE
**/
INPUT_RETURN_VALUE FcitxCandidateWordChooseByIndex(struct _FcitxCandidateWordList* candList, int index);
/**
* @brief Free a candidate word, used by utarray
*
* @param arg candidateWord
* @return void
**/
void FcitxCandidateWordFree(void* arg);
/**
* @brief check candidate word has next page or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordHasNext(struct _FcitxCandidateWordList* candList);
/**
* @brief check candidate word has prev page or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordHasPrev(struct _FcitxCandidateWordList* candList);
/**
* @brief get number of total page
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordPageCount(struct _FcitxCandidateWordList* candList);
/**
* @brief clear all candidate words
*
* @param candList candidate word list
* @return void
**/
void FcitxCandidateWordReset(struct _FcitxCandidateWordList* candList);
/**
* @brief go to prev page, return operation successful or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordGoPrevPage(struct _FcitxCandidateWordList* candList);
/**
* @brief go to next page, return operation successful or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordGoNextPage(struct _FcitxCandidateWordList* candList);
/**
* @brief set the select key string, length up to 10, usually "1234567890"
*
* @param candList candidate word list
* @param strChoose select key string
* @return void
**/
void FcitxCandidateWordSetChoose(struct _FcitxCandidateWordList* candList, const char* strChoose);
/**
* @brief set the select key string, length up to 10, usually "1234567890"
*
* @param candList candidate word list
* @param strChoose select key string
* @param state keystate
* @return void
**/
void FcitxCandidateWordSetChooseAndModifier(struct _FcitxCandidateWordList* candList, const char* strChoose, unsigned int state);
/**
* @brief get the select key string
*
* @param candList candidate word list
* @return void
**/
const char* FcitxCandidateWordGetChoose(struct _FcitxCandidateWordList* candList);
/**
* @brief get select key state
*
* @param candList candidate word list
* @return unsigned int
**/
unsigned int FcitxCandidateWordGetModifier(struct _FcitxCandidateWordList* candList);
/**
* @brief resize the candidate word length
*
* @param candList candidate word list
* @param length new length
* @return void
**/
void FcitxCandidateWordResize(struct _FcitxCandidateWordList* candList, int length);
/**
* @brief Get current page size of candidate list
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetPageSize(struct _FcitxCandidateWordList* candList);
/**
* @brief Set current page size of candidate list
*
* @param candList candidate word list
* @param size new page size
* @return void
**/
void FcitxCandidateWordSetPageSize(struct _FcitxCandidateWordList* candList, int size);
/**
* @brief get current page number
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetCurrentPage(struct _FcitxCandidateWordList* candList);
/**
* @brief get current page window size, may less than max page size
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetCurrentWindowSize(struct _FcitxCandidateWordList* candList);
/**
* @brief get total candidate word count
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetListSize(struct _FcitxCandidateWordList* candList);
/**
* @brief get first candidate word
*
* @param candList candidate word list
* @return FcitxCandidateWord*
**/
FcitxCandidateWord* FcitxCandidateWordGetFirst(struct _FcitxCandidateWordList* candList);
/**
* @brief get next candidate word, useful when want to iterate over whole list
*
* @param candList candidate word list
* @param candWord current candidate word
* @return FcitxCandidateWord*
**/
FcitxCandidateWord* FcitxCandidateWordGetNext(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
#define DIGIT_STR_CHOOSE "1234567890"
#ifdef __cplusplus
}
#endif
#endif
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|