/usr/include/ibus-1.0/ibuslookuptable.h is in libibus-1.0-dev 1.5.5-1ubuntu3.
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 | /* -*- 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_LOOKUP_TABLE_H_
#define __IBUS_LOOKUP_TABLE_H_
/**
* SECTION: ibuslookuptable
* @short_description: Candidate word/phrase lookup table.
* @stability: Stable
*
* An IBusLookuptable stores the candidate words or phrases for users to
* choose from.
*
* Use ibus_engine_update_lookup_table(), ibus_engine_show_lookup_table(),
* and ibus_engine_hide_lookup_table() to update, show and hide the lookup
* table.
*
* see_also: #IBusEngine
*/
#include "ibusserializable.h"
#include "ibustext.h"
/*
* Type macros.
*/
/* define IBusLookupTable macros */
#define IBUS_TYPE_LOOKUP_TABLE \
(ibus_lookup_table_get_type ())
#define IBUS_LOOKUP_TABLE(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_LOOKUP_TABLE, IBusLookupTable))
#define IBUS_LOOKUP_TABLE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_LOOKUP_TABLE, IBusLookupTableClass))
#define IBUS_IS_LOOKUP_TABLE(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_LOOKUP_TABLE))
#define IBUS_IS_LOOKUP_TABLE_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_LOOKUP_TABLE))
#define IBUS_LOOKUP_TABLE_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_LOOKUP_TABLE, IBusLookupTableClass))
G_BEGIN_DECLS
typedef struct _IBusLookupTable IBusLookupTable;
typedef struct _IBusLookupTableClass IBusLookupTableClass;
/**
* IBusLookupTable:
* @page_size: number of candidate shown per page.
* @cursor_pos: position index of cursor.
* @cursor_visible: whether the cursor is visible.
* @round: TRUE for lookup table wrap around.
* @orientation: orientation of the table.
* @candidates: Candidate words/phrases.
* @labels: Candidate labels which identify individual candidates in the same page. Default is 1, 2, 3, 4 ...
*
* An IBusLookuptable stores the candidate words or phrases for users to choose from.
* Note that some input methods allow you to select candidate by pressing non-numeric
* keys such as "asdfghjkl;".
* Developers of these input methods should change the labels with
* ibus_lookup_table_append_label().
*/
struct _IBusLookupTable {
IBusSerializable parent;
/*< public >*/
guint page_size;
guint cursor_pos;
gboolean cursor_visible;
gboolean round;
gint orientation;
GArray *candidates;
GArray *labels;
};
struct _IBusLookupTableClass {
IBusSerializableClass parent;
};
GType ibus_lookup_table_get_type (void);
/**
* ibus_lookup_table_new:
* @page_size: number of candidate shown per page, the max value is 16.
* @cursor_pos: position index of cursor.
* @cursor_visible: whether the cursor is visible.
* @round: TRUE for lookup table wrap around.
* @returns: A newly allocated IBusLookupTable.
*
* New a IBusLookupTable.
*/
IBusLookupTable *ibus_lookup_table_new (guint page_size,
guint cursor_pos,
gboolean cursor_visible,
gboolean round);
/**
* ibus_lookup_table_append_candidate:
* @table: An IBusLookupTable.
* @text: candidate word/phrase to be appended (in IBusText format).
*
* Append a candidate word/phrase to IBusLookupTable, and increase reference.
*/
void ibus_lookup_table_append_candidate
(IBusLookupTable *table,
IBusText *text);
/**
* ibus_lookup_table_get_number_of_candidates:
* @table: An IBusLookupTable.
* @returns: The number of candidates in the table
*
* Return the number of candidate in the table.
*/
guint ibus_lookup_table_get_number_of_candidates
(IBusLookupTable *table);
/**
* ibus_lookup_table_get_candidate:
* @table: An IBusLookupTable.
* @index: Index in the Lookup table.
* @returns: (transfer none): IBusText at the given index; NULL if no such IBusText.
*
* Return IBusText at the given index. Borrowed reference.
*/
IBusText *ibus_lookup_table_get_candidate
(IBusLookupTable *table,
guint index);
/**
* ibus_lookup_table_append_label:
* @table: An IBusLookupTable.
* @text: A candidate label to be appended (in IBusText format).
*
* Append a candidate word/phrase to IBusLookupTable, and increase reference.
* This function is needed if the input method select candidate with
* non-numeric keys such as "asdfghjkl;".
*/
void ibus_lookup_table_append_label
(IBusLookupTable *table,
IBusText *text);
/**
* ibus_lookup_table_set_label:
* @table: An IBusLookupTable.
* @index: Intex in the Lookup table.
* @text: A candidate label to be appended (in IBusText format).
*
* Append a candidate word/phrase to IBusLookupTable, and increase reference.
* This function is needed if the input method select candidate with
* non-numeric keys such as "asdfghjkl;".
*/
void ibus_lookup_table_set_label
(IBusLookupTable *table,
guint index,
IBusText *text);
/**
* ibus_lookup_table_get_label:
* @table: An IBusLookupTable.
* @index: Index in the Lookup table.
* @returns: (transfer none): IBusText at the given index; NULL if no such IBusText.
*
* Return IBusText at the given index. Borrowed reference.
*/
IBusText *ibus_lookup_table_get_label
(IBusLookupTable *table,
guint index);
/**
* ibus_lookup_table_set_cursor_pos:
* @table: An IBusLookupTable.
* @cursor_pos: The position of cursor.
*
* Set the cursor position of IBusLookupTable.
*/
void ibus_lookup_table_set_cursor_pos
(IBusLookupTable *table,
guint cursor_pos);
/**
* ibus_lookup_table_get_cursor_pos:
* @table: An IBusLookupTable.
* @returns: The position of cursor.
*
* Get the cursor position of IBusLookupTable.
*/
guint ibus_lookup_table_get_cursor_pos
(IBusLookupTable *table);
/**
* ibus_lookup_table_set_cursor_visible:
* @table: An IBusLookupTable.
* @visible: Whether to make the cursor of @table visible.
*
* Set whether to make the cursor of an IBusLookupTable visible or not.
*/
void ibus_lookup_table_set_cursor_visible
(IBusLookupTable *table,
gboolean visible);
/**
* ibus_lookup_table_is_cursor_visible:
* @table: An IBusLookupTable.
* @returns: Whether the cursor of @table is visible.
*
* Returns whether the cursor of an IBusLookupTable is visible.
*/
gboolean ibus_lookup_table_is_cursor_visible
(IBusLookupTable *table);
/**
* ibus_lookup_table_get_cursor_in_page:
* @table: An IBusLookupTable.
* @returns: The position of cursor in current page.
*
* Get the cursor position in current page of IBusLookupTable.
*/
guint ibus_lookup_table_get_cursor_in_page
(IBusLookupTable *table);
/**
* ibus_lookup_table_set_page_size:
* @table: An IBusLookupTable.
* @page_size: number of candidate shown per page.
*
* Set the number of candidate shown per page.
*/
void ibus_lookup_table_set_page_size
(IBusLookupTable *table,
guint page_size);
/**
* ibus_lookup_table_get_page_size:
* @table: An IBusLookupTable.
* @returns: Page size, i.e., number of candidate shown per page.
*
* Get the number of candidate shown per page.
*/
guint ibus_lookup_table_get_page_size
(IBusLookupTable *table);
/**
* ibus_lookup_table_set_round:
* @table: An IBusLookupTable.
* @round: Whether to make @table round.
*
* Set whether to make the IBusLookupTable round or not.
*/
void ibus_lookup_table_set_round
(IBusLookupTable *table,
gboolean round);
/**
* ibus_lookup_table_is_round:
* @table: An IBusLookupTable.
* @returns: Whether the @table is round.
*
* Returns whether the IBusLookupTable is round.
*/
gboolean ibus_lookup_table_is_round (IBusLookupTable *table);
/**
* ibus_lookup_table_set_orientation:
* @table: An IBusLookupTable.
* @orientation: .
*
* Set the orientation.
*/
void ibus_lookup_table_set_orientation
(IBusLookupTable *table,
gint orientation);
/**
* ibus_lookup_table_get_orientation:
* @table: An IBusLookupTable.
* @returns: The orientation of the @table.
*
* Returns the orientation of the IBusLookupTable.
*/
gint ibus_lookup_table_get_orientation
(IBusLookupTable *table);
/**
* ibus_lookup_table_clear:
* @table: An IBusLookupTable.
*
* Clear and remove all candidate from an IBusLookupTable.
*/
void ibus_lookup_table_clear (IBusLookupTable *table);
/**
* ibus_lookup_table_page_up:
* @table: An IBusLookupTable.
* @returns: TRUE if succeed.
*
* Go to previous page of an IBusLookupTable.
*
* It returns FALSE if it is already at the first page,
* unless <code>table>-round==TRUE</code>, where it will go
* to the last page.
*/
gboolean ibus_lookup_table_page_up (IBusLookupTable *table);
/**
* ibus_lookup_table_page_down:
* @table: An IBusLookupTable.
* @returns: TRUE if succeed.
*
* Go to next page of an IBusLookupTable.
*
* It returns FALSE if it is already at the last page,
* unless <code>table>-round==TRUE</code>, where it will go
* to the first page.
*/
gboolean ibus_lookup_table_page_down(IBusLookupTable *table);
/**
* ibus_lookup_table_cursor_up:
* @table: An IBusLookupTable.
* @returns: TRUE if succeed.
*
* Go to previous candidate of an IBusLookupTable.
*
* It returns FALSE if it is already at the first candidate,
* unless <code>table>-round==TRUE</code>, where it will go
* to the last candidate.
*/
gboolean ibus_lookup_table_cursor_up(IBusLookupTable *table);
/**
* ibus_lookup_table_cursor_down:
* @table: An IBusLookupTable.
* @returns: TRUE if succeed.
*
* Go to next candidate of an IBusLookupTable.
*
* It returns FALSE if it is already at the last candidate,
* unless <code>table>-round==TRUE</code>, where it will go
* to the first candidate.
*/
gboolean ibus_lookup_table_cursor_down
(IBusLookupTable *table);
G_END_DECLS
#endif
|