/usr/include/fcitx/ui.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 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 617 618 619 620 621 622 623 624 625 626 627 628 629 630 | /***************************************************************************
* Copyright (C) 2010~2010 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_UI_H_
#define _FCITX_UI_H_
#include <stdarg.h>
#include <fcitx/fcitx.h>
#include <fcitx-config/fcitx-config.h>
#include <fcitx-utils/utf8.h>
#include <fcitx-utils/utarray.h>
#ifdef __cplusplus
extern "C" {
#endif
#define INPUTWND_START_POS_DOWN 8
#define MESSAGE_MAX_CHARNUM (150) //输入条上显示的最长字数
#define MESSAGE_MAX_LENGTH (MESSAGE_MAX_CHARNUM*UTF8_MAX_LENGTH) //输入条上显示的最长长度,以字符计
/* 将输入条上显示的内容分为以下几类 */
#define MESSAGE_TYPE_COUNT 7
#define MAX_MESSAGE_COUNT 64
typedef struct _FcitxMenuItem FcitxMenuItem;
struct _FcitxUIMenu;
typedef enum _FcitxMenuState {
MENU_ACTIVE = 0,
MENU_INACTIVE = 1
} FcitxMenuState;
typedef enum _FcitxMenuItemType {
MENUTYPE_SIMPLE,
MENUTYPE_SUBMENU,
MENUTYPE_DIVLINE
} FcitxMenuItemType;
typedef boolean (*FcitxMenuActionFunction)(struct _FcitxUIMenu *arg, int index);
typedef void (*FcitxUpdateMenuFunction)(struct _FcitxUIMenu *arg);
/**
* @brief a menu entry in a menu.
**/
struct _FcitxMenuItem {
/**
* @brief The displayed string
**/
char *tipstr;
/**
* @brief Can be used by ui to mark it's selected or not.
**/
int isselect;
/**
* @brief The type of menu shell
**/
FcitxMenuItemType type;
/**
* @brief the submenu to this entry
**/
struct _FcitxUIMenu *subMenu;
int padding[16];
};
/**
* @brief Fcitx Menu Component, a UI doesn't need to support it,
* This struct is used by other module to register a menu.
**/
struct _FcitxUIMenu {
/**
* @brief shell entries for this menu
**/
UT_array shell;
/**
* @brief menu name, can be displayed on the ui
**/
char *name;
/**
* @brief you might want to bind the menu on a status icon, but this is only a hint,
* depends on the ui implementation
**/
char *candStatusBind;
/**
* @brief update the menu content
**/
FcitxUpdateMenuFunction UpdateMenu;
/**
* @brief function for process click on a menu entry
**/
FcitxMenuActionFunction MenuAction;
/**
* @brief private data for this menu
**/
void *priv;
/**
* @brief ui implementation private
**/
void *uipriv[2];
/**
* @brief this is sub menu or not
**/
boolean isSubMenu;
/**
* @brief mark of this menu
**/
int mark;
int padding[16];
};
/**
* @brief Fcitx Status icon to be displayed on the UI
**/
struct _FcitxUIStatus {
/**
* @brief status name, will not displayed on the UI.
**/
char *name;
/**
* @brief short desription for this status, can be displayed on the UI
**/
char *shortDescription;
/**
* @brief long description for this status, can be displayed on the UI
**/
char *longDescription;
/**
* @brief toogle function
**/
void (*toggleStatus)(void *arg);
/**
* @brief get current value function
**/
boolean(*getCurrentStatus)(void *arg);
/**
* @brief private data for the UI implementation
**/
void *uipriv[2];
/**
* @brief extra argument for tooglefunction
**/
void* arg;
/**
* @brief visible
*/
boolean visible;
int padding[16];
};
typedef enum _FcitxUIFlag {
UI_NONE = 0,
UI_MOVE = (1 << 1),
UI_UPDATE = (1 << 2),
} FcitxUIFlag;
struct _FcitxInstance;
typedef enum _FcitxMessageType {
MSG_TYPE_FIRST = 0,
MSG_TYPE_LAST = 6,
MSG_TIPS = 0, //提示文本
MSG_INPUT = 1, //用户的输入
MSG_INDEX = 2, //候选字前面的序号
MSG_FIRSTCAND = 3, //第一个候选字
MSG_USERPHR = 4, //用户词组
MSG_CODE = 5, //显示的编码
MSG_OTHER = 6, //其它文本
} FcitxMessageType;
typedef struct _FcitxMessages FcitxMessages;
struct _FcitxAddon;
typedef struct _FcitxUIMenu FcitxUIMenu;
typedef struct _FcitxUIStatus FcitxUIStatus;
/**
* @brief user interface implementation
**/
typedef struct _FcitxUI {
/**
* @brief construct function for this ui
*/
void* (*Create)(struct _FcitxInstance*);
/**
* @brief close the input window
*/
void (*CloseInputWindow)(void *arg);
/**
* @brief show the input window
*/
void (*ShowInputWindow)(void *arg);
/**
* @brief move the input window
*/
void (*MoveInputWindow)(void *arg);
/**
* @brief action on update status
*/
void (*UpdateStatus)(void *arg, FcitxUIStatus*);
/**
* @brief action on register status
*/
void (*RegisterStatus)(void *arg, FcitxUIStatus*);
/**
* @brief action on register menu
*/
void (*RegisterMenu)(void *arg, FcitxUIMenu*);
/**
* @brief action on focus
*/
void (*OnInputFocus)(void *arg);
/**
* @brief action on unfocus
*/
void (*OnInputUnFocus)(void *arg);
/**
* @brief action on trigger on
*/
void (*OnTriggerOn)(void *arg);
/**
* @brief action on trigger off
*/
void (*OnTriggerOff)(void *arg);
/**
* @brief display a message is ui support it
*/
void (*DisplayMessage)(void *arg, char *title, char **msg, int length);
/**
* @brief get the main window size if ui support it
*/
void (*MainWindowSizeHint)(void *arg, int* x, int* y, int* w, int* h);
/**
* @brief reload config
*/
void (*ReloadConfig)(void*);
/**
* @brief suspend to switch from/to fallback
*/
void (*Suspend)(void*);
/**
* @brief resume from suspend
*/
void (*Resume)(void*);
void (*Destroy)(void*);
void (*padding1)(void*);
void (*padding2)(void*);
void (*padding3)(void*);
} FcitxUI;
/**
* @brief load user interface module
*
* @param instance fcitx instance
* @return void
**/
void FcitxUILoad(struct _FcitxInstance* instance);
/**
* @brief init messages
*
* @return FcitxMessages*
**/
FcitxMessages* FcitxMessagesNew();
/**
* @brief add a message string at last
*
* @param message message
* @param type message type
* @param fmt printf fmt
* @param ...
* @return void
**/
void FcitxMessagesAddMessageAtLast(FcitxMessages* message, FcitxMessageType type, const char *fmt, ...);
/**
* @brief set a message string at position
*
* @param message message
* @param position position
* @param type message type
* @param fmt printf fmt
* @param ...
* @return void
**/
void FcitxMessagesSetMessage(FcitxMessages* message, int position, FcitxMessageType type, const char* fmt, ...);
/**
* @brief set only message string
*
* @param message message
* @param position position
* @param fmt printf format
* @param ...
* @return void
**/
void FcitxMessagesSetMessageText(FcitxMessages* message, int position, const char* fmt, ...);
/**
* @brief concat a string to message string at position
*
* @param message message
* @param position position
* @param text string
* @return void
**/
void FcitxMessagesMessageConcat(FcitxMessages* message, int position, const char* text);
/**
* @brief concat a string to message string at last
*
* @param message message
* @param text string
* @return void
**/
void FcitxMessagesMessageConcatLast(FcitxMessages* message, const char* text);
/**
* @brief set message string vprintf version
*
* @param message message
* @param position position
* @param type message type
* @param fmt printf format
* @param ap arguments
* @return void
**/
void FcitxMessagesSetMessageV(FcitxMessages* message, int position, FcitxMessageType type, const char* fmt, va_list ap);
/**
* @brief set message count
*
* @param m message
* @param s count
* @return void
**/
void FcitxMessagesSetMessageCount(FcitxMessages* m, int s);
/**
* @brief get message count
*
* @param m message
* @return int
**/
int FcitxMessagesGetMessageCount(FcitxMessages* m);
/**
* @brief get message string at index
*
* @param m message
* @param index index
* @return char*
**/
char* FcitxMessagesGetMessageString(FcitxMessages* m, int index);
/**
* @brief get message type at index
*
* @param m message
* @param index index
* @return FcitxMessageType
**/
FcitxMessageType FcitxMessagesGetMessageType(FcitxMessages* m, int index);
/**
* @brief check whether message is changed
*
* @param m message
* @return boolean
**/
boolean FcitxMessagesIsMessageChanged(FcitxMessages* m);
/**
* @brief set message is changed or not
*
* @param m message
* @param changed changed or not
* @return void
**/
void FcitxMessagesSetMessageChanged(FcitxMessages* m, boolean changed);
/**
* @brief add a new menu shell
*
* @param menu menu
* @param string menu text
* @param type menu type
* @param subMenu submenu pointer
* @return void
**/
void FcitxMenuAddMenuItem(FcitxUIMenu* menu, char* string, FcitxMenuItemType type, FcitxUIMenu* subMenu);
/**
* @brief clear all menu shell
*
* @param menu menu
* @return void
**/
void FcitxMenuClear(FcitxUIMenu* menu);
/**
* @brief move input to cursor position
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIMoveInputWindow(struct _FcitxInstance* instance);
/**
* @brief close input window
*
* @param instance fcitx instance
* @return void
**/
void FcitxUICloseInputWindow(struct _FcitxInstance* instance);
/**
* @brief toggle a user interface status
*
* @param instance fcitx instance
* @param name status name
* @return void
**/
void FcitxUIUpdateStatus(struct _FcitxInstance* instance, const char* name);
/**
* @brief register a new ui status
*
* @param instance fcitx instance
* @param arg private data, pass to callback
* @param name name
* @param shortDesc short description
* @param longDesc long description
* @param toggleStatus callback for toggle status
* @param getStatus get current status
* @return void
**/
void FcitxUIRegisterStatus(struct _FcitxInstance* instance,
void* arg,
const char* name,
const char* shortDesc,
const char* longDesc,
void (*toggleStatus)(void *arg),
boolean(*getStatus)(void *arg));
/**
* @brief register a new menu
*
* @param instance fcitx instance
* @param menu menu
* @return void
**/
void FcitxUIRegisterMenu(struct _FcitxInstance* instance, FcitxUIMenu* menu);
/**
* @brief process focus in event
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIOnInputFocus(struct _FcitxInstance* instance);
/**
* @brief process focus out event
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIOnInputUnFocus(struct _FcitxInstance* instance);
/**
* @brief process trigger on event
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIOnTriggerOn(struct _FcitxInstance* instance);
/**
* @brief process trigger off event
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIOnTriggerOff(struct _FcitxInstance* instance);
/**
* @brief if user interface support, display a message window on the screen
*
* @param instance fcitx instance
* @param title window title
* @param msg message
* @param length length or message
* @return void
**/
void FcitxUIDisplayMessage(struct _FcitxInstance *instance, char *title, char **msg, int length);
/**
* @brief get status by status name
*
* @param instance fcitx instance
* @param name status name
* @return FcitxUIStatus*
**/
FcitxUIStatus *FcitxUIGetStatusByName(struct _FcitxInstance* instance, const char* name);
/**
* @brief set visibility for a status icon
*
* @param instance fcitx instance
* @param name name
* @param visible visibility
* @return void
**/
void FcitxUISetStatusVisable(struct _FcitxInstance* instance, const char* name, boolean visible);
/**
* @brief update menu shell of a menu
*
* @param menu menu
* @return void
**/
void FcitxMenuUpdate(FcitxUIMenu* menu);
/**
* @brief check point is in rectangle or not
*
* @param x0 point x
* @param y0 point y
* @param x1 rectangle x
* @param y1 rectangle y
* @param w rectangle width
* @param h rectangle height
* @return boolean
**/
boolean FcitxUIIsInBox(int x0, int y0, int x1, int y1, int w, int h);
/**
* @brief check user interface support main window or not
*
* @param instance fcitx instance
* @return boolean
**/
boolean FcitxUISupportMainWindow(struct _FcitxInstance* instance);
/**
* @brief get main window geometry property if there is a main window
*
* @param instance fcitx instance
* @param x x
* @param y y
* @param w w
* @param h h
* @return void
**/
void FcitxUIGetMainWindowSize(struct _FcitxInstance* instance, int* x, int* y, int* w, int* h);
/**
* @brief convert new messages to old up and down style messages, return the new cursos pos
*
* @param instance fcitx instance
* @param msgUp messages up
* @param msgDown messages up
* @return int
**/
int FcitxUINewMessageToOldStyleMessage(struct _FcitxInstance* instance, FcitxMessages* msgUp, FcitxMessages* msgDown);
/**
* @brief convert messages to pure c string
*
* @param messages messages
* @return char*
**/
char* FcitxUIMessagesToCString(FcitxMessages* messages);
/**
* @brief convert candidate words to a string which can direct displayed
*
* @param instance fcitx instance
* @return char*
**/
char* FcitxUICandidateWordToCString(struct _FcitxInstance* instance);
/**
* @brief mark input window should update
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIUpdateInputWindow(struct _FcitxInstance* instance);
/**
* @brief User interface should switch to the fallback
*
* @param instance fcitx instance
* @return void
**/
void FcitxUISwitchToFallback(struct _FcitxInstance* instance);
/**
* @brief User interface should resume from the fallback
*
* @param instance fcitx instance
* @return void
**/
void FcitxUIResumeFromFallback(struct _FcitxInstance* instance);
boolean FcitxUIIsFallback(struct _FcitxInstance* instance, struct _FcitxAddon* addon);
void FcitxMenuInit(FcitxUIMenu* menu);
#ifdef __cplusplus
}
#endif
#endif
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|