/usr/include/fcitx/candidate.h is in fcitx-libs-dev 1:4.2.9.1-1ubuntu1.
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 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 | /***************************************************************************
* Copyright (C) 2011~2012 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. *
***************************************************************************/
/**
* @addtogroup Fcitx
* @{
*/
/**
* @file candidate.h
*
* Fcitx candidate word list related definition and function
*/
#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
/** max candidate word number for single page */
#define MAX_CAND_WORD 10
struct _FcitxCandidateWord;
struct _FcitxCandidateWordList;
/**
* a hint to let the candidate list to show with specific layout
*
* it's only a soft hint for UI, it depends on UI implement it or not
*
* and it will be automatically reset to CLH_NotSet when Reset Candidate List
*
* @since 4.2.7
*/
typedef enum _FcitxCandidateLayoutHint {
CLH_NotSet,
CLH_Vertical,
CLH_Horizontal
} FcitxCandidateLayoutHint;
/** fcitx candidate workd list */
typedef struct _FcitxCandidateWordList FcitxCandidateWordList;
/** callback for a single candidate word being chosen */
typedef INPUT_RETURN_VALUE(*FcitxCandidateWordCommitCallback)(void* arg, struct _FcitxCandidateWord* candWord);
/**
* A Single Candidate Word
**/
typedef struct _FcitxCandidateWord {
/**
* String display in the front
**/
char* strWord;
/**
* String display after strWord
**/
char* strExtra;
/**
* Callback when string is going to commit
**/
FcitxCandidateWordCommitCallback callback;
/**
* Store the candidateWord Type
**/
FcitxMessageType wordType;
/**
* Store the extra Type
**/
FcitxMessageType extraType;
/**
* Pointer can identify where the candidatework come from
**/
void* owner;
/**
* Store a candidateWord Specific data, usually index of input method data
**/
void* priv;
} FcitxCandidateWord;
/**
* Initialize a word list
*
* @return Word List
**/
struct _FcitxCandidateWordList* FcitxCandidateWordNewList();
/**
* Free a word list
*
* @param list list to free
* @return void
*/
void FcitxCandidateWordFreeList(struct _FcitxCandidateWordList* list);
/**
* Insert a candidate to position
*
* @param candList candidate word list
* @param candWord candidate word
* @param position position to insert
* @return void
**/
void FcitxCandidateWordInsert(FcitxCandidateWordList* candList,
FcitxCandidateWord* candWord, int position);
/**
* Merge newList into candList at a certain position
* (newList will be cleared)
*
* @param candList candidate words list
* @param newList candidate words list to be inserted
* @param position position to insert (less than 0 to append)
* @return void
*
* @since 4.2.6
**/
void FcitxCandidateWordMerge(FcitxCandidateWordList* candList,
FcitxCandidateWordList* newList,
int position);
/**
* Insert non-display place holder candidate to position
*
* @param candList candidate word list
* @param position position to insert
* @return void
**/
void FcitxCandidateWordInsertPlaceHolder(struct _FcitxCandidateWordList* candList, int position);
/**
* move candidate word via shift policy, for example
* 1, 2, 3, move from 0 to 2, result is 2, 3, 1
* 1, 2, 3, move from 2 to 0, result is 3, 1, 2
*
* @param candList candidate word list
* @param from from position
* @param to to position
*
* @since 4.2.5
**/
void FcitxCandidateWordMove(FcitxCandidateWordList* candList, int from, int to);
/**
* @param candList candidate word list
* @param from from position
* @param to to position
*
* @see FcitxCandidateWordMove
*
* @since 4.2.5
**/
void FcitxCandidateWordMoveByWord(FcitxCandidateWordList* candList, FcitxCandidateWord* candWord, int to);
/**
* add a candidate word at last
*
* @param candList candidate word list
* @param candWord candidate word
* @return void
**/
void FcitxCandidateWordAppend(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* 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);
/**
* remove a candidate word at certain index from list
*
* @param candList candidate word list
* @param idx index of the word to be removed
* @return void
*
* @since 4.2.6
**/
void FcitxCandidateWordRemoveByIndex(FcitxCandidateWordList *candList,
int idx);
/**
* set page by index
*
* @param candList candidate word list
* @param index page index
* @return void
*
* @since 4.2.5
**/
void FcitxCandidateWordSetPage(struct _FcitxCandidateWordList* candList, int index);
/**
* set page by word index
*
* @param candList candidate word list
* @param index index of candidate word
* @return void
*
* @since 4.2.1
**/
void FcitxCandidateWordSetFocus(struct _FcitxCandidateWordList* candList, int index);
/**
* Get index of the first word on current page
*
* @param candList candidate word list
* @return int index of the current word
*
* @since 4.2.5
**/
int FcitxCandidateWordGetCurrentIndex(struct _FcitxCandidateWordList* candList);
/**
* Get the first word on current page
*
* @param candList candidate word list
* @return FcitxCandidateWord* first candidate word of current page
**/
FcitxCandidateWord* FcitxCandidateWordGetCurrentWindow(struct _FcitxCandidateWordList* candList);
/**
* 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);
/**
* get prev 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* prev cand word
*
* @since 4.2.7
**/
FcitxCandidateWord* FcitxCandidateWordGetCurrentWindowPrev(struct _FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* get candidate word by total index
*
* @param candList candidate word list
* @param index index of word
* @return FcitxCandidateWord*
*
* @since 4.2.5
**/
FcitxCandidateWord* FcitxCandidateWordGetByTotalIndex(struct _FcitxCandidateWordList* candList, int index);
/**
* get the index of the candidate word
*
* @param candList candidate word list
* @param FcitxCandidateWord*
* @return index index of word
*
* @since 4.2.7
**/
int FcitxCandidateWordGetIndex(FcitxCandidateWordList *candList,
FcitxCandidateWord *word);
/**
* get candidate word by index within current page
*
* @param candList candidate word list
* @param index index of word on current page
* @return FcitxCandidateWord*
**/
FcitxCandidateWord* FcitxCandidateWordGetByIndex(struct _FcitxCandidateWordList* candList, int index);
/**
* 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);
/**
* 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
*
* @since 4.2.7
**/
INPUT_RETURN_VALUE FcitxCandidateWordChooseByTotalIndex(struct _FcitxCandidateWordList* candList, int index);
/**
* Free a candidate word, used by utarray
*
* @param arg candidateWord
* @return void
**/
void FcitxCandidateWordFree(void* arg);
/**
* check candidate word has next page or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordHasNext(struct _FcitxCandidateWordList* candList);
/**
* check candidate word has prev page or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordHasPrev(struct _FcitxCandidateWordList* candList);
/**
* get number of total page
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordPageCount(struct _FcitxCandidateWordList* candList);
/**
* clear all candidate words
*
* @param candList candidate word list
* @return void
**/
void FcitxCandidateWordReset(struct _FcitxCandidateWordList* candList);
/**
* go to prev page, return operation successful or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordGoPrevPage(struct _FcitxCandidateWordList* candList);
/**
* go to next page, return operation successful or not
*
* @param candList candidate word list
* @return boolean
**/
boolean FcitxCandidateWordGoNextPage(struct _FcitxCandidateWordList* candList);
/**
* 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);
/**
* 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);
/**
* get the select key string
*
* @param candList candidate word list
* @return const char* select key string
**/
const char* FcitxCandidateWordGetChoose(struct _FcitxCandidateWordList* candList);
/**
* get select key state
*
* @param candList candidate word list
* @return unsigned int
**/
unsigned int FcitxCandidateWordGetModifier(struct _FcitxCandidateWordList* candList);
/**
* resize the candidate word length
*
* @param candList candidate word list
* @param length new length
* @return void
**/
void FcitxCandidateWordResize(struct _FcitxCandidateWordList* candList, int length);
/**
* Get current page size of candidate list
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetPageSize(struct _FcitxCandidateWordList* candList);
/**
* 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);
/**
* get current page number
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetCurrentPage(struct _FcitxCandidateWordList* candList);
/**
* get current page window size, may less than max page size
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetCurrentWindowSize(struct _FcitxCandidateWordList* candList);
/**
* get total candidate word count
*
* @param candList candidate word list
* @return int
**/
int FcitxCandidateWordGetListSize(struct _FcitxCandidateWordList* candList);
/**
* check this have been goto prev page or not
*
* @param candList candidate word list
* @return boolean
*/
boolean FcitxCandidateWordGetHasGoneToPrevPage(FcitxCandidateWordList* candList);
/**
* check this have been goto next page or not
*
* @param candList candidate word list
* @return boolean
*/
boolean FcitxCandidateWordGetHasGoneToNextPage(FcitxCandidateWordList* candList);
/**
* get first candidate word
*
* @param candList candidate word list
* @return FcitxCandidateWord*
**/
FcitxCandidateWord *FcitxCandidateWordGetFirst(FcitxCandidateWordList *candList);
/**
* get last candidate word
*
* @param candList candidate word list
* @return FcitxCandidateWord*
*
* @since 4.2.7
**/
FcitxCandidateWord *FcitxCandidateWordGetLast(FcitxCandidateWordList *candList);
/**
* 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(FcitxCandidateWordList* candList, FcitxCandidateWord* candWord);
/**
* get previous candidate word
*
* @param candList candidate word list
* @param candWord current candidate word
* @return FcitxCandidateWord*
*
* @since 4.2.7
**/
FcitxCandidateWord *FcitxCandidateWordGetPrev(FcitxCandidateWordList *candList, FcitxCandidateWord *candWord);
/**
* check is choose key or not, if so, return the choose index
*
* @param candList candidate words
* @param sym keysym
* @param state keystate
* @return int
*
* @since 4.2.6
**/
int FcitxCandidateWordCheckChooseKey(FcitxCandidateWordList *candList,
FcitxKeySym sym, unsigned int state);
/**
* Set Candidate word layout hint
*
* @param candList candidate words
* @param hint layout hint
* @return void
*
* @since 4.2.7
*/
void FcitxCandidateWordSetLayoutHint(FcitxCandidateWordList* candList, FcitxCandidateLayoutHint hint);
/**
* Get Candidate word layout hint
*
* @param candList candidate words
* @return layout hint
*
* @since 4.2.7
*/
FcitxCandidateLayoutHint FcitxCandidateWordGetLayoutHint(FcitxCandidateWordList* candList);
typedef boolean (*FcitxPaging)(void* arg, boolean prev);
/**
* override default paging
*
* @param candList candidate words
* @param hasPrev has prev page
* @param hasNext has next page
* @param paging callback
* @param arg arg
* @param destroyNotify destroyNotify
* @return void
*
* @since 4.2.7
**/
void FcitxCandidateWordSetOverridePaging(FcitxCandidateWordList* candList,
boolean hasPrev,
boolean hasNext,
FcitxPaging paging,
void* arg,
FcitxDestroyNotify destroyNotify
);
/**
* override default highlight
*
* @param candList candidate words
* @param overrideValue value
*
* @since 4.2.8
*/
void FcitxCandidateWordSetOverrideDefaultHighlight(FcitxCandidateWordList* candList, boolean overrideValue);
/** convinient string for candidate word */
#define DIGIT_STR_CHOOSE "1234567890"
static inline void
FcitxCandidateWordSetType(FcitxCandidateWord *cand_word,
FcitxMessageType type)
{
cand_word->wordType = (FcitxMessageType)((cand_word->wordType &
~MSG_REGULAR_MASK) | type);
}
static inline boolean
FcitxCandidateWordCheckFocus(FcitxCandidateWord *cand_word, boolean clear)
{
if ((cand_word->wordType & MSG_REGULAR_MASK) == MSG_CANDIATE_CURSOR) {
if (clear)
FcitxCandidateWordSetType(cand_word, MSG_OTHER);
return true;
}
return false;
}
FcitxCandidateWord *FcitxCandidateWordGetFocus(
FcitxCandidateWordList *cand_list, boolean clear);
#ifdef __cplusplus
}
#endif
#endif
/**
* @}
*/
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|