/usr/include/fcitx/frontend.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 | /***************************************************************************
* 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_FRONTEND_H_
#define _FCITX_FRONTEND_H_
#include <fcitx-utils/utarray.h>
#include <fcitx-config/fcitx-config.h>
#include <fcitx-config/hotkey.h>
#include <fcitx/ime.h>
#ifdef __cplusplus
extern "C" {
#endif
struct _FcitxInstance;
/**
* @brief Input Method State
**/
typedef enum _FcitxContextState {
IS_CLOSED = 0,
IS_ENG,
IS_ACTIVE
} FcitxContextState;
typedef enum _FcitxCapacityFlags {
CAPACITY_NONE = 0,
CAPACITY_CLIENT_SIDE_UI = (1 << 0),
CAPACITY_PREEDIT = (1 << 1),
CAPACITY_CLIENT_SIDE_CONTROL_STATE = (1 << 2)
} FcitxCapacityFlags;
/**
* @brief queued key event
**/
typedef struct _FcitxKeyEvent {
int frontendid;
void* event;
uint64_t sequenceId;
} FcitxKeyEvent;
/**
* @brief Input Context, normally one for one program
**/
typedef struct _FcitxInputContext {
FcitxContextState state; /* im state */
int offset_x, offset_y;
int frontendid;
void *privateic;
FcitxCapacityFlags contextCaps;
struct _FcitxInputContext* next;
} FcitxInputContext;
/**
* @brief Program IM Module Frontend
**/
typedef struct _FcitxFrontend {
void* (*Create)(struct _FcitxInstance*, int frontendindex);
boolean(*Destroy)(void *arg);
void (*CreateIC)(void* arg, FcitxInputContext*, void* priv);
boolean(*CheckIC)(void* arg, FcitxInputContext* arg1, void* arg2);
void (*DestroyIC)(void* arg, FcitxInputContext *context);
void (*EnableIM)(void* arg, FcitxInputContext* arg1);
void (*CloseIM)(void* arg, FcitxInputContext* arg1);
void (*CommitString)(void* arg, FcitxInputContext* arg1, char* arg2);
void (*ForwardKey)(void* arg, FcitxInputContext* arg1, FcitxKeyEventType event, FcitxKeySym sym, unsigned int state);
void (*SetWindowOffset)(void* arg, FcitxInputContext* ic, int x, int y);
void (*GetWindowPosition)(void* arg, FcitxInputContext* ic, int* x, int* y);
void (*UpdatePreedit)(void* arg, FcitxInputContext* ic);
void (*UpdateClientSideUI)(void* arg, FcitxInputContext* ic);
void (*ReloadConfig)(void* arg);
boolean(*CheckICFromSameApplication)(void* arg, FcitxInputContext* icToCheck, FcitxInputContext* ic);
void (*padding4)();
} FcitxFrontend;
/**
* @brief Initial frontends array
*
* @param frontends array
* @return void
**/
void FcitxFrontendsInit(UT_array*);
/**
* @brief Find Input Context By Frontend Specific filter
*
* @param instance
* @param frontendid frontend id
* @param filter frontend specfic filter
* @return FcitxInputContext*
**/
FcitxInputContext* FcitxInstanceFindIC(struct _FcitxInstance* instance, int frontendid, void* filter);
/**
* @brief Creat New Input Context
*
* @param instance
* @param frontendid frontend id
* @param priv frontend specfic data
* @return FcitxInputContext*
**/
FcitxInputContext* FcitxInstanceCreateIC(struct _FcitxInstance* instance, int frontendid, void* priv);
/**
* @brief Destroy Input context
*
* @param instance
* @param frontendid frontend id
* @param filter frontend specfic filter
* @return void
**/
void FcitxInstanceDestroyIC(struct _FcitxInstance* instance, int frontendid, void* filter);
/**
* @brief Load All frontend
*
* @param instance
* @return void
**/
boolean FcitxInstanceLoadFrontend(struct _FcitxInstance* instance);
/**
* @brief Commit String to Client
*
* @param instance
* @param ic input context
* @param str String to commit
* @return void
**/
void FcitxInstanceCommitString(struct _FcitxInstance* instance, FcitxInputContext* ic, char* str);
/**
* @brief Set Cursor Position
*
* @param instance fcitx instance
* @param ic input context
* @param x xpos
* @param y ypos
* @return void
**/
void FcitxInstanceSetWindowOffset(struct _FcitxInstance* instance, FcitxInputContext* ic, int x, int y);
/**
* @brief Get Cursor Position
*
* @param ...
* @param ic input context
* @param x xpos
* @param y ypos
* @return void
**/
void FcitxInstanceGetWindowPosition(struct _FcitxInstance*, FcitxInputContext *ic, int* x, int* y);
/**
* @brief Update preedit text to client window
*
* @param instance fcitx instance
* @param ic input context
* @return void
**/
void FcitxInstanceUpdatePreedit(struct _FcitxInstance* instance, FcitxInputContext* ic);
/**
* @brief Update all user interface element to client (Aux Text, Preedit, Candidate Word)
*
* @param instance fcitx instance
* @param ic input context
* @return void
**/
void FcitxInstanceUpdateClientSideUI(struct _FcitxInstance* instance, FcitxInputContext* ic);
/**
* @brief Get Current State, if only want to get state, this function is better, because it will handle the case that Input Context is NULL.
*
* @param instance fcitx instance
* @return IME_STATE
**/
FcitxContextState FcitxInstanceGetCurrentState(struct _FcitxInstance* instance);
/**
* @brief Get Current State, consider the option firstAsInactive
*
* @param instance fcitx instance
* @return IME_STATE
*
* @see FcitxInstanceGetCurrentState
**/
FcitxContextState FcitxInstanceGetCurrentStatev2(struct _FcitxInstance* instance);
/**
* @brief get current ic capacity flag, if only want to get capacity, this function is better, because it will handle the case that Input Context is NULL.
*
* @param instance fcitx instance
* @return CapacityFlags
**/
FcitxCapacityFlags FcitxInstanceGetCurrentCapacity(struct _FcitxInstance* instance);
/**
* @brief set all ic from same application to the given ic
*
* @param instance fcitx instance
* @param frontendid frontend id
* @param ic object ic
* @return void
**/
void FcitxInstanceSetICStateFromSameApplication(struct _FcitxInstance* instance, int frontendid, FcitxInputContext *ic);
/**
* @brief push a key event into the key event queue
*
* @param instance fcitx instance
* @param keyEvent private key event
* @return uint64_t key seqence
**/
uint64_t FcitxInstancePushKeyEvent(struct _FcitxInstance* instance, int frontendid, void* keyEvent);
/**
* @brief pop a key event out
*
* @param instance fcitx instance
* @param seqenceId key sequence
* @return void*
**/
FcitxKeyEvent FcitxInstancePopKeyEvent(struct _FcitxInstance* instance, uint64_t seqenceId);
#ifdef __cplusplus
}
#endif
#endif
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|