/usr/include/ibus-1.0/ibusinputcontext.h is in libibus-1.0-dev 1.4.1-3ubuntu1.
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 | /* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* ibus - The Input Bus
* Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
* Copyright (C) 2008-2010 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 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., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#if !defined (__IBUS_H_INSIDE__) && !defined (IBUS_COMPILATION)
#error "Only <ibus.h> can be included directly"
#endif
/**
* SECTION: ibusinputcontext
* @short_description: IBus input context proxy object.
* @stability: Stable
*
* An IBusInputContext is a proxy object of BusInputContext,
* which manages the context for input methods that supports
* text input in various natural languages.
*
* Clients call the IBusInputContext to invoke BusInputContext,
* through which invokes IBusEngine.
*/
#ifndef __IBUS_INPUT_CONTEXT_H_
#define __IBUS_INPUT_CONTEXT_H_
#include "ibusproxy.h"
#include "ibusenginedesc.h"
#include "ibustext.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_INPUT_CONTEXT \
(ibus_input_context_get_type ())
#define IBUS_INPUT_CONTEXT(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_INPUT_CONTEXT, IBusInputContext))
#define IBUS_INPUT_CONTEXT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_INPUT_CONTEXT, IBusInputContextClass))
#define IBUS_IS_INPUT_CONTEXT(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_INPUT_CONTEXT))
#define IBUS_IS_INPUT_CONTEXT_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_INPUT_CONTEXT))
#define IBUS_INPUT_CONTEXT_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_INPUT_CONTEXT, IBusInputContextClass))
G_BEGIN_DECLS
typedef struct _IBusInputContext IBusInputContext;
typedef struct _IBusInputContextClass IBusInputContextClass;
/**
* IBusInputContext:
*
* An opaque data type representing an IBusInputContext.
*/
struct _IBusInputContext {
IBusProxy parent;
/* instance members */
};
struct _IBusInputContextClass {
IBusProxyClass parent;
/* signals */
/*< private >*/
/* padding */
gpointer pdummy[24];
};
GType ibus_input_context_get_type (void);
/**
* ibus_input_context_new:
* @path: The path to the object that emitting the signal.
* @connection: An #GDBusConnection.
* @cancellable: A #GCancellable or %NULL.
* @error: Return location for error or %NULL.
*
* @returns: A newly allocated IBusInputContext.
*
* New an IBusInputContext.
*/
IBusInputContext *
ibus_input_context_new (const gchar *path,
GDBusConnection *connection,
GCancellable *cancellable,
GError **error);
/**
* ibus_input_context_new_async:
* @path: The path to the object that emitting the signal.
* @connection: An #GDBusConnection.
* @cancellable: A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied.
* The callback should not be %NULL.
* @user_data: The data to pass to callback.
*
* New an #IBusInputContext asynchronously.
*/
void ibus_input_context_new_async (const gchar *path,
GDBusConnection *connection,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* ibus_input_context_new_async_finish:
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
* ibus_input_context_new_async().
* @error: Return location for error or %NULL.
*
* @returns: A newly allocated #IBusInputContext.
*
* Finishes an operation started with ibus_input_context_new_async().
*/
IBusInputContext *
ibus_input_context_new_async_finish
(GAsyncResult *res,
GError **error);
/**
* ibus_input_context_get_input_context:
* @path: The path to the object that emitting the signal.
* @connection: An #GDBusConnection.
* @returns: (transfer none): An existing #IBusInputContext.
*
* Gets an existing IBusInputContext.
*/
IBusInputContext *
ibus_input_context_get_input_context
(const gchar *path,
GDBusConnection *connection);
/**
* ibus_input_context_get_input_context_async:
* @path: The path to the object that emitting the signal.
* @connection: An #GDBusConnection.
* @cancellable: A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied.
* The callback should not be %NULL.
* @user_data: The data to pass to callback.
*
* Get an existing #IBusInputContext asynchronously.
*/
void ibus_input_context_get_input_context_async
(const gchar *path,
GDBusConnection *connection,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* ibus_input_context_get_input_context_async_finish:
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback pass to
* ibus_input_context_get_input_context_async().
* @error: Return location for error or %NULL.
*
* @returns: (transfer none): An existing #IBusInputContext.
*
* Finishes an operation started with ibus_input_contex_get_input_context_async().
*/
IBusInputContext *
ibus_input_context_get_input_context_async_finish
(GAsyncResult *res,
GError **error);
/**
* ibus_input_context_process_hand_writing_event
* @context: An IBusInputContext.
* @coordinates: An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).
* @coordinates_len: The number of elements in the array. The number should be even and >= 4.
*
* Pass a handwriting stroke to an input method engine.
*
* In this API, a coordinate (0.0, 0.0) represents the top-left corner of an area for
* handwriting, and (1.0, 1.0) does the bottom-right. Therefore, for example, if
* a user writes a character 'L', the array would be something like [0.0, 0.0, 0.0, 1.0, 1.0, 1.0]
* and coordinates_len would be 6.
*
* The function is usually called when a user releases the mouse button in a hand
* writing area.
*
* see_also: #IBusEngine::process-hand-writing-event
*/
void ibus_input_context_process_hand_writing_event
(IBusInputContext *context,
const gdouble *coordinates,
guint coordinates_len);
/**
* ibus_input_context_cancel_hand_writing
* @context: An IBusInputContext.
* @n_strokes: The number of strokes to be removed. Pass 0 to remove all.
*
* Clear handwriting stroke(s) in the current input method engine.
*
* see_also: #IBusEngine::cancel-hand-writing
*/
void ibus_input_context_cancel_hand_writing
(IBusInputContext *context,
guint n_strokes);
/**
* ibus_input_context_process_key_event_async:
* @context: An IBusInputContext.
* @keyval: Key symbol of a key event.
* @keycode: Keycode of a key event.
* @state: Key modifier flags.
* @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A GCancellable or NULL.
* @callback: A GAsyncReadyCallback to call when the request is satisfied or NULL
* if you don't care about the result of the method invocation.
* @user_data: The data to pass to callback.
*
* Pass the key event to input method engine.
*
* Key symbols are characters/symbols produced by key press, for example,
* pressing "s" generates key symbol "s"; pressing shift-"s" generates key symbol "S".
* Same key on keyboard may produce different key symbols on different keyboard layout.
* e.g., "s" key on QWERTY keyboard produces "o" in DVORAK layout.
*
* Unlike key symbol, keycode is only determined by the location of the key, and
* irrelevant of the keyboard layout.
*
* Briefly speaking, input methods that expect certain keyboard layout should use
* keycode; otherwise keyval is sufficient.
* For example, Chewing, Cangjie, Wubi expect an en-US QWERTY keyboard, these should
* use keycode; while pinyin can rely on keyval only, as it is less sensitive to
* the keyboard layout change, DVORAK users can still use DVORAK layout to input pinyin.
*
* Use ibus_keymap_lookup_keysym() to convert keycode to keysym in given keyboard layout.
*
* see_also: #IBusEngine::process-key-event
*/
void ibus_input_context_process_key_event_async
(IBusInputContext *context,
guint32 keyval,
guint32 keycode,
guint32 state,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* ibus_input_context_process_key_event_async_finish:
* @context: An IBusInputContext.
* @res: A GAsyncResult obtained from the GAsyncReadyCallback passed to
* ibus_input_context_process_key_event_async().
* @error: Return location for error or NULL.
* @returns: %TRUE if the key event is processed;
* %FALSE otherwise or some errors happen and the @error will be set.
*
* Finishes an operation started with ibus_input_context_process_key_event_async().
*/
gboolean ibus_input_context_process_key_event_async_finish
(IBusInputContext *context,
GAsyncResult *res,
GError **error);
/**
* ibus_input_context_process_key_event:
* @context: An IBusInputContext.
* @keyval: Key symbol of a key event.
* @keycode: Keycode of a key event.
* @state: Key modifier flags.
* @returns: TRUE for successfully process the key; FALSE otherwise.
*
* Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).
*
* @see_also: ibus_input_context_process_key_event_async()
*/
gboolean ibus_input_context_process_key_event
(IBusInputContext *context,
guint32 keyval,
guint32 keycode,
guint32 state);
/**
* ibus_input_context_set_cursor_location:
* @context: An IBusInputContext.
* @x: X coordinate of the cursor.
* @y: Y coordinate of the cursor.
* @w: Width of the cursor.
* @h: Height of the cursor.
*
* Set the cursor location of IBus input context asynchronously.
*
* see_also: #IBusEngine::set-cursor-location
*/
void ibus_input_context_set_cursor_location
(IBusInputContext *context,
gint32 x,
gint32 y,
gint32 w,
gint32 h);
/**
* ibus_input_context_set_capabilities:
* @context: An IBusInputContext.
* @capabilities: Capabilities flags of IBusEngine, see #IBusCapabilite
*
* Set the capabilities flags of client application asynchronously.
* When IBUS_CAP_FOCUS is not set, IBUS_CAP_PREEDIT_TEXT, IBUS_CAP_AUXILIARY_TEXT, IBUS_CAP_LOOKUP_TABLE, and IBUS_CAP_PROPERTY have to be all set.
* The panel component does nothing for an application that doesn't support focus.
*
* see_also: #IBusEngine::set-capabilities
*/
void ibus_input_context_set_capabilities
(IBusInputContext *context,
guint32 capabilities);
/**
* ibus_input_context_property_activate
* @context: An IBusInputContext.
* @prop_name: A property name (e.g. "InputMode.WideLatin")
* @state: A status of the property (e.g. PROP_STATE_CHECKED)
*
* Activate the property asynchronously.
*
* @see_also: #IBusEngine::property_activate
*/
void ibus_input_context_property_activate
(IBusInputContext *context,
const gchar *prop_name,
guint32 state);
/**
* ibus_input_context_focus_in:
* @context: An IBusInputContext.
*
* Invoked when the client application get focus. An asynchronous IPC will be performed.
*
* see_also: #IBusEngine::focus_in.
*/
void ibus_input_context_focus_in (IBusInputContext *context);
/**
* ibus_input_context_focus_out:
* @context: An IBusInputContext.
*
* Invoked when the client application get focus. An asynchronous IPC will be performed.
*
* see_also: #IBusEngine::focus_out.
*/
void ibus_input_context_focus_out (IBusInputContext *context);
/**
* ibus_input_context_reset:
* @context: An IBusInputContext.
*
* Invoked when the IME is reset. An asynchronous IPC will be performed.
*
* see_also: #IBusEngine::reset
*/
void ibus_input_context_reset (IBusInputContext *context);
/**
* ibus_input_context_enable:
* @context: An IBusInputContext.
*
* Invoked when the IME is enabled, either by IME switch hotkey or select from the menu.
* An asynchronous IPC will be performed.
*
* see_also: #IBusEngine::enable
*/
void ibus_input_context_enable (IBusInputContext *context);
/**
* ibus_input_context_disable:
* @context: An IBusInputContext.
*
* Invoked when the IME is disabled, either by IME switch hotkey or select from the menu.
* An asynchronous IPC will be performed.
*
* see_also: #IBusEngine::disable
*/
void ibus_input_context_disable (IBusInputContext *context);
/**
* ibus_input_context_is_enabled_async:
* @context: An #IBusInputContext.
* @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL
* if you don't care about the result of the method invocation.
* @user_data: The data to pass to callback.
*
* An asynchronous IPC will be performed.
*/
void ibus_input_context_is_enabled_async
(IBusInputContext *context,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* ibus_input_context_is_enabled_async_finish:
* @context: An #IBusInputContext.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_input_context_is_enabled_async().
* @error: Return location for error or %NULL.
* @returns: %TRUE if the IME is enabled on the contextfor success;
* %FALSE otherwise or some errors happen and the @error will be set.
*
* Finishes an operation started with ibus_input_context_is_enabled_async().
*/
gboolean ibus_input_context_is_enabled_async_finish
(IBusInputContext *context,
GAsyncResult *res,
GError **error);
/**
* ibus_input_context_is_enabled:
* @context: An IBusInputContext.
* @returns: TRUE if the IME is enabled on the context.
*
* Returns TRUE if the IME is enabled on the context.
* A asynchronous IPC will be performed.
*/
gboolean ibus_input_context_is_enabled (IBusInputContext *context);
/**
* ibus_input_context_get_engine_async:
* @context: An #IBusInputContext.
* @timeout_msec: The timeout in milliseconds or -1 to use the default timeout.
* @cancellable: A #GCancellable or %NULL.
* @callback: A #GAsyncReadyCallback to call when the request is satisfied or %NULL
* if you don't care about the result of the method invocation.
* @user_data: The data to pass to callback.
*
* An asynchronous IPC will be performed.
*/
void ibus_input_context_get_engine_async
(IBusInputContext *context,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
/**
* ibus_input_context_get_engine_async_finish:
* @context: An #IBusInputContext.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_input_context_get_engine_async().
* @error: Return location for error or %NULL.
* @returns: (transfer none): An IME engine description for the context, or %NULL.
*
* Finishes an operation started with ibus_input_context_get_engine_async().
*/
IBusEngineDesc *
ibus_input_context_get_engine_async_finish
(IBusInputContext *context,
GAsyncResult *res,
GError **error);
/**
* ibus_input_context_get_engine:
* @context: An IBusInputContext.
* @returns: (transfer none): An IME engine description for the context, or NULL.
*
* Returns an IME engine description for the context.
* A synchronous IPC will be performed.
*/
IBusEngineDesc *
ibus_input_context_get_engine (IBusInputContext *context);
/**
* ibus_input_context_set_engine:
* @context: An IBusInputContext.
* @name: A name of the engine.
*
* Invoked when the IME engine is changed.
* An asynchronous IPC will be performed.
*/
void ibus_input_context_set_engine (IBusInputContext *context,
const gchar *name);
/**
* ibus_input_context_set_surrounding_text:
* @context: An #IBusInputContext.
* @text: An #IBusText surrounding the current cursor on the application.
* @cursor_pos: Current cursor position in characters in @text.
* @anchor_pos: Anchor position of selection in @text.
*/
void ibus_input_context_set_surrounding_text
(IBusInputContext *context,
IBusText *text,
guint32 cursor_pos,
guint32 anchor_pos);
/**
* ibus_input_context_needs_surrounding_text:
* @context: An #IBusInputContext.
* @returns: %TRUE if surrounding-text is needed by the current engine;
* %FALSE otherwise.
*
* Check whether the current engine requires surrounding-text.
*/
gboolean ibus_input_context_needs_surrounding_text
(IBusInputContext *context);
G_END_DECLS
#endif
|