/usr/include/ibus-1.0/ibusengine.h is in libibus-1.0-dev 1.5.17-3ubuntu4.
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 | /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input Bus
* Copyright (C) 2008-2013 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2013 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
#ifndef __IBUS_ENGINE_H_
#define __IBUS_ENGINE_H_
/**
* SECTION: ibusengine
* @short_description: Input method engine abstract.
* @title: IBusEngine
* @stability: Stable
*
* An IBusEngine provides infrastructure for input method engine.
* Developers can "extend" this class for input method engine development.
*
* see_also: #IBusComponent, #IBusEngineDesc
*/
#include "ibusservice.h"
#include "ibusattribute.h"
#include "ibuslookuptable.h"
#include "ibusproplist.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_ENGINE \
(ibus_engine_get_type ())
#define IBUS_ENGINE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_ENGINE, IBusEngine))
#define IBUS_ENGINE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_ENGINE, IBusEngineClass))
#define IBUS_IS_ENGINE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_ENGINE))
#define IBUS_IS_ENGINE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_ENGINE))
#define IBUS_ENGINE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_ENGINE, IBusEngineClass))
G_BEGIN_DECLS
typedef struct _IBusEngine IBusEngine;
typedef struct _IBusEngineClass IBusEngineClass;
typedef struct _IBusEnginePrivate IBusEnginePrivate;
/**
* IBusEngine:
* @enabled: Whether the engine is enabled.
* @has_focus: Whether the engine has focus.
* @cursor_area: Area of cursor.
* @client_capabilities: IBusCapabilite (client capabilities) flags.
*
* IBusEngine properties.
*/
struct _IBusEngine {
/*< private >*/
IBusService parent;
IBusEnginePrivate *priv;
/* instance members */
/*< public >*/
gboolean enabled;
gboolean has_focus;
/* cursor location */
IBusRectangle cursor_area;
guint client_capabilities;
};
struct _IBusEngineClass {
/*< private >*/
IBusServiceClass parent;
/* class members */
/*< public >*/
/* signals */
gboolean (* process_key_event)
(IBusEngine *engine,
guint keyval,
guint keycode,
guint state);
void (* focus_in) (IBusEngine *engine);
void (* focus_out) (IBusEngine *engine);
void (* reset) (IBusEngine *engine);
void (* enable) (IBusEngine *engine);
void (* disable) (IBusEngine *engine);
void (* set_cursor_location)
(IBusEngine *engine,
gint x,
gint y,
gint w,
gint h);
void (* set_capabilities)
(IBusEngine *engine,
guint caps);
void (* page_up) (IBusEngine *engine);
void (* page_down) (IBusEngine *engine);
void (* cursor_up) (IBusEngine *engine);
void (* cursor_down) (IBusEngine *engine);
void (* property_activate)
(IBusEngine *engine,
const gchar *prop_name,
guint prop_state);
void (* property_show) (IBusEngine *engine,
const gchar *prop_name);
void (* property_hide) (IBusEngine *engine,
const gchar *prop_name);
void (* candidate_clicked)
(IBusEngine *engine,
guint index,
guint button,
guint state);
void (* set_surrounding_text)
(IBusEngine *engine,
IBusText *text,
guint cursor_index,
guint anchor_pos);
void (* process_hand_writing_event)
(IBusEngine *engine,
const gdouble *coordinates,
guint coordinates_len);
void (* cancel_hand_writing)
(IBusEngine *engine,
guint n_strokes);
void (* set_content_type)
(IBusEngine *engine,
guint purpose,
guint hints);
/*< private >*/
/* padding */
gpointer pdummy[4];
};
GType ibus_engine_get_type (void);
/**
* ibus_engine_new:
* @engine_name: Name of the IBusObject.
* @object_path: Path for IBusService.
* @connection: An opened GDBusConnection.
*
* Create a new #IBusEngine.
*
* Returns: A newly allocated IBusEngine.
*/
IBusEngine *ibus_engine_new (const gchar *engine_name,
const gchar *object_path,
GDBusConnection *connection);
/**
* ibus_engine_new_with_type:
* @engine_type: GType of #IBusEngine.
* @engine_name: Name of the IBusObject.
* @object_path: Path for IBusService.
* @connection: An opened GDBusConnection.
*
* Create a new #IBusEngine.
*
* Returns: A newly allocated IBusEngine.
*/
IBusEngine *ibus_engine_new_with_type (GType engine_type,
const gchar *engine_name,
const gchar *object_path,
GDBusConnection *connection);
/**
* ibus_engine_commit_text:
* @engine: An IBusEngine.
* @text: String commit to IBusEngine.
*
* Commit output of input method to IBus client.
*
* (Note: The text object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_commit_text (IBusEngine *engine,
IBusText *text);
/**
* ibus_engine_update_preedit_text:
* @engine: An IBusEngine.
* @text: Update content.
* @cursor_pos: Current position of cursor
* @visible: Whether the pre-edit buffer is visible.
*
* Update the pre-edit buffer.
*
* (Note: The text object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_preedit_text
(IBusEngine *engine,
IBusText *text,
guint cursor_pos,
gboolean visible);
/**
* ibus_engine_update_preedit_text_with_mode:
* @engine: An IBusEngine.
* @text: Update content.
* @cursor_pos: Current position of cursor
* @visible: Whether the pre-edit buffer is visible.
* @mode: Pre-edit commit mode when the focus is lost.
*
* Update the pre-edit buffer with commit mode. Similar to
* ibus_engine_update_preedit_text(), this function allows users to specify
* the behavior on focus out when the pre-edit buffer is visible.
*
* If @mode is IBUS_ENGINE_PREEDIT_COMMIT, contents of the pre-edit buffer
* will be comitted and cleared.
* If @mode is IBUS_ENGINE_PREEDIT_CLEAR, contents of the pre-edit buffer
* will be cleared only.
*
* (Note: The text object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_preedit_text_with_mode
(IBusEngine *engine,
IBusText *text,
guint cursor_pos,
gboolean visible,
IBusPreeditFocusMode mode);
/**
* ibus_engine_show_preedit_text:
* @engine: An IBusEngine.
*
* Show the pre-edit buffer.
*/
void ibus_engine_show_preedit_text
(IBusEngine *engine);
/**
* ibus_engine_hide_preedit_text:
* @engine: An IBusEngine.
*
* Hide the pre-edit buffer.
*/
void ibus_engine_hide_preedit_text
(IBusEngine *engine);
/**
* ibus_engine_update_auxiliary_text:
* @engine: An IBusEngine.
* @text: Update content.
* @visible: Whether the auxiliary text bar is visible.
*
* Update the auxiliary bar.
*
* (Note: The text object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_auxiliary_text
(IBusEngine *engine,
IBusText *text,
gboolean visible);
/**
* ibus_engine_show_auxiliary_text:
* @engine: An IBusEngine.
*
* Show the auxiliary bar.
*/
void ibus_engine_show_auxiliary_text
(IBusEngine *engine);
/**
* ibus_engine_hide_auxiliary_text:
* @engine: An IBusEngine.
*
* Hide the auxiliary bar.
*/
void ibus_engine_hide_auxiliary_text
(IBusEngine *engine);
/**
* ibus_engine_update_lookup_table:
* @engine: An IBusEngine.
* @lookup_table: An lookup_table.
* @visible: Whether the lookup_table is visible.
*
* Update the lookup table.
*
* (Note: The table object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_lookup_table
(IBusEngine *engine,
IBusLookupTable *lookup_table,
gboolean visible);
/**
* ibus_engine_update_lookup_table_fast:
* @engine: An IBusEngine.
* @lookup_table: An lookup_table.
* @visible: Whether the lookup_table is visible.
*
* Fast update for big lookup table.
*
* If size of lookup table is not over table page size *4,
* then it calls ibus_engine_update_lookup_table().
*
* (Note: The table object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_lookup_table_fast
(IBusEngine *engine,
IBusLookupTable *lookup_table,
gboolean visible);
/**
* ibus_engine_show_lookup_table:
* @engine: An IBusEngine.
*
* Show the lookup table.
*/
void ibus_engine_show_lookup_table
(IBusEngine *engine);
/**
* ibus_engine_hide_lookup_table:
* @engine: An IBusEngine.
*
* Hide the lookup table.
*/
void ibus_engine_hide_lookup_table
(IBusEngine *engine);
/**
* ibus_engine_forward_key_event:
* @engine: An IBusEngine.
* @keyval: KeySym.
* @keycode: keyboard scancode.
* @state: Key modifier flags.
*
* Forward the key event.
*/
void ibus_engine_forward_key_event
(IBusEngine *engine,
guint keyval,
guint keycode,
guint state);
/**
* ibus_engine_register_properties:
* @engine: An IBusEngine.
* @prop_list: Property List.
*
* Register and show properties in language bar.
*
* (Note: The prop_list object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_register_properties
(IBusEngine *engine,
IBusPropList *prop_list);
/**
* ibus_engine_update_property:
* @engine: An IBusEngine.
* @prop: IBusProperty to be updated.
*
* Update the state displayed in language bar.
*
* (Note: The prop object will be released, if it is floating.
* If caller want to keep the object, caller should make the object
* sink by g_object_ref_sink.)
*/
void ibus_engine_update_property(IBusEngine *engine,
IBusProperty *prop);
/**
* ibus_engine_delete_surrounding_text:
* @engine: An IBusEngine.
* @offset: The offset of the first char.
* @nchars: Number of chars to be deleted.
*
* Delete surrounding text.
*/
void ibus_engine_delete_surrounding_text(IBusEngine *engine,
gint offset,
guint nchars);
/**
* ibus_engine_get_surrounding_text:
* @engine: An IBusEngine.
* @text: (out) (transfer none) (allow-none): Location to store surrounding text.
* @cursor_pos: (out) (allow-none): Cursor position in characters in @text.
* @anchor_pos: (out) (allow-none): Anchor position of selection in @text.
*
* Get surrounding text.
*
* It is also used to tell the input-context that the engine will
* utilize surrounding-text. In that case, it must be called in
* #IBusEngine::enable handler, with both @text and @cursor set to
* %NULL.
*
* See also: #IBusEngine::set-surrounding-text
*/
void ibus_engine_get_surrounding_text (IBusEngine *engine,
IBusText **text,
guint *cursor_pos,
guint *anchor_pos);
/**
* ibus_engine_get_content_type:
* @engine: An #IBusEngine.
* @purpose: (out) (allow-none): Primary purpose of the input context.
* @hints: (out) (allow-none): Hints that augument @purpose.
*
* Get content-type (primary purpose and hints) of the current input
* context.
*
* See also: #IBusEngine::set-content-type
*/
void ibus_engine_get_content_type (IBusEngine *engine,
guint *purpose,
guint *hints);
/**
* ibus_engine_get_name:
* @engine: An IBusEngine.
*
* Return the name of #IBusEngine.
*
* Returns: Name of #IBusEngine.
*/
const gchar *ibus_engine_get_name (IBusEngine *engine);
G_END_DECLS
#endif
|