/usr/include/fcitx/hook.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 | /***************************************************************************
* 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. *
***************************************************************************/
/**
* @file hook.h
* @brief Register function to be called automatically.
*/
#ifndef _HOOK_H
#define _HOOK_H
#include <fcitx-config/fcitx-config.h>
#include <fcitx-config/hotkey.h>
#include <fcitx/ime.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief key filter function
**/
typedef boolean(*FcitxKeyFilter)(void* arg, FcitxKeySym sym,
unsigned int state,
INPUT_RETURN_VALUE *retval
);
/**
* @brief string filter function
**/
typedef char* (*FcitxStringFilter)(void* arg, const char* in);
/**
* @brief ime event hook function
**/
typedef void (*FcitxIMEventHookFunc)(void* arg);
/**
* @brief Hotkey process struct
**/
typedef struct _FcitxHotkeyHook {
/**
* @brief Pointer to fcitx hotkeys, fcitx hotkey is length 2 array.
**/
FcitxHotkey* hotkey;
/**
* @brief Function to be called while hotkey is pressed.
*
* @return INPUT_RETURN_VALUE*
**/
INPUT_RETURN_VALUE(*hotkeyhandle)(void*);
/**
* @brief Argument
**/
void* arg;
} FcitxHotkeyHook;
/**
* @brief Key filter hook
**/
typedef struct _FcitxKeyFilterHook {
/**
* @brief Key filter function
**/
FcitxKeyFilter func;
/**
* @brief extra argument for filter function
**/
void *arg;
} FcitxKeyFilterHook;
/**
* @brief Hook for string filter, this hook can change the output string.
**/
typedef struct _FcitxStringFilterHook {
/**
* @brief Filter function
**/
FcitxStringFilter func;
/**
* @brief Extra argument for the filter function.
**/
void *arg;
} FcitxStringFilterHook;
/**
* @brief IME Event hook for Reset, Trigger On/Off, Focus/Unfocus
**/
typedef struct _FcitxIMEventHook {
FcitxIMEventHookFunc func;
void *arg;
} FcitxIMEventHook;
/**
* @brief register pre input filter
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterPreInputFilter(struct _FcitxInstance* instance, FcitxKeyFilterHook hook) ;
/**
* @brief register post input filter
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterPostInputFilter(struct _FcitxInstance* instance, FcitxKeyFilterHook hook);
/**
* @brief register ouput string filter
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterOutputFilter(struct _FcitxInstance* instance, FcitxStringFilterHook hook);
/**
* @brief register hotkey
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterHotkeyFilter(struct _FcitxInstance* instance, FcitxHotkeyHook hook);
/**
* @brief register reset input hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterResetInputHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register trigger on hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterTriggerOnHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register trigger off hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterTriggerOffHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register focus in hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterInputFocusHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register focus out hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterInputUnFocusHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register update candidate word hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterUpdateCandidateWordHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief register update input method list hook
*
* @param instance fcitx instance
* @param hook new hook
* @return void
**/
void FcitxInstanceRegisterUpdateIMListHook(struct _FcitxInstance* instance, FcitxIMEventHook hook);
/**
* @brief process output filter, return string is malloced
*
* @param instance fcitx instance
* @param in input string
* @return char*
**/
char* FcitxInstanceProcessOutputFilter(struct _FcitxInstance* instance, char *in);
/**
* @brief process output filter, return string is malloced
*
* @param instance fcitx instance
* @param in input string
* @return char*
**/
char* FcitxInstanceProcessCommitFilter(struct _FcitxInstance* instance, char *in);
/**
* @brief register ouput string filter
*
* @param instance fcitx instance
* @param hook new hook
* @return void
*
* @since 4.2.0
**/
void FcitxInstanceRegisterCommitFilter(struct _FcitxInstance* instance, FcitxStringFilterHook hook);
#ifdef __cplusplus
}
#endif
#endif
// kate: indent-mode cstyle; space-indent on; indent-width 0;
|