/usr/include/ibus-1.0/ibusbus.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 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 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 | /* -*- 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_BUS_H_
#define __IBUS_BUS_H_
/**
* SECTION: ibusbus
* @short_description: Connect with IBus daemon.
* @stability: Stable
*
* An IBusBus connects with IBus daemon.
*/
#include <gio/gio.h>
#include <glib.h>
#include "ibusinputcontext.h"
#include "ibusconfig.h"
#include "ibuscomponent.h"
#include "ibusshare.h"
/*
* Type macros.
*/
/* define GOBJECT macros */
#define IBUS_TYPE_BUS \
(ibus_bus_get_type ())
#define IBUS_BUS(obj) \
(G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUS_TYPE_BUS, IBusBus))
#define IBUS_BUS_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST ((klass), IBUS_TYPE_BUS, IBusBusClass))
#define IBUS_IS_BUS(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUS_TYPE_BUS))
#define IBUS_IS_BUS_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE ((klass), IBUS_TYPE_BUS))
#define IBUS_BUS_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), IBUS_TYPE_BUS, IBusBusClass))
G_BEGIN_DECLS
typedef struct _IBusBus IBusBus;
typedef struct _IBusBusClass IBusBusClass;
typedef struct _IBusBusPrivate IBusBusPrivate;
/**
* IBusBus:
*
* An opaque data type representing IBus bus (daemon communication) status.
*/
struct _IBusBus {
IBusObject parent;
/* instance members */
IBusBusPrivate *priv;
};
struct _IBusBusClass {
IBusObjectClass parent;
/* class members */
};
GType ibus_bus_get_type (void);
/**
* ibus_bus_new:
*
* Creates a new #IBusBus instance.
*
* Returns: A newly allocated #IBusBus instance, and the instance is not
* floating.
*/
IBusBus *ibus_bus_new (void);
/**
* ibus_bus_new_async:
*
* Creates a new #IBusBus instance. The instance will asynchronously connect
* to the IBus daemon.
*
* Returns: A newly allocated #IBusBus instance, and the instance is not
* floating.
*/
IBusBus *ibus_bus_new_async (void);
/**
* ibus_bus_new_async_client:
*
* Creates a new #IBusBus instance for client use only. It will possibly
* be limited in what it can do.
*
* The instance will asynchronously connect to the IBus daemon.
*
* Returns: A newly allocated #IBusBus instance, and the instance is not
* floating.
*/
IBusBus *ibus_bus_new_async_client (void);
/**
* ibus_bus_is_connected:
* @bus: An #IBusBus.
*
* Return %TRUE if @bus is connected to IBus daemon.
*
* Returns: %TRUE if @bus is connected, %FALSE otherwise.
*/
gboolean ibus_bus_is_connected (IBusBus *bus);
/**
* ibus_bus_get_connection:
* @bus: An #IBusBus.
*
* Gets a #GDBusConnection of an #IBusBus instance.
*
* Returns: (transfer none): A #GDBusConnection of an #IBusBus instance.
*/
GDBusConnection *
ibus_bus_get_connection (IBusBus *bus);
/**
* ibus_bus_get_service_name:
* @bus: An #IBusBus.
*
* Return the main service name to use for calls on the ibus connection.
*
* Returns: at dbus name.
*/
const gchar * ibus_bus_get_service_name (IBusBus *bus);
/**
* ibus_bus_hello:
* @bus: An #IBusBus.
*
* This function sends a "HELLO" message to DBus daemon,
* which replies the unique name of current IBus process.
*
* Returns: The unique name of IBus process in DBus.
*/
const gchar *ibus_bus_hello (IBusBus *bus);
/**
* ibus_bus_request_name:
* @bus: the IBusBus instance to be processed.
* @name: Name to be requested.
* @flags: IBusBusNameFlag.
*
* Request a name from IBus daemon synchronously.
*
* Returns: 0 if failed; IBusBusRequestNameReply otherwise.
*/
guint32 ibus_bus_request_name (IBusBus *bus,
const gchar *name,
guint32 flags);
/**
* ibus_bus_request_name_async:
* @bus: An #IBusBus.
* @name: Name to be requested.
* @flags: Flags (FixMe).
* @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.
*
* Request a name from IBus daemon asynchronously.
*/
void ibus_bus_request_name_async (IBusBus *bus,
const gchar *name,
guint flags,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_request_name_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_request_name_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_request_name_async().
*
* Returns: 0 if failed; positive number otherwise.
*/
guint ibus_bus_request_name_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_release_name:
* @bus: An #IBusBus.
* @name: Name to be released.
*
* Release a name to IBus daemon synchronously.
*
* Returns: 0 if failed; positive number otherwise.
*/
guint ibus_bus_release_name (IBusBus *bus,
const gchar *name);
/**
* ibus_bus_release_name_async:
* @bus: An #IBusBus.
* @name: Name to be released.
* @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.
*
* Release a name to IBus daemon asynchronously.
*/
void ibus_bus_release_name_async
(IBusBus *bus,
const gchar *name,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_release_name_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_release_name_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_release_name_async().
*
* Returns: 0 if failed; positive number otherwise.
*/
guint ibus_bus_release_name_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_list_queued_owners:
* @bus: An IBusBus.
* @name: Name to be queried.
*
* Lists the unique bus names of connections currently queued for a bus name.
* FIXME add an asynchronous version.
*
* Returns: (transfer full) (element-type utf8):
* The unique bus names of connections currently queued for @name.
*/
GList * ibus_bus_list_queued_owners
(IBusBus *bus,
const gchar *name);
/**
* ibus_bus_name_has_owner:
* @bus: An #IBusBus.
* @name: Name to be checked.
*
* Checks whether the name has owner synchronously.
*
* Returns: %TRUE if the name has owner, %FALSE otherwise.
*/
gboolean ibus_bus_name_has_owner (IBusBus *bus,
const gchar *name);
/**
* ibus_bus_name_has_owner_async:
* @bus: An #IBusBus.
* @name: Name to be checked.
* @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.
*
* Checks whether the name has owner asynchronously.
*/
void ibus_bus_name_has_owner_async
(IBusBus *bus,
const gchar *name,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_name_has_owner_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_name_has_owner_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_name_has_owner_async().
*
* Returns: %TRUE if the name has owner, %FALSE otherwise.
*/
gboolean ibus_bus_name_has_owner_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_list_names:
* @bus: An #IBusBus.
*
* Return lists that attached to @bus.
* <note><para>[FixMe] Not implemented yet, only return %NULL.</para></note>
* <note><para>[FixMe] Add async version.</para></note>
*
* Returns: (transfer full) (element-type utf8): Lists that attached to @bus.
*/
GList *ibus_bus_list_names (IBusBus *bus);
/**
* ibus_bus_add_match:
* @bus: An #IBusBus.
* @rule: Match rule.
*
* Add a match rule to an #IBusBus synchronously.
*
* Returns: %TRUE if the rule is added. %FALSE otherwise.
*/
gboolean ibus_bus_add_match (IBusBus *bus,
const gchar *rule);
/**
* ibus_bus_add_match_async:
* @bus: An #IBusBus.
* @rule: Match rule.
* @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.
*
* Add a match rule to an #IBusBus asynchronously.
*/
void ibus_bus_add_match_async (IBusBus *bus,
const gchar *rule,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_add_match_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_add_match_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_add_match_async().
*
* Returns: %TRUE if the rule is added. %FALSE otherwise.
*/
gboolean ibus_bus_add_match_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_remove_match:
* @bus: An #IBusBus.
* @rule: Match rule.
*
* Remove a match rule to an #IBusBus synchronously.
*
* Returns: %TRUE if the rule is removed. %FALSE otherwise.
*/
gboolean ibus_bus_remove_match (IBusBus *bus,
const gchar *rule);
/**
* ibus_bus_remove_match_async:
* @bus: An #IBusBus.
* @rule: Match rule.
* @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.
*
* Remove a match rule to an IBusBus asynchronously.
*/
void ibus_bus_remove_match_async
(IBusBus *bus,
const gchar *rule,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_remove_match_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_remove_match_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_remove_match_async().
*
* Returns: %TRUE if the rule is removed. %FALSE otherwise.
*/
gboolean ibus_bus_remove_match_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_get_name_owner:
* @bus: An #IBusBus.
* @name: Name.
*
* Return the name owner synchronously.
*
* Returns: Owner of the name. The returned value must be freed with g_free().
*/
gchar *ibus_bus_get_name_owner (IBusBus *bus,
const gchar *name);
/**
* ibus_bus_get_name_owner_async:
* @bus: An #IBusBus.
* @name: Name.
* @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.
*
* Return the name owner asynchronously.
*/
void ibus_bus_get_name_owner_async
(IBusBus *bus,
const gchar *name,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_get_name_owner_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_get_name_owner_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_get_name_owner_async().
*
* Returns: Owner of the name. The returned value must be freed with g_free().
*/
gchar *ibus_bus_get_name_owner_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/* declare ibus methods */
/**
* ibus_bus_exit:
* @bus: An #IBusBus.
* @restart: Whether restarting the ibus.
*
* Exit or restart ibus-daemon synchronously.
*
* Returns: %TRUE if the "Exit" call is suceeded, %FALSE otherwise.
*/
gboolean ibus_bus_exit (IBusBus *bus,
gboolean restart);
/**
* ibus_bus_exit_async:
* @bus: An #IBusBus.
* @restart: Whether restarting the ibus.
* @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.
*
* Exit or restart ibus-daemon asynchronously.
*/
void ibus_bus_exit_async (IBusBus *bus,
gboolean restart,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_exit_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_exit_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_exit_async().
*
* Returns: %TRUE if the "Exit" call is suceeded, %FALSE otherwise.
*/
gboolean ibus_bus_exit_async_finish (IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_create_input_context:
* @bus: An #IBusBus.
* @client_name: Name of client.
* "CreateInputContext" call is suceeded, %NULL otherwise.
*
* Create an input context for client synchronously.
*
* Returns: (transfer full): An newly allocated #IBusInputContext if the
*/
IBusInputContext *
ibus_bus_create_input_context
(IBusBus *bus,
const gchar *client_name);
/**
* ibus_bus_create_input_context_async:
* @bus: An #IBusBus.
* @client_name: Name of client.
* @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.
* It should not be %NULL.
* @user_data: The data to pass to callback.
*
* Create an input context for client asynchronously.
*/
void ibus_bus_create_input_context_async
(IBusBus *bus,
const gchar *client_name,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_create_input_context_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_create_input_context_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_create_input_context_async().
*
* Returns: (transfer full): An newly allocated #IBusInputContext if the
* "CreateInputContext" call is suceeded, %NULL otherwise.
*/
IBusInputContext *
ibus_bus_create_input_context_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_current_input_context:
* @bus: An #IBusBus.
*
* Get the current focused input context synchronously.
*
* Returns: The named of currently focued #IBusInputContext if the
* "CurrentInputContext" call suceeded, %NULL otherwise. The return
* value must be freed with g_free().
*/
gchar *ibus_bus_current_input_context
(IBusBus *bus);
/**
* ibus_bus_current_input_context_async:
* @bus: An #IBusBus.
* @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.
*
* Get the current focused input context asynchronously.
*/
void ibus_bus_current_input_context_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_current_input_context_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_current_input_context_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_current_input_context_async().
*
* Returns: The named of currently focued IBusInputContext if the
* "CurrentInputContext" call suceeded, %NULL otherwise. The return
* value must be freed with g_free().
*/
gchar *ibus_bus_current_input_context_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_register_component:
* @bus: An #IBusBus.
* @component: A input engine component.
*
* Register a componet to an #IBusBus synchronously.
*
* Returns: %TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.
*/
gboolean ibus_bus_register_component
(IBusBus *bus,
IBusComponent *component);
/**
* ibus_bus_register_component_async:
* @bus: An #IBusBus.
* @component: A input engine component.
* @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.
*
* Register a componet to an #IBusBus asynchronously.
*/
void ibus_bus_register_component_async
(IBusBus *bus,
IBusComponent *component,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_register_component_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_register_component_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_register_component_async().
*
* Returns: %TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.
*/
gboolean ibus_bus_register_component_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_list_engines:
* @bus: An #IBusBus.
*
* List engines synchronously.
*
* Returns: (transfer container) (element-type IBusEngineDesc):
* A List of engines.
*/
GList *ibus_bus_list_engines (IBusBus *bus);
/**
* ibus_bus_list_engines_async:
* @bus: An #IBusBus.
* @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.
*
* List engines asynchronously.
*/
void ibus_bus_list_engines_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_list_engines_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_list_engines_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_list_engines_async().
*
* Returns: (transfer container) (element-type IBusEngineDesc):
* A List of engines.
*/
GList *ibus_bus_list_engines_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
#ifndef IBUS_DISABLE_DEPRECATED
/**
* ibus_bus_list_active_engines:
* @bus: An #IBusBus.
*
* List active engines synchronously.
*
* Returns: (transfer container) (element-type IBusEngineDesc):
* A List of active engines.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/preload-engines instead.
*/
IBUS_DEPRECATED
GList *ibus_bus_list_active_engines
(IBusBus *bus);
/**
* ibus_bus_list_active_engines_async:
* @bus: An #IBusBus.
* @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.
*
* List active engines asynchronously.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/preload-engines instead.
*/
IBUS_DEPRECATED
void ibus_bus_list_active_engines_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_list_active_engines_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_list_active_engines_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_list_active_engines_async().
*
* Returns: (transfer container) (element-type IBusEngineDesc):
* A List of active engines.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/preload-engines instead.
*/
IBUS_DEPRECATED
GList *ibus_bus_list_active_engines_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
#endif /* IBUS_DISABLE_DEPRECATED */
/**
* ibus_bus_get_engines_by_names:
* @bus: An #IBusBus.
* @names: (array zero-terminated=1): A %NULL-terminated array of names.
*
* Get engines by given names synchronously. If some engine names do not exist,
* this function will simply ignore them, and return rest of engines.
* TODO(penghuang): add asynchronous version
*
* Returns: (array zero-terminated=1) (transfer full):
* A %NULL-terminated array of engines.
*/
IBusEngineDesc **
ibus_bus_get_engines_by_names
(IBusBus *bus,
const gchar * const *names);
#ifndef IBUS_DISABLE_DEPRECATED
/**
* ibus_bus_get_use_sys_layout:
* @bus: An #IBusBus.
*
* Check if the bus's "use_sys_layout" option is enabled or not synchronously.
*
* Returns: %TRUE if "use_sys_layout" option is enabled.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/use_system_keyboard_layout instead.
*/
IBUS_DEPRECATED
gboolean ibus_bus_get_use_sys_layout
(IBusBus *bus);
/**
* ibus_bus_get_use_sys_layout_async:
* @bus: An #IBusBus.
* @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.
*
* Check if the bus's "use_sys_layout" option is enabled or not asynchronously.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/use_system_keyboard_layout instead.
*/
IBUS_DEPRECATED
void ibus_bus_get_use_sys_layout_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_get_use_sys_layout_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_get_use_sys_layout_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_get_use_sys_layout_async().
*
* Returns: TRUE if "use_sys_layout" option is enabled.
*
* Deprecated: 1.5.3: Read dconf value
* /desktop/ibus/general/use_system_keyboard_layout instead.
*/
IBUS_DEPRECATED
gboolean ibus_bus_get_use_sys_layout_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_get_use_global_engine:
* @bus: An #IBusBus.
*
* Check if the bus's "use_global_engine" option is enabled or not
* synchronously.
*
* Returns: TRUE if "use_global_engine" option is enabled.
*
* Deprecated: 1.5.3: Currently global engine is always used.
*/
IBUS_DEPRECATED
gboolean ibus_bus_get_use_global_engine
(IBusBus *bus);
/**
* ibus_bus_get_use_global_engine_async:
* @bus: An #IBusBus.
* @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.
*
* Check if the bus's "use_global_engine" option is enabled or not asynchronously.
*
* Deprecated: 1.5.3: Currently global engine is always used.
*/
IBUS_DEPRECATED
void ibus_bus_get_use_global_engine_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_get_use_global_engine_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_get_use_global_engine_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_get_use_global_engine_async().
*
* Returns: %TRUE if "use_global_engine" option is enabled.
*
* Deprecated: 1.5.3: Currently global engine is always used.
*/
IBUS_DEPRECATED
gboolean ibus_bus_get_use_global_engine_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_is_global_engine_enabled:
* @bus: An #IBusBus.
*
* Check if the current global engine is enabled or not synchronously.
*
* Returns: %TRUE if the current global engine is enabled.
*
* Deprecated: 1.5.3: Probably this would be used for Chrome OS only.
* Currently global engine is always used and ibus_bus_get_global_engine()
* returns NULL until the first global engine is assigned.
* You can use ibus_set_log_handler() to disable a warning when
* ibus_bus_get_global_engine() returns NULL.
*/
IBUS_DEPRECATED
gboolean ibus_bus_is_global_engine_enabled
(IBusBus *bus);
/**
* ibus_bus_is_global_engine_enabled_async:
* @bus: An #IBusBus.
* @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.
*
* Check if the current global engine is enabled or not asynchronously.
*
* Deprecated: 1.5.3: Probably this would be used for Chrome OS only.
* Currently global engine is always used and ibus_bus_get_global_engine()
* returns NULL until the first global engine is assigned.
* You can use ibus_set_log_handler() to disable a warning when
* ibus_bus_get_global_engine() returns NULL.
*/
IBUS_DEPRECATED
void ibus_bus_is_global_engine_enabled_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_is_global_engine_enabled_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_is_global_engine_enabled_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_is_global_engine_enabled_async().
*
* Returns: %TRUE if the current global engine is enabled.
*
* Deprecated: 1.5.3: Probably this would be used for Chrome OS only.
* Currently global engine is always used and ibus_bus_get_global_engine()
* returns NULL until the first global engine is assigned.
* You can use ibus_set_log_handler() to disable a warning when
* ibus_bus_get_global_engine() returns NULL.
*/
IBUS_DEPRECATED
gboolean ibus_bus_is_global_engine_enabled_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
#endif /* IBUS_DISABLE_DEPRECATED */
/**
* ibus_bus_get_global_engine:
* @bus: An #IBusBus.
*
* Get the description of current global engine synchronously.
*
* Returns: (transfer full): The description of current global engine,
* or %NULL if there is no global engine.
*/
IBusEngineDesc *
ibus_bus_get_global_engine (IBusBus *bus);
/**
* ibus_bus_get_global_engine_async:
* @bus: An #IBusBus.
* @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.
*
* Get the description of current global engine asynchronously.
*/
void ibus_bus_get_global_engine_async
(IBusBus *bus,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_get_global_engine_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_get_global_engine_async_finish().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_get_global_engine_async_finish().
*
* Returns: (transfer none): The description of current global engine,
* or %NULL if there is no global engine.
*/
IBusEngineDesc *
ibus_bus_get_global_engine_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_set_global_engine:
* @bus: An #IBusBus.
* @global_engine: A new engine name.
*
* Set current global engine synchronously.
*
* Returns: %TRUE if the global engine was set successfully.
*/
gboolean ibus_bus_set_global_engine (IBusBus *bus,
const gchar *global_engine);
/**
* ibus_bus_set_global_engine_async:
* @bus: An #IBusBus.
* @global_engine: A new engine name.
* @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.
*
* Set current global engine asynchronously.
*/
void ibus_bus_set_global_engine_async
(IBusBus *bus,
const gchar *global_engine,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_set_global_engine_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_set_global_engine_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_set_global_engine_async().
*
* Returns: %TRUE if no IPC errros. %FALSE otherwise.
*/
gboolean ibus_bus_set_global_engine_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_set_watch_dbus_signal:
* @bus: An #IBusBus.
* @watch: %TRUE if you want ibusbus to emit "name-owner-changed" signal when
* ibus-daemon emits the NameOwnerChanged DBus signal.
*
* Start or stop watching the NameOwnerChanged DBus signal.
*/
void ibus_bus_set_watch_dbus_signal
(IBusBus *bus,
gboolean watch);
/**
* ibus_bus_set_watch_ibus_signal:
* @bus: An #IBusBus.
* @watch: %TRUE if you want ibusbus to emit "global-engine-changed" signal when
* ibus-daemon emits the GlobalEngineChanged IBus signal.
*
* Start or stop watching the GlobalEngineChanged IBus signal.
*/
void ibus_bus_set_watch_ibus_signal
(IBusBus *bus,
gboolean watch);
/* declare config apis */
/**
* ibus_bus_get_config:
* @bus: An #IBusBus.
*
* Get the config instance from #IBusBus.
*
* Returns: (transfer none): An #IBusConfig object which is configurable with
* @bus.
*/
IBusConfig *ibus_bus_get_config (IBusBus *bus);
/**
* ibus_bus_preload_engines:
* @bus: An #IBusBus.
* @names: (array zero-terminated=1): A %NULL-terminated array of engine names.
*
* Start bus components by engine names synchronously.
*
* Returns: %TRUE if components start. %FALSE otherwise.
*/
gboolean ibus_bus_preload_engines (IBusBus *bus,
const gchar * const *names);
/**
* ibus_bus_preload_engines_async:
* @bus: An #IBusBus.
* @names: (array zero-terminated=1): A %NULL-terminated array of engine names.
* @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.
*
* Start bus components by engine names asynchronously.
*/
void ibus_bus_preload_engines_async
(IBusBus *bus,
const gchar * const
*names,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_preload_engines_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_preload_engines_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_preload_engines_async().
*
* Returns: %TRUE if component starts. %FALSE otherwise.
*/
gboolean ibus_bus_preload_engines_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_get_ibus_property:
* @bus: An #IBusBus.
* @property_name: property name in org.freedesktop.DBus.Properties.Get
*
* Get org.freedesktop.DBus.Properties.
*
* Returns: (transfer full): The value in org.freedesktop.DBus.Properties.Get
* The returned value must be freed with g_variant_unref().
*/
GVariant * ibus_bus_get_ibus_property (IBusBus *bus,
const gchar *property_name);
/**
* ibus_bus_get_ibus_property_async:
* @bus: An #IBusBus.
* @property_name: property name in org.freedesktop.DBus.Properties.Get
* @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.
*
* Get org.freedesktop.DBus.Properties asynchronously.
*/
void ibus_bus_get_ibus_property_async
(IBusBus *bus,
const gchar *property_name,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_get_ibus_property_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_get_ibus_property_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_get_ibus_property_async().
*
* Returns: (transfer full): The value in org.freedesktop.DBus.Properties.Get
* The returned value must be freed with g_variant_unref().
*/
GVariant * ibus_bus_get_ibus_property_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
/**
* ibus_bus_set_ibus_property:
* @bus: An #IBusBus.
* @property_name: property name in org.freedesktop.DBus.Properties.Set
* @value: value in org.freedesktop.DBus.Properties.Set
*
* Set org.freedesktop.DBus.Properties.
*/
void ibus_bus_set_ibus_property (IBusBus *bus,
const gchar *property_name,
GVariant *value);
/**
* ibus_bus_set_ibus_property_async:
* @bus: An #IBusBus.
* @property_name: property name in org.freedesktop.DBus.Properties.Set
* @value: value in org.freedesktop.DBus.Properties.Set
* @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.
*
* Set org.freedesktop.DBus.Properties asynchronously.
*/
void ibus_bus_set_ibus_property_async
(IBusBus *bus,
const gchar *property_name,
GVariant *value,
gint timeout_msec,
GCancellable *cancellable,
GAsyncReadyCallback
callback,
gpointer user_data);
/**
* ibus_bus_set_ibus_property_async_finish:
* @bus: An #IBusBus.
* @res: A #GAsyncResult obtained from the #GAsyncReadyCallback passed to
* ibus_bus_set_ibus_property_async().
* @error: Return location for error or %NULL.
*
* Finishes an operation started with ibus_bus_set_ibus_property_async().
*
* Returns: %TRUE if property is set with async. %FALSE failed.
*/
gboolean ibus_bus_set_ibus_property_async_finish
(IBusBus *bus,
GAsyncResult *res,
GError **error);
G_END_DECLS
#endif
|