919
919
glib:type-name="IBusAttrType"
920
920
glib:get-type="ibus_attr_type_get_type"
921
921
c:type="IBusAttrType">
922
<doc xml:whitespace="preserve">Type enumeration of IBusText attribute.</doc>
922
<doc xml:space="preserve">Type enumeration of IBusText attribute.</doc>
923
923
<member name="underline"
925
925
c:identifier="IBUS_ATTR_TYPE_UNDERLINE"
926
926
glib:nick="underline">
927
<doc xml:whitespace="preserve">Decorate with underline.</doc>
927
<doc xml:space="preserve">Decorate with underline.</doc>
929
929
<member name="foreground"
931
931
c:identifier="IBUS_ATTR_TYPE_FOREGROUND"
932
932
glib:nick="foreground">
933
<doc xml:whitespace="preserve">Foreground color.</doc>
933
<doc xml:space="preserve">Foreground color.</doc>
935
935
<member name="background"
937
937
c:identifier="IBUS_ATTR_TYPE_BACKGROUND"
938
938
glib:nick="background">
939
<doc xml:whitespace="preserve">Background color.</doc>
939
<doc xml:space="preserve">Background color.</doc>
942
942
<enumeration name="AttrUnderline"
943
943
glib:type-name="IBusAttrUnderline"
944
944
glib:get-type="ibus_attr_underline_get_type"
945
945
c:type="IBusAttrUnderline">
946
<doc xml:whitespace="preserve">Type of IBusText attribute.</doc>
946
<doc xml:space="preserve">Type of IBusText attribute.</doc>
947
947
<member name="none"
949
949
c:identifier="IBUS_ATTR_UNDERLINE_NONE"
950
950
glib:nick="none">
951
<doc xml:whitespace="preserve">No underline.</doc>
951
<doc xml:space="preserve">No underline.</doc>
953
953
<member name="single"
955
955
c:identifier="IBUS_ATTR_UNDERLINE_SINGLE"
956
956
glib:nick="single">
957
<doc xml:whitespace="preserve">Single underline.</doc>
957
<doc xml:space="preserve">Single underline.</doc>
959
959
<member name="double"
961
961
c:identifier="IBUS_ATTR_UNDERLINE_DOUBLE"
962
962
glib:nick="double">
963
<doc xml:whitespace="preserve">Double underline.</doc>
963
<doc xml:space="preserve">Double underline.</doc>
965
965
<member name="low"
967
967
c:identifier="IBUS_ATTR_UNDERLINE_LOW"
969
<doc xml:whitespace="preserve">Low underline ? %FIXME</doc>
969
<doc xml:space="preserve">Low underline ? %FIXME</doc>
971
971
<member name="error"
973
973
c:identifier="IBUS_ATTR_UNDERLINE_ERROR"
974
974
glib:nick="error">
975
<doc xml:whitespace="preserve">Error underline</doc>
975
<doc xml:space="preserve">Error underline</doc>
977
977
<function name="new" c:identifier="ibus_attr_underline_new">
978
<doc xml:whitespace="preserve">New an underline #IBusAttribute.</doc>
978
<doc xml:space="preserve">New an underline #IBusAttribute.</doc>
979
979
<return-value transfer-ownership="none">
980
<doc xml:whitespace="preserve">A newly allocated #IBusAttribute.</doc>
980
<doc xml:space="preserve">A newly allocated #IBusAttribute.</doc>
981
981
<type name="Attribute" c:type="IBusAttribute*"/>
984
984
<parameter name="underline_type" transfer-ownership="none">
985
<doc xml:whitespace="preserve">Type of underline.</doc>
985
<doc xml:space="preserve">Type of underline.</doc>
986
986
<type name="guint" c:type="guint"/>
988
988
<parameter name="start_index" transfer-ownership="none">
989
<doc xml:whitespace="preserve">Where attribute starts.</doc>
989
<doc xml:space="preserve">Where attribute starts.</doc>
990
990
<type name="guint" c:type="guint"/>
992
992
<parameter name="end_index" transfer-ownership="none">
993
<doc xml:whitespace="preserve">Where attribute ends.</doc>
993
<doc xml:space="preserve">Where attribute ends.</doc>
994
994
<type name="guint" c:type="guint"/>
1137
1138
glib:type-name="IBusBus"
1138
1139
glib:get-type="ibus_bus_get_type"
1139
1140
glib:type-struct="BusClass">
1140
<doc xml:whitespace="preserve">An IBusBus connects with IBus daemon.</doc>
1141
<doc xml:space="preserve">An IBusBus connects with IBus daemon.</doc>
1141
1142
<constructor name="new" c:identifier="ibus_bus_new">
1142
<doc xml:whitespace="preserve">New an #IBusBus instance.</doc>
1143
<doc xml:space="preserve">New an #IBusBus instance.</doc>
1143
1144
<return-value transfer-ownership="none">
1144
<doc xml:whitespace="preserve">A newly allocated #IBusBus instance, and the instance is not floating.</doc>
1145
<doc xml:space="preserve">A newly allocated #IBusBus instance, and the instance is not floating.</doc>
1145
1146
<type name="Bus" c:type="IBusBus*"/>
1146
1147
</return-value>
1148
1149
<constructor name="new_async" c:identifier="ibus_bus_new_async">
1149
<doc xml:whitespace="preserve">New an #IBusBus instance. The instance will asynchronously connect to the IBus
1150
<doc xml:space="preserve">New an #IBusBus instance. The instance will asynchronously connect to the IBus
1151
1152
<return-value transfer-ownership="none">
1152
<doc xml:whitespace="preserve">A newly allocated #IBusBus instance, and the instance is not floating.</doc>
1153
<doc xml:space="preserve">A newly allocated #IBusBus instance, and the instance is not floating.</doc>
1153
1154
<type name="Bus" c:type="IBusBus*"/>
1154
1155
</return-value>
1156
1157
<method name="add_match" c:identifier="ibus_bus_add_match">
1157
<doc xml:whitespace="preserve">Add a match rule to an #IBusBus synchronously.</doc>
1158
<doc xml:space="preserve">Add a match rule to an #IBusBus synchronously.</doc>
1158
1159
<return-value transfer-ownership="none">
1159
<doc xml:whitespace="preserve">%TRUE if the rule is added. %FALSE otherwise.</doc>
1160
<doc xml:space="preserve">%TRUE if the rule is added. %FALSE otherwise.</doc>
1160
1161
<type name="gboolean" c:type="gboolean"/>
1161
1162
</return-value>
1163
1164
<instance-parameter name="bus" transfer-ownership="none">
1164
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1165
<doc xml:space="preserve">An #IBusBus.</doc>
1165
1166
<type name="Bus" c:type="IBusBus*"/>
1166
1167
</instance-parameter>
1167
1168
<parameter name="rule" transfer-ownership="none">
1168
<doc xml:whitespace="preserve">Match rule.</doc>
1169
<doc xml:space="preserve">Match rule.</doc>
1169
1170
<type name="utf8" c:type="const gchar*"/>
1173
1174
<method name="add_match_async" c:identifier="ibus_bus_add_match_async">
1174
<doc xml:whitespace="preserve">Add a match rule to an #IBusBus asynchronously.</doc>
1175
<doc xml:space="preserve">Add a match rule to an #IBusBus asynchronously.</doc>
1175
1176
<return-value transfer-ownership="none">
1176
1177
<type name="none" c:type="void"/>
1177
1178
</return-value>
1179
1180
<instance-parameter name="bus" transfer-ownership="none">
1180
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1181
<doc xml:space="preserve">An #IBusBus.</doc>
1181
1182
<type name="Bus" c:type="IBusBus*"/>
1182
1183
</instance-parameter>
1183
1184
<parameter name="rule" transfer-ownership="none">
1184
<doc xml:whitespace="preserve">Match rule.</doc>
1185
<doc xml:space="preserve">Match rule.</doc>
1185
1186
<type name="utf8" c:type="const gchar*"/>
1187
1188
<parameter name="timeout_msec" transfer-ownership="none">
1188
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1189
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1189
1190
<type name="gint" c:type="gint"/>
1191
1192
<parameter name="cancellable"
1192
1193
transfer-ownership="none"
1193
1194
allow-none="1">
1194
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1195
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1195
1196
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1197
1198
<parameter name="callback"
1211
1212
<method name="add_match_async_finish"
1212
1213
c:identifier="ibus_bus_add_match_async_finish"
1214
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_add_match_async().</doc>
1215
<doc xml:space="preserve">Finishes an operation started with ibus_bus_add_match_async().</doc>
1215
1216
<return-value transfer-ownership="none">
1216
<doc xml:whitespace="preserve">%TRUE if the rule is added. %FALSE otherwise.</doc>
1217
<doc xml:space="preserve">%TRUE if the rule is added. %FALSE otherwise.</doc>
1217
1218
<type name="gboolean" c:type="gboolean"/>
1218
1219
</return-value>
1220
1221
<instance-parameter name="bus" transfer-ownership="none">
1221
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1222
<doc xml:space="preserve">An #IBusBus.</doc>
1222
1223
<type name="Bus" c:type="IBusBus*"/>
1223
1224
</instance-parameter>
1224
1225
<parameter name="res" transfer-ownership="none">
1225
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_add_match_async().</doc>
1226
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_add_match_async().</doc>
1226
1227
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1230
1231
<method name="create_input_context"
1231
1232
c:identifier="ibus_bus_create_input_context">
1232
<doc xml:whitespace="preserve">Create an input context for client synchronously.</doc>
1233
<doc xml:space="preserve">Create an input context for client synchronously.</doc>
1233
1234
<return-value transfer-ownership="full">
1234
<doc xml:whitespace="preserve">An newly allocated #IBusInputContext if the "CreateInputContext" call is suceeded, %NULL otherwise.</doc>
1235
<doc xml:space="preserve">An newly allocated #IBusInputContext if the "CreateInputContext" call is suceeded, %NULL otherwise.</doc>
1235
1236
<type name="InputContext" c:type="IBusInputContext*"/>
1236
1237
</return-value>
1238
1239
<instance-parameter name="bus" transfer-ownership="none">
1239
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1240
<doc xml:space="preserve">An #IBusBus.</doc>
1240
1241
<type name="Bus" c:type="IBusBus*"/>
1241
1242
</instance-parameter>
1242
1243
<parameter name="client_name" transfer-ownership="none">
1243
<doc xml:whitespace="preserve">Name of client.</doc>
1244
<doc xml:space="preserve">Name of client.</doc>
1244
1245
<type name="utf8" c:type="const gchar*"/>
1248
1249
<method name="create_input_context_async"
1249
1250
c:identifier="ibus_bus_create_input_context_async">
1250
<doc xml:whitespace="preserve">Create an input context for client asynchronously.</doc>
1251
<doc xml:space="preserve">Create an input context for client asynchronously.</doc>
1251
1252
<return-value transfer-ownership="none">
1252
1253
<type name="none" c:type="void"/>
1253
1254
</return-value>
1255
1256
<instance-parameter name="bus" transfer-ownership="none">
1256
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1257
<doc xml:space="preserve">An #IBusBus.</doc>
1257
1258
<type name="Bus" c:type="IBusBus*"/>
1258
1259
</instance-parameter>
1259
1260
<parameter name="client_name" transfer-ownership="none">
1260
<doc xml:whitespace="preserve">Name of client.</doc>
1261
<doc xml:space="preserve">Name of client.</doc>
1261
1262
<type name="utf8" c:type="const gchar*"/>
1263
1264
<parameter name="timeout_msec" transfer-ownership="none">
1264
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1265
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1265
1266
<type name="gint" c:type="gint"/>
1267
1268
<parameter name="cancellable"
1268
1269
transfer-ownership="none"
1269
1270
allow-none="1">
1270
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1271
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1271
1272
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1273
1274
<parameter name="callback"
1287
1288
<method name="create_input_context_async_finish"
1288
1289
c:identifier="ibus_bus_create_input_context_async_finish"
1290
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_create_input_context_async().</doc>
1291
<doc xml:space="preserve">Finishes an operation started with ibus_bus_create_input_context_async().</doc>
1291
1292
<return-value transfer-ownership="full">
1292
<doc xml:whitespace="preserve">An newly allocated #IBusInputContext if the "CreateInputContext" call is suceeded, %NULL otherwise.</doc>
1293
<doc xml:space="preserve">An newly allocated #IBusInputContext if the "CreateInputContext" call is suceeded, %NULL otherwise.</doc>
1293
1294
<type name="InputContext" c:type="IBusInputContext*"/>
1294
1295
</return-value>
1296
1297
<instance-parameter name="bus" transfer-ownership="none">
1297
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1298
<doc xml:space="preserve">An #IBusBus.</doc>
1298
1299
<type name="Bus" c:type="IBusBus*"/>
1299
1300
</instance-parameter>
1300
1301
<parameter name="res" transfer-ownership="none">
1301
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_create_input_context_async().</doc>
1302
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_create_input_context_async().</doc>
1302
1303
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1306
1307
<method name="current_input_context"
1307
1308
c:identifier="ibus_bus_current_input_context">
1308
<doc xml:whitespace="preserve">Get the current focused input context synchronously.</doc>
1309
<doc xml:space="preserve">Get the current focused input context synchronously.</doc>
1309
1310
<return-value transfer-ownership="full">
1310
<doc xml:whitespace="preserve">The named of currently focued #IBusInputContext if the "CurrentInputContext" call suceeded, %NULL otherwise. The return value must be freed with g_free().</doc>
1311
<doc xml:space="preserve">The named of currently focued #IBusInputContext if the "CurrentInputContext" call suceeded, %NULL otherwise. The return value must be freed with g_free().</doc>
1311
1312
<type name="utf8" c:type="gchar*"/>
1312
1313
</return-value>
1314
1315
<instance-parameter name="bus" transfer-ownership="none">
1315
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1316
<doc xml:space="preserve">An #IBusBus.</doc>
1316
1317
<type name="Bus" c:type="IBusBus*"/>
1317
1318
</instance-parameter>
1320
1321
<method name="current_input_context_async"
1321
1322
c:identifier="ibus_bus_current_input_context_async">
1322
<doc xml:whitespace="preserve">Get the current focused input context asynchronously.</doc>
1323
<doc xml:space="preserve">Get the current focused input context asynchronously.</doc>
1323
1324
<return-value transfer-ownership="none">
1324
1325
<type name="none" c:type="void"/>
1325
1326
</return-value>
1327
1328
<instance-parameter name="bus" transfer-ownership="none">
1328
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1329
<doc xml:space="preserve">An #IBusBus.</doc>
1329
1330
<type name="Bus" c:type="IBusBus*"/>
1330
1331
</instance-parameter>
1331
1332
<parameter name="timeout_msec" transfer-ownership="none">
1332
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1333
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1333
1334
<type name="gint" c:type="gint"/>
1335
1336
<parameter name="cancellable"
1336
1337
transfer-ownership="none"
1337
1338
allow-none="1">
1338
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1339
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1339
1340
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1341
1342
<parameter name="callback"
1355
1356
<method name="current_input_context_async_finish"
1356
1357
c:identifier="ibus_bus_current_input_context_async_finish"
1358
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_current_input_context_async().</doc>
1359
<doc xml:space="preserve">Finishes an operation started with ibus_bus_current_input_context_async().</doc>
1359
1360
<return-value transfer-ownership="full">
1360
<doc xml:whitespace="preserve">The named of currently focued IBusInputContext if the "CurrentInputContext" call suceeded, %NULL otherwise. The return value must be freed with g_free().</doc>
1361
<doc xml:space="preserve">The named of currently focued IBusInputContext if the "CurrentInputContext" call suceeded, %NULL otherwise. The return value must be freed with g_free().</doc>
1361
1362
<type name="utf8" c:type="gchar*"/>
1362
1363
</return-value>
1364
1365
<instance-parameter name="bus" transfer-ownership="none">
1365
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1366
<doc xml:space="preserve">An #IBusBus.</doc>
1366
1367
<type name="Bus" c:type="IBusBus*"/>
1367
1368
</instance-parameter>
1368
1369
<parameter name="res" transfer-ownership="none">
1369
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_current_input_context_async().</doc>
1370
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_current_input_context_async().</doc>
1370
1371
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1374
1375
<method name="exit" c:identifier="ibus_bus_exit">
1375
<doc xml:whitespace="preserve">Exit or restart ibus-daemon synchronously.</doc>
1376
<doc xml:space="preserve">Exit or restart ibus-daemon synchronously.</doc>
1376
1377
<return-value transfer-ownership="none">
1377
<doc xml:whitespace="preserve">%TRUE if the "Exit" call is suceeded, %FALSE otherwise.</doc>
1378
<doc xml:space="preserve">%TRUE if the "Exit" call is suceeded, %FALSE otherwise.</doc>
1378
1379
<type name="gboolean" c:type="gboolean"/>
1379
1380
</return-value>
1381
1382
<instance-parameter name="bus" transfer-ownership="none">
1382
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1383
<doc xml:space="preserve">An #IBusBus.</doc>
1383
1384
<type name="Bus" c:type="IBusBus*"/>
1384
1385
</instance-parameter>
1385
1386
<parameter name="restart" transfer-ownership="none">
1386
<doc xml:whitespace="preserve">Whether restarting the ibus.</doc>
1387
<doc xml:space="preserve">Whether restarting the ibus.</doc>
1387
1388
<type name="gboolean" c:type="gboolean"/>
1391
1392
<method name="exit_async" c:identifier="ibus_bus_exit_async">
1392
<doc xml:whitespace="preserve">Exit or restart ibus-daemon asynchronously.</doc>
1393
<doc xml:space="preserve">Exit or restart ibus-daemon asynchronously.</doc>
1393
1394
<return-value transfer-ownership="none">
1394
1395
<type name="none" c:type="void"/>
1395
1396
</return-value>
1397
1398
<instance-parameter name="bus" transfer-ownership="none">
1398
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1399
<doc xml:space="preserve">An #IBusBus.</doc>
1399
1400
<type name="Bus" c:type="IBusBus*"/>
1400
1401
</instance-parameter>
1401
1402
<parameter name="restart" transfer-ownership="none">
1402
<doc xml:whitespace="preserve">Whether restarting the ibus.</doc>
1403
<doc xml:space="preserve">Whether restarting the ibus.</doc>
1403
1404
<type name="gboolean" c:type="gboolean"/>
1405
1406
<parameter name="timeout_msec" transfer-ownership="none">
1406
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1407
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1407
1408
<type name="gint" c:type="gint"/>
1409
1410
<parameter name="cancellable"
1410
1411
transfer-ownership="none"
1411
1412
allow-none="1">
1412
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1413
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1413
1414
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1415
1416
<parameter name="callback"
1429
1430
<method name="exit_async_finish"
1430
1431
c:identifier="ibus_bus_exit_async_finish"
1432
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_exit_async().</doc>
1433
<doc xml:space="preserve">Finishes an operation started with ibus_bus_exit_async().</doc>
1433
1434
<return-value transfer-ownership="none">
1434
<doc xml:whitespace="preserve">%TRUE if the "Exit" call is suceeded, %FALSE otherwise.</doc>
1435
<doc xml:space="preserve">%TRUE if the "Exit" call is suceeded, %FALSE otherwise.</doc>
1435
1436
<type name="gboolean" c:type="gboolean"/>
1436
1437
</return-value>
1438
1439
<instance-parameter name="bus" transfer-ownership="none">
1439
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1440
<doc xml:space="preserve">An #IBusBus.</doc>
1440
1441
<type name="Bus" c:type="IBusBus*"/>
1441
1442
</instance-parameter>
1442
1443
<parameter name="res" transfer-ownership="none">
1443
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_exit_async().</doc>
1444
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_exit_async().</doc>
1444
1445
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1448
1449
<method name="get_config" c:identifier="ibus_bus_get_config">
1449
<doc xml:whitespace="preserve">Get the config instance from #IBusBus.</doc>
1450
<doc xml:space="preserve">Get the config instance from #IBusBus.</doc>
1450
1451
<return-value transfer-ownership="none">
1451
<doc xml:whitespace="preserve">An #IBusConfig object which is configurable with @bus.</doc>
1452
<doc xml:space="preserve">An #IBusConfig object which is configurable with @bus.</doc>
1452
1453
<type name="Config" c:type="IBusConfig*"/>
1453
1454
</return-value>
1455
1456
<instance-parameter name="bus" transfer-ownership="none">
1456
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1457
<doc xml:space="preserve">An #IBusBus.</doc>
1457
1458
<type name="Bus" c:type="IBusBus*"/>
1458
1459
</instance-parameter>
1461
1462
<method name="get_connection" c:identifier="ibus_bus_get_connection">
1462
<doc xml:whitespace="preserve">Return #GDBusConnection of an #IBusBus instance.</doc>
1463
<doc xml:space="preserve">Return #GDBusConnection of an #IBusBus instance.</doc>
1463
1464
<return-value transfer-ownership="none">
1464
<doc xml:whitespace="preserve">A #GDBusConnection of an #IBusBus instance.</doc>
1465
<doc xml:space="preserve">A #GDBusConnection of an #IBusBus instance.</doc>
1465
1466
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
1466
1467
</return-value>
1468
1469
<instance-parameter name="bus" transfer-ownership="none">
1469
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1470
<doc xml:space="preserve">An #IBusBus.</doc>
1470
1471
<type name="Bus" c:type="IBusBus*"/>
1471
1472
</instance-parameter>
1474
1475
<method name="get_engines_by_names"
1475
1476
c:identifier="ibus_bus_get_engines_by_names">
1476
<doc xml:whitespace="preserve">Get engines by given names synchronously. If some engine names do not exist, this function
1477
<doc xml:space="preserve">Get engines by given names synchronously. If some engine names do not exist, this function
1477
1478
will simplly ignore them, and return rest of engines.
1478
1479
TODO(penghuang): add asynchronous version</doc>
1479
1480
<return-value transfer-ownership="full">
1480
<doc xml:whitespace="preserve">A %NULL-terminated array of engines.</doc>
1481
<doc xml:space="preserve">A %NULL-terminated array of engines.</doc>
1481
1482
<array c:type="IBusEngineDesc**">
1482
1483
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
1484
1485
</return-value>
1486
1487
<instance-parameter name="bus" transfer-ownership="none">
1487
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1488
<doc xml:space="preserve">An #IBusBus.</doc>
1488
1489
<type name="Bus" c:type="IBusBus*"/>
1489
1490
</instance-parameter>
1490
1491
<parameter name="names" transfer-ownership="none">
1491
<doc xml:whitespace="preserve">A %NULL-terminated array of names.</doc>
1492
<doc xml:space="preserve">A %NULL-terminated array of names.</doc>
1492
1493
<array c:type="gchar**">
1493
1494
<type name="utf8" c:type="gchar*"/>
1547
1548
<method name="get_global_engine_async_finish"
1548
1549
c:identifier="ibus_bus_get_global_engine_async_finish"
1550
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_get_global_engine_async_finish().</doc>
1551
<doc xml:space="preserve">Finishes an operation started with ibus_bus_get_global_engine_async_finish().</doc>
1551
1552
<return-value transfer-ownership="none">
1552
<doc xml:whitespace="preserve">The description of current global engine, or %NULL if there is no global engine.</doc>
1553
<doc xml:space="preserve">The description of current global engine, or %NULL if there is no global engine.</doc>
1553
1554
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
1554
1555
</return-value>
1556
1557
<instance-parameter name="bus" transfer-ownership="none">
1557
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1558
<doc xml:space="preserve">An #IBusBus.</doc>
1558
1559
<type name="Bus" c:type="IBusBus*"/>
1559
1560
</instance-parameter>
1560
1561
<parameter name="res" transfer-ownership="none">
1561
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_get_global_engine_async_finish().</doc>
1562
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_get_global_engine_async_finish().</doc>
1562
1563
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1566
1567
<method name="get_ibus_property"
1567
1568
c:identifier="ibus_bus_get_ibus_property">
1568
<doc xml:whitespace="preserve">Get org.freedesktop.DBus.Properties.</doc>
1569
<doc xml:space="preserve">Get org.freedesktop.DBus.Properties.</doc>
1569
1570
<return-value transfer-ownership="full">
1570
<doc xml:whitespace="preserve">The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with g_variant_unref().</doc>
1571
<doc xml:space="preserve">The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with g_variant_unref().</doc>
1571
1572
<type name="GLib.Variant" c:type="GVariant*"/>
1572
1573
</return-value>
1574
1575
<instance-parameter name="bus" transfer-ownership="none">
1575
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1576
<doc xml:space="preserve">An #IBusBus.</doc>
1576
1577
<type name="Bus" c:type="IBusBus*"/>
1577
1578
</instance-parameter>
1578
1579
<parameter name="property_name" transfer-ownership="none">
1579
<doc xml:whitespace="preserve">property name in org.freedesktop.DBus.Properties.Get</doc>
1580
<doc xml:space="preserve">property name in org.freedesktop.DBus.Properties.Get</doc>
1580
1581
<type name="utf8" c:type="const gchar*"/>
1584
1585
<method name="get_ibus_property_async"
1585
1586
c:identifier="ibus_bus_get_ibus_property_async">
1586
<doc xml:whitespace="preserve">Get org.freedesktop.DBus.Properties asynchronously.</doc>
1587
<doc xml:space="preserve">Get org.freedesktop.DBus.Properties asynchronously.</doc>
1587
1588
<return-value transfer-ownership="none">
1588
1589
<type name="none" c:type="void"/>
1589
1590
</return-value>
1591
1592
<instance-parameter name="bus" transfer-ownership="none">
1592
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1593
<doc xml:space="preserve">An #IBusBus.</doc>
1593
1594
<type name="Bus" c:type="IBusBus*"/>
1594
1595
</instance-parameter>
1595
1596
<parameter name="property_name" transfer-ownership="none">
1596
<doc xml:whitespace="preserve">property name in org.freedesktop.DBus.Properties.Get</doc>
1597
<doc xml:space="preserve">property name in org.freedesktop.DBus.Properties.Get</doc>
1597
1598
<type name="utf8" c:type="const gchar*"/>
1599
1600
<parameter name="timeout_msec" transfer-ownership="none">
1600
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1601
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1601
1602
<type name="gint" c:type="gint"/>
1603
1604
<parameter name="cancellable"
1604
1605
transfer-ownership="none"
1605
1606
allow-none="1">
1606
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1607
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1607
1608
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1609
1610
<parameter name="callback"
1623
1624
<method name="get_ibus_property_async_finish"
1624
1625
c:identifier="ibus_bus_get_ibus_property_async_finish"
1626
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_get_ibus_property_async().</doc>
1627
<doc xml:space="preserve">Finishes an operation started with ibus_bus_get_ibus_property_async().</doc>
1627
1628
<return-value transfer-ownership="full">
1628
<doc xml:whitespace="preserve">The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with g_variant_unref().</doc>
1629
<doc xml:space="preserve">The value in org.freedesktop.DBus.Properties.Get The returned value must be freed with g_variant_unref().</doc>
1629
1630
<type name="GLib.Variant" c:type="GVariant*"/>
1630
1631
</return-value>
1632
1633
<instance-parameter name="bus" transfer-ownership="none">
1633
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1634
<doc xml:space="preserve">An #IBusBus.</doc>
1634
1635
<type name="Bus" c:type="IBusBus*"/>
1635
1636
</instance-parameter>
1636
1637
<parameter name="res" transfer-ownership="none">
1637
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_get_property_async().</doc>
1638
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_get_property_async().</doc>
1638
1639
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
1642
1643
<method name="get_name_owner" c:identifier="ibus_bus_get_name_owner">
1643
<doc xml:whitespace="preserve">Return the name owner synchronously.</doc>
1644
<doc xml:space="preserve">Return the name owner synchronously.</doc>
1644
1645
<return-value transfer-ownership="full">
1645
<doc xml:whitespace="preserve">Owner of the name. The returned value must be freed with g_free().</doc>
1646
<doc xml:space="preserve">Owner of the name. The returned value must be freed with g_free().</doc>
1646
1647
<type name="utf8" c:type="gchar*"/>
1647
1648
</return-value>
1649
1650
<instance-parameter name="bus" transfer-ownership="none">
1650
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1651
<doc xml:space="preserve">An #IBusBus.</doc>
1651
1652
<type name="Bus" c:type="IBusBus*"/>
1652
1653
</instance-parameter>
1653
1654
<parameter name="name" transfer-ownership="none">
1654
<doc xml:whitespace="preserve">Name.</doc>
1655
<doc xml:space="preserve">Name.</doc>
1655
1656
<type name="utf8" c:type="const gchar*"/>
1659
1660
<method name="get_name_owner_async"
1660
1661
c:identifier="ibus_bus_get_name_owner_async">
1661
<doc xml:whitespace="preserve">Return the name owner asynchronously.</doc>
1662
<doc xml:space="preserve">Return the name owner asynchronously.</doc>
1662
1663
<return-value transfer-ownership="none">
1663
1664
<type name="none" c:type="void"/>
1664
1665
</return-value>
1666
1667
<instance-parameter name="bus" transfer-ownership="none">
1667
<doc xml:whitespace="preserve">An #IBusBus.</doc>
1668
<doc xml:space="preserve">An #IBusBus.</doc>
1668
1669
<type name="Bus" c:type="IBusBus*"/>
1669
1670
</instance-parameter>
1670
1671
<parameter name="name" transfer-ownership="none">
1671
<doc xml:whitespace="preserve">Name.</doc>
1672
<doc xml:space="preserve">Name.</doc>
1672
1673
<type name="utf8" c:type="const gchar*"/>
1674
1675
<parameter name="timeout_msec" transfer-ownership="none">
1675
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1676
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
1676
1677
<type name="gint" c:type="gint"/>
1678
1679
<parameter name="cancellable"
1679
1680
transfer-ownership="none"
1680
1681
allow-none="1">
1681
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
1682
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
1682
1683
<type name="Gio.Cancellable" c:type="GCancellable*"/>
1684
1685
<parameter name="callback"
2023
2024
deprecated="Read dconf value /desktop/ibus/general/preload-engines instead."
2024
2025
deprecated-version="1.5.3"
2026
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_list_active_engines_async().</doc>
2027
<doc xml:space="preserve">Finishes an operation started with ibus_bus_list_active_engines_async().</doc>
2027
2028
<return-value transfer-ownership="container">
2028
<doc xml:whitespace="preserve">A List of active engines.</doc>
2029
<doc xml:space="preserve">A List of active engines.</doc>
2029
2030
<type name="GLib.List" c:type="GList*">
2030
2031
<type name="EngineDesc"/>
2032
2033
</return-value>
2034
2035
<instance-parameter name="bus" transfer-ownership="none">
2035
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2036
<doc xml:space="preserve">An #IBusBus.</doc>
2036
2037
<type name="Bus" c:type="IBusBus*"/>
2037
2038
</instance-parameter>
2038
2039
<parameter name="res" transfer-ownership="none">
2039
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_list_active_engines_async().</doc>
2040
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_list_active_engines_async().</doc>
2040
2041
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2044
2045
<method name="list_engines" c:identifier="ibus_bus_list_engines">
2045
<doc xml:whitespace="preserve">List engines synchronously.</doc>
2046
<doc xml:space="preserve">List engines synchronously.</doc>
2046
2047
<return-value transfer-ownership="container">
2047
<doc xml:whitespace="preserve">A List of engines.</doc>
2048
<doc xml:space="preserve">A List of engines.</doc>
2048
2049
<type name="GLib.List" c:type="GList*">
2049
2050
<type name="EngineDesc"/>
2051
2052
</return-value>
2053
2054
<instance-parameter name="bus" transfer-ownership="none">
2054
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2055
<doc xml:space="preserve">An #IBusBus.</doc>
2055
2056
<type name="Bus" c:type="IBusBus*"/>
2056
2057
</instance-parameter>
2059
2060
<method name="list_engines_async"
2060
2061
c:identifier="ibus_bus_list_engines_async">
2061
<doc xml:whitespace="preserve">List engines asynchronously.</doc>
2062
<doc xml:space="preserve">List engines asynchronously.</doc>
2062
2063
<return-value transfer-ownership="none">
2063
2064
<type name="none" c:type="void"/>
2064
2065
</return-value>
2066
2067
<instance-parameter name="bus" transfer-ownership="none">
2067
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2068
<doc xml:space="preserve">An #IBusBus.</doc>
2068
2069
<type name="Bus" c:type="IBusBus*"/>
2069
2070
</instance-parameter>
2070
2071
<parameter name="timeout_msec" transfer-ownership="none">
2071
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2072
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2072
2073
<type name="gint" c:type="gint"/>
2074
2075
<parameter name="cancellable"
2075
2076
transfer-ownership="none"
2076
2077
allow-none="1">
2077
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2078
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2078
2079
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2080
2081
<parameter name="callback"
2094
2095
<method name="list_engines_async_finish"
2095
2096
c:identifier="ibus_bus_list_engines_async_finish"
2097
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_list_engines_async().</doc>
2098
<doc xml:space="preserve">Finishes an operation started with ibus_bus_list_engines_async().</doc>
2098
2099
<return-value transfer-ownership="container">
2099
<doc xml:whitespace="preserve">A List of engines.</doc>
2100
<doc xml:space="preserve">A List of engines.</doc>
2100
2101
<type name="GLib.List" c:type="GList*">
2101
2102
<type name="EngineDesc"/>
2103
2104
</return-value>
2105
2106
<instance-parameter name="bus" transfer-ownership="none">
2106
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2107
<doc xml:space="preserve">An #IBusBus.</doc>
2107
2108
<type name="Bus" c:type="IBusBus*"/>
2108
2109
</instance-parameter>
2109
2110
<parameter name="res" transfer-ownership="none">
2110
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_list_engines_async().</doc>
2111
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_list_engines_async().</doc>
2111
2112
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2115
2116
<method name="list_names" c:identifier="ibus_bus_list_names">
2116
<doc xml:whitespace="preserve">Return lists that attached to @bus.
2117
<doc xml:space="preserve">Return lists that attached to @bus.
2117
2118
<note><para>[FixMe] Not implemented yet, only return NULL.</para></note>
2118
2119
<note><para>[FixMe] Add async version.</para></note></doc>
2119
2120
<return-value transfer-ownership="full">
2120
<doc xml:whitespace="preserve">Lists that attached to @bus.</doc>
2121
<doc xml:space="preserve">Lists that attached to @bus.</doc>
2121
2122
<type name="GLib.List" c:type="GList*">
2122
2123
<type name="utf8"/>
2124
2125
</return-value>
2126
2127
<instance-parameter name="bus" transfer-ownership="none">
2127
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2128
<doc xml:space="preserve">An #IBusBus.</doc>
2128
2129
<type name="Bus" c:type="IBusBus*"/>
2129
2130
</instance-parameter>
2132
2133
<method name="list_queued_owners"
2133
2134
c:identifier="ibus_bus_list_queued_owners">
2134
<doc xml:whitespace="preserve">Lists the unique bus names of connections currently queued for a bus name.
2135
<doc xml:space="preserve">Lists the unique bus names of connections currently queued for a bus name.
2136
2137
FIXME add an asynchronous version.</doc>
2137
2138
<return-value transfer-ownership="full">
2138
<doc xml:whitespace="preserve">The unique bus names of connections currently queued for @name.</doc>
2139
<doc xml:space="preserve">The unique bus names of connections currently queued for @name.</doc>
2139
2140
<type name="GLib.List" c:type="GList*">
2140
2141
<type name="utf8"/>
2142
2143
</return-value>
2144
2145
<instance-parameter name="bus" transfer-ownership="none">
2145
<doc xml:whitespace="preserve">An IBusBus.</doc>
2146
<doc xml:space="preserve">An IBusBus.</doc>
2146
2147
<type name="Bus" c:type="IBusBus*"/>
2147
2148
</instance-parameter>
2148
2149
<parameter name="name" transfer-ownership="none">
2149
<doc xml:whitespace="preserve">Name to be queried.</doc>
2150
<doc xml:space="preserve">Name to be queried.</doc>
2150
2151
<type name="utf8" c:type="const gchar*"/>
2154
2155
<method name="name_has_owner" c:identifier="ibus_bus_name_has_owner">
2155
<doc xml:whitespace="preserve">Checks whether the name has owner synchronously.</doc>
2156
<doc xml:space="preserve">Checks whether the name has owner synchronously.</doc>
2156
2157
<return-value transfer-ownership="none">
2157
<doc xml:whitespace="preserve">%TRUE if the name has owner, %FALSE otherwise.</doc>
2158
<doc xml:space="preserve">%TRUE if the name has owner, %FALSE otherwise.</doc>
2158
2159
<type name="gboolean" c:type="gboolean"/>
2159
2160
</return-value>
2161
2162
<instance-parameter name="bus" transfer-ownership="none">
2162
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2163
<doc xml:space="preserve">An #IBusBus.</doc>
2163
2164
<type name="Bus" c:type="IBusBus*"/>
2164
2165
</instance-parameter>
2165
2166
<parameter name="name" transfer-ownership="none">
2166
<doc xml:whitespace="preserve">Name to be checked.</doc>
2167
<doc xml:space="preserve">Name to be checked.</doc>
2167
2168
<type name="utf8" c:type="const gchar*"/>
2171
2172
<method name="name_has_owner_async"
2172
2173
c:identifier="ibus_bus_name_has_owner_async">
2173
<doc xml:whitespace="preserve">Checks whether the name has owner asynchronously.</doc>
2174
<doc xml:space="preserve">Checks whether the name has owner asynchronously.</doc>
2174
2175
<return-value transfer-ownership="none">
2175
2176
<type name="none" c:type="void"/>
2176
2177
</return-value>
2178
2179
<instance-parameter name="bus" transfer-ownership="none">
2179
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2180
<doc xml:space="preserve">An #IBusBus.</doc>
2180
2181
<type name="Bus" c:type="IBusBus*"/>
2181
2182
</instance-parameter>
2182
2183
<parameter name="name" transfer-ownership="none">
2183
<doc xml:whitespace="preserve">Name to be checked.</doc>
2184
<doc xml:space="preserve">Name to be checked.</doc>
2184
2185
<type name="utf8" c:type="const gchar*"/>
2186
2187
<parameter name="timeout_msec" transfer-ownership="none">
2187
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2188
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2188
2189
<type name="gint" c:type="gint"/>
2190
2191
<parameter name="cancellable"
2191
2192
transfer-ownership="none"
2192
2193
allow-none="1">
2193
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2194
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2194
2195
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2196
2197
<parameter name="callback"
2289
2290
<method name="preload_engines_async_finish"
2290
2291
c:identifier="ibus_bus_preload_engines_async_finish"
2292
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_preload_engines_async().</doc>
2293
<doc xml:space="preserve">Finishes an operation started with ibus_bus_preload_engines_async().</doc>
2293
2294
<return-value transfer-ownership="none">
2294
<doc xml:whitespace="preserve">%TRUE if component starts. %FALSE otherwise.</doc>
2295
<doc xml:space="preserve">%TRUE if component starts. %FALSE otherwise.</doc>
2295
2296
<type name="gboolean" c:type="gboolean"/>
2296
2297
</return-value>
2298
2299
<instance-parameter name="bus" transfer-ownership="none">
2299
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2300
<doc xml:space="preserve">An #IBusBus.</doc>
2300
2301
<type name="Bus" c:type="IBusBus*"/>
2301
2302
</instance-parameter>
2302
2303
<parameter name="res" transfer-ownership="none">
2303
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_preload_engines_async().</doc>
2304
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_preload_engines_async().</doc>
2304
2305
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2308
2309
<method name="register_component"
2309
2310
c:identifier="ibus_bus_register_component">
2310
<doc xml:whitespace="preserve">Register a componet to an #IBusBus synchronously.</doc>
2311
<doc xml:space="preserve">Register a componet to an #IBusBus synchronously.</doc>
2311
2312
<return-value transfer-ownership="none">
2312
<doc xml:whitespace="preserve">%TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.</doc>
2313
<doc xml:space="preserve">%TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.</doc>
2313
2314
<type name="gboolean" c:type="gboolean"/>
2314
2315
</return-value>
2316
2317
<instance-parameter name="bus" transfer-ownership="none">
2317
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2318
<doc xml:space="preserve">An #IBusBus.</doc>
2318
2319
<type name="Bus" c:type="IBusBus*"/>
2319
2320
</instance-parameter>
2320
2321
<parameter name="component" transfer-ownership="none">
2321
<doc xml:whitespace="preserve">A input engine component.</doc>
2322
<doc xml:space="preserve">A input engine component.</doc>
2322
2323
<type name="Component" c:type="IBusComponent*"/>
2326
2327
<method name="register_component_async"
2327
2328
c:identifier="ibus_bus_register_component_async">
2328
<doc xml:whitespace="preserve">Register a componet to an #IBusBus asynchronously.</doc>
2329
<doc xml:space="preserve">Register a componet to an #IBusBus asynchronously.</doc>
2329
2330
<return-value transfer-ownership="none">
2330
2331
<type name="none" c:type="void"/>
2331
2332
</return-value>
2333
2334
<instance-parameter name="bus" transfer-ownership="none">
2334
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2335
<doc xml:space="preserve">An #IBusBus.</doc>
2335
2336
<type name="Bus" c:type="IBusBus*"/>
2336
2337
</instance-parameter>
2337
2338
<parameter name="component" transfer-ownership="none">
2338
<doc xml:whitespace="preserve">A input engine component.</doc>
2339
<doc xml:space="preserve">A input engine component.</doc>
2339
2340
<type name="Component" c:type="IBusComponent*"/>
2341
2342
<parameter name="timeout_msec" transfer-ownership="none">
2342
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2343
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2343
2344
<type name="gint" c:type="gint"/>
2345
2346
<parameter name="cancellable"
2346
2347
transfer-ownership="none"
2347
2348
allow-none="1">
2348
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2349
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2349
2350
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2351
2352
<parameter name="callback"
2365
2366
<method name="register_component_async_finish"
2366
2367
c:identifier="ibus_bus_register_component_async_finish"
2368
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_register_component_async().</doc>
2369
<doc xml:space="preserve">Finishes an operation started with ibus_bus_register_component_async().</doc>
2369
2370
<return-value transfer-ownership="none">
2370
<doc xml:whitespace="preserve">%TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.</doc>
2371
<doc xml:space="preserve">%TRUE if the "RegisterComponent" call is suceeded, %FALSE otherwise.</doc>
2371
2372
<type name="gboolean" c:type="gboolean"/>
2372
2373
</return-value>
2374
2375
<instance-parameter name="bus" transfer-ownership="none">
2375
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2376
<doc xml:space="preserve">An #IBusBus.</doc>
2376
2377
<type name="Bus" c:type="IBusBus*"/>
2377
2378
</instance-parameter>
2378
2379
<parameter name="res" transfer-ownership="none">
2379
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_register_component_async().</doc>
2380
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_register_component_async().</doc>
2380
2381
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2384
2385
<method name="release_name" c:identifier="ibus_bus_release_name">
2385
<doc xml:whitespace="preserve">Release a name to IBus daemon synchronously.</doc>
2386
<doc xml:space="preserve">Release a name to IBus daemon synchronously.</doc>
2386
2387
<return-value transfer-ownership="none">
2387
<doc xml:whitespace="preserve">0 if failed; positive number otherwise.</doc>
2388
<doc xml:space="preserve">0 if failed; positive number otherwise.</doc>
2388
2389
<type name="guint" c:type="guint"/>
2389
2390
</return-value>
2391
2392
<instance-parameter name="bus" transfer-ownership="none">
2392
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2393
<doc xml:space="preserve">An #IBusBus.</doc>
2393
2394
<type name="Bus" c:type="IBusBus*"/>
2394
2395
</instance-parameter>
2395
2396
<parameter name="name" transfer-ownership="none">
2396
<doc xml:whitespace="preserve">Name to be released.</doc>
2397
<doc xml:space="preserve">Name to be released.</doc>
2397
2398
<type name="utf8" c:type="const gchar*"/>
2401
2402
<method name="release_name_async"
2402
2403
c:identifier="ibus_bus_release_name_async">
2403
<doc xml:whitespace="preserve">Release a name to IBus daemon asynchronously.</doc>
2404
<doc xml:space="preserve">Release a name to IBus daemon asynchronously.</doc>
2404
2405
<return-value transfer-ownership="none">
2405
2406
<type name="none" c:type="void"/>
2406
2407
</return-value>
2408
2409
<instance-parameter name="bus" transfer-ownership="none">
2409
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2410
<doc xml:space="preserve">An #IBusBus.</doc>
2410
2411
<type name="Bus" c:type="IBusBus*"/>
2411
2412
</instance-parameter>
2412
2413
<parameter name="name" transfer-ownership="none">
2413
<doc xml:whitespace="preserve">Name to be released.</doc>
2414
<doc xml:space="preserve">Name to be released.</doc>
2414
2415
<type name="utf8" c:type="const gchar*"/>
2416
2417
<parameter name="timeout_msec" transfer-ownership="none">
2417
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2418
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2418
2419
<type name="gint" c:type="gint"/>
2420
2421
<parameter name="cancellable"
2421
2422
transfer-ownership="none"
2422
2423
allow-none="1">
2423
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2424
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2424
2425
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2426
2427
<parameter name="callback"
2440
2441
<method name="release_name_async_finish"
2441
2442
c:identifier="ibus_bus_release_name_async_finish"
2443
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_release_name_async().</doc>
2444
<doc xml:space="preserve">Finishes an operation started with ibus_bus_release_name_async().</doc>
2444
2445
<return-value transfer-ownership="none">
2445
<doc xml:whitespace="preserve">0 if failed; positive number otherwise.</doc>
2446
<doc xml:space="preserve">0 if failed; positive number otherwise.</doc>
2446
2447
<type name="guint" c:type="guint"/>
2447
2448
</return-value>
2449
2450
<instance-parameter name="bus" transfer-ownership="none">
2450
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2451
<doc xml:space="preserve">An #IBusBus.</doc>
2451
2452
<type name="Bus" c:type="IBusBus*"/>
2452
2453
</instance-parameter>
2453
2454
<parameter name="res" transfer-ownership="none">
2454
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_release_name_async().</doc>
2455
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_release_name_async().</doc>
2455
2456
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2459
2460
<method name="remove_match" c:identifier="ibus_bus_remove_match">
2460
<doc xml:whitespace="preserve">Remove a match rule to an #IBusBus synchronously.</doc>
2461
<doc xml:space="preserve">Remove a match rule to an #IBusBus synchronously.</doc>
2461
2462
<return-value transfer-ownership="none">
2462
<doc xml:whitespace="preserve">%TRUE if the rule is removed. %FALSE otherwise.</doc>
2463
<doc xml:space="preserve">%TRUE if the rule is removed. %FALSE otherwise.</doc>
2463
2464
<type name="gboolean" c:type="gboolean"/>
2464
2465
</return-value>
2466
2467
<instance-parameter name="bus" transfer-ownership="none">
2467
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2468
<doc xml:space="preserve">An #IBusBus.</doc>
2468
2469
<type name="Bus" c:type="IBusBus*"/>
2469
2470
</instance-parameter>
2470
2471
<parameter name="rule" transfer-ownership="none">
2471
<doc xml:whitespace="preserve">Match rule.</doc>
2472
<doc xml:space="preserve">Match rule.</doc>
2472
2473
<type name="utf8" c:type="const gchar*"/>
2476
2477
<method name="remove_match_async"
2477
2478
c:identifier="ibus_bus_remove_match_async">
2478
<doc xml:whitespace="preserve">Remove a match rule to an IBusBus asynchronously.</doc>
2479
<doc xml:space="preserve">Remove a match rule to an IBusBus asynchronously.</doc>
2479
2480
<return-value transfer-ownership="none">
2480
2481
<type name="none" c:type="void"/>
2481
2482
</return-value>
2483
2484
<instance-parameter name="bus" transfer-ownership="none">
2484
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2485
<doc xml:space="preserve">An #IBusBus.</doc>
2485
2486
<type name="Bus" c:type="IBusBus*"/>
2486
2487
</instance-parameter>
2487
2488
<parameter name="rule" transfer-ownership="none">
2488
<doc xml:whitespace="preserve">Match rule.</doc>
2489
<doc xml:space="preserve">Match rule.</doc>
2489
2490
<type name="utf8" c:type="const gchar*"/>
2491
2492
<parameter name="timeout_msec" transfer-ownership="none">
2492
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2493
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2493
2494
<type name="gint" c:type="gint"/>
2495
2496
<parameter name="cancellable"
2496
2497
transfer-ownership="none"
2497
2498
allow-none="1">
2498
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2499
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2499
2500
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2501
2502
<parameter name="callback"
2515
2516
<method name="remove_match_async_finish"
2516
2517
c:identifier="ibus_bus_remove_match_async_finish"
2518
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_remove_match_async().</doc>
2519
<doc xml:space="preserve">Finishes an operation started with ibus_bus_remove_match_async().</doc>
2519
2520
<return-value transfer-ownership="none">
2520
<doc xml:whitespace="preserve">%TRUE if the rule is removed. %FALSE otherwise.</doc>
2521
<doc xml:space="preserve">%TRUE if the rule is removed. %FALSE otherwise.</doc>
2521
2522
<type name="gboolean" c:type="gboolean"/>
2522
2523
</return-value>
2524
2525
<instance-parameter name="bus" transfer-ownership="none">
2525
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2526
<doc xml:space="preserve">An #IBusBus.</doc>
2526
2527
<type name="Bus" c:type="IBusBus*"/>
2527
2528
</instance-parameter>
2528
2529
<parameter name="res" transfer-ownership="none">
2529
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_remove_match_async().</doc>
2530
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_remove_match_async().</doc>
2530
2531
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2534
2535
<method name="request_name" c:identifier="ibus_bus_request_name">
2535
<doc xml:whitespace="preserve">Request a name from IBus daemon synchronously.</doc>
2536
<doc xml:space="preserve">Request a name from IBus daemon synchronously.</doc>
2536
2537
<return-value transfer-ownership="none">
2537
<doc xml:whitespace="preserve">0 if failed; IBusBusRequestNameReply otherwise.</doc>
2538
<doc xml:space="preserve">0 if failed; IBusBusRequestNameReply otherwise.</doc>
2538
2539
<type name="guint32" c:type="guint32"/>
2539
2540
</return-value>
2541
2542
<instance-parameter name="bus" transfer-ownership="none">
2542
<doc xml:whitespace="preserve">the IBusBus instance to be processed.</doc>
2543
<doc xml:space="preserve">the IBusBus instance to be processed.</doc>
2543
2544
<type name="Bus" c:type="IBusBus*"/>
2544
2545
</instance-parameter>
2545
2546
<parameter name="name" transfer-ownership="none">
2546
<doc xml:whitespace="preserve">Name to be requested.</doc>
2547
<doc xml:space="preserve">Name to be requested.</doc>
2547
2548
<type name="utf8" c:type="const gchar*"/>
2549
2550
<parameter name="flags" transfer-ownership="none">
2550
<doc xml:whitespace="preserve">IBusBusNameFlag.</doc>
2551
<doc xml:space="preserve">IBusBusNameFlag.</doc>
2551
2552
<type name="guint32" c:type="guint32"/>
2555
2556
<method name="request_name_async"
2556
2557
c:identifier="ibus_bus_request_name_async">
2557
<doc xml:whitespace="preserve">Request a name from IBus daemon asynchronously.</doc>
2558
<doc xml:space="preserve">Request a name from IBus daemon asynchronously.</doc>
2558
2559
<return-value transfer-ownership="none">
2559
2560
<type name="none" c:type="void"/>
2560
2561
</return-value>
2562
2563
<instance-parameter name="bus" transfer-ownership="none">
2563
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2564
<doc xml:space="preserve">An #IBusBus.</doc>
2564
2565
<type name="Bus" c:type="IBusBus*"/>
2565
2566
</instance-parameter>
2566
2567
<parameter name="name" transfer-ownership="none">
2567
<doc xml:whitespace="preserve">Name to be requested.</doc>
2568
<doc xml:space="preserve">Name to be requested.</doc>
2568
2569
<type name="utf8" c:type="const gchar*"/>
2570
2571
<parameter name="flags" transfer-ownership="none">
2571
<doc xml:whitespace="preserve">Flags (FixMe).</doc>
2572
<doc xml:space="preserve">Flags (FixMe).</doc>
2572
2573
<type name="guint" c:type="guint"/>
2574
2575
<parameter name="timeout_msec" transfer-ownership="none">
2575
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2576
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2576
2577
<type name="gint" c:type="gint"/>
2578
2579
<parameter name="cancellable"
2579
2580
transfer-ownership="none"
2580
2581
allow-none="1">
2581
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2582
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2582
2583
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2584
2585
<parameter name="callback"
2598
2599
<method name="request_name_async_finish"
2599
2600
c:identifier="ibus_bus_request_name_async_finish"
2601
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_request_name_async().</doc>
2602
<doc xml:space="preserve">Finishes an operation started with ibus_bus_request_name_async().</doc>
2602
2603
<return-value transfer-ownership="none">
2603
<doc xml:whitespace="preserve">0 if failed; positive number otherwise.</doc>
2604
<doc xml:space="preserve">0 if failed; positive number otherwise.</doc>
2604
2605
<type name="guint" c:type="guint"/>
2605
2606
</return-value>
2607
2608
<instance-parameter name="bus" transfer-ownership="none">
2608
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2609
<doc xml:space="preserve">An #IBusBus.</doc>
2609
2610
<type name="Bus" c:type="IBusBus*"/>
2610
2611
</instance-parameter>
2611
2612
<parameter name="res" transfer-ownership="none">
2612
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_request_name_async().</doc>
2613
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_request_name_async().</doc>
2613
2614
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2617
2618
<method name="set_global_engine"
2618
2619
c:identifier="ibus_bus_set_global_engine">
2619
<doc xml:whitespace="preserve">Set current global engine synchronously.</doc>
2620
<doc xml:space="preserve">Set current global engine synchronously.</doc>
2620
2621
<return-value transfer-ownership="none">
2621
<doc xml:whitespace="preserve">%TRUE if the global engine was set successfully.</doc>
2622
<doc xml:space="preserve">%TRUE if the global engine was set successfully.</doc>
2622
2623
<type name="gboolean" c:type="gboolean"/>
2623
2624
</return-value>
2625
2626
<instance-parameter name="bus" transfer-ownership="none">
2626
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2627
<doc xml:space="preserve">An #IBusBus.</doc>
2627
2628
<type name="Bus" c:type="IBusBus*"/>
2628
2629
</instance-parameter>
2629
2630
<parameter name="global_engine" transfer-ownership="none">
2630
<doc xml:whitespace="preserve">A new engine name.</doc>
2631
<doc xml:space="preserve">A new engine name.</doc>
2631
2632
<type name="utf8" c:type="const gchar*"/>
2635
2636
<method name="set_global_engine_async"
2636
2637
c:identifier="ibus_bus_set_global_engine_async">
2637
<doc xml:whitespace="preserve">Set current global engine asynchronously.</doc>
2638
<doc xml:space="preserve">Set current global engine asynchronously.</doc>
2638
2639
<return-value transfer-ownership="none">
2639
2640
<type name="none" c:type="void"/>
2640
2641
</return-value>
2642
2643
<instance-parameter name="bus" transfer-ownership="none">
2643
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2644
<doc xml:space="preserve">An #IBusBus.</doc>
2644
2645
<type name="Bus" c:type="IBusBus*"/>
2645
2646
</instance-parameter>
2646
2647
<parameter name="global_engine" transfer-ownership="none">
2647
<doc xml:whitespace="preserve">A new engine name.</doc>
2648
<doc xml:space="preserve">A new engine name.</doc>
2648
2649
<type name="utf8" c:type="const gchar*"/>
2650
2651
<parameter name="timeout_msec" transfer-ownership="none">
2651
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2652
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2652
2653
<type name="gint" c:type="gint"/>
2654
2655
<parameter name="cancellable"
2655
2656
transfer-ownership="none"
2656
2657
allow-none="1">
2657
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2658
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2658
2659
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2660
2661
<parameter name="callback"
2674
2675
<method name="set_global_engine_async_finish"
2675
2676
c:identifier="ibus_bus_set_global_engine_async_finish"
2677
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_set_global_engine_async().</doc>
2678
<doc xml:space="preserve">Finishes an operation started with ibus_bus_set_global_engine_async().</doc>
2678
2679
<return-value transfer-ownership="none">
2679
<doc xml:whitespace="preserve">%TRUE if no IPC errros. %FALSE otherwise.</doc>
2680
<doc xml:space="preserve">%TRUE if no IPC errros. %FALSE otherwise.</doc>
2680
2681
<type name="gboolean" c:type="gboolean"/>
2681
2682
</return-value>
2683
2684
<instance-parameter name="bus" transfer-ownership="none">
2684
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2685
<doc xml:space="preserve">An #IBusBus.</doc>
2685
2686
<type name="Bus" c:type="IBusBus*"/>
2686
2687
</instance-parameter>
2687
2688
<parameter name="res" transfer-ownership="none">
2688
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_set_global_engine_async().</doc>
2689
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_set_global_engine_async().</doc>
2689
2690
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2693
2694
<method name="set_ibus_property"
2694
2695
c:identifier="ibus_bus_set_ibus_property">
2695
<doc xml:whitespace="preserve">Set org.freedesktop.DBus.Properties.</doc>
2696
<doc xml:space="preserve">Set org.freedesktop.DBus.Properties.</doc>
2696
2697
<return-value transfer-ownership="none">
2697
2698
<type name="none" c:type="void"/>
2698
2699
</return-value>
2700
2701
<instance-parameter name="bus" transfer-ownership="none">
2701
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2702
<doc xml:space="preserve">An #IBusBus.</doc>
2702
2703
<type name="Bus" c:type="IBusBus*"/>
2703
2704
</instance-parameter>
2704
2705
<parameter name="property_name" transfer-ownership="none">
2705
<doc xml:whitespace="preserve">property name in org.freedesktop.DBus.Properties.Set</doc>
2706
<doc xml:space="preserve">property name in org.freedesktop.DBus.Properties.Set</doc>
2706
2707
<type name="utf8" c:type="const gchar*"/>
2708
2709
<parameter name="value" transfer-ownership="none">
2709
<doc xml:whitespace="preserve">value in org.freedesktop.DBus.Properties.Set</doc>
2710
<doc xml:space="preserve">value in org.freedesktop.DBus.Properties.Set</doc>
2710
2711
<type name="GLib.Variant" c:type="GVariant*"/>
2714
2715
<method name="set_ibus_property_async"
2715
2716
c:identifier="ibus_bus_set_ibus_property_async">
2716
<doc xml:whitespace="preserve">Set org.freedesktop.DBus.Properties asynchronously.</doc>
2717
<doc xml:space="preserve">Set org.freedesktop.DBus.Properties asynchronously.</doc>
2717
2718
<return-value transfer-ownership="none">
2718
2719
<type name="none" c:type="void"/>
2719
2720
</return-value>
2721
2722
<instance-parameter name="bus" transfer-ownership="none">
2722
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2723
<doc xml:space="preserve">An #IBusBus.</doc>
2723
2724
<type name="Bus" c:type="IBusBus*"/>
2724
2725
</instance-parameter>
2725
2726
<parameter name="property_name" transfer-ownership="none">
2726
<doc xml:whitespace="preserve">property name in org.freedesktop.DBus.Properties.Set</doc>
2727
<doc xml:space="preserve">property name in org.freedesktop.DBus.Properties.Set</doc>
2727
2728
<type name="utf8" c:type="const gchar*"/>
2729
2730
<parameter name="value" transfer-ownership="none">
2730
<doc xml:whitespace="preserve">value in org.freedesktop.DBus.Properties.Set</doc>
2731
<doc xml:space="preserve">value in org.freedesktop.DBus.Properties.Set</doc>
2731
2732
<type name="GLib.Variant" c:type="GVariant*"/>
2733
2734
<parameter name="timeout_msec" transfer-ownership="none">
2734
<doc xml:whitespace="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2735
<doc xml:space="preserve">The timeout in milliseconds or -1 to use the default timeout.</doc>
2735
2736
<type name="gint" c:type="gint"/>
2737
2738
<parameter name="cancellable"
2738
2739
transfer-ownership="none"
2739
2740
allow-none="1">
2740
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
2741
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
2741
2742
<type name="Gio.Cancellable" c:type="GCancellable*"/>
2743
2744
<parameter name="callback"
2757
2758
<method name="set_ibus_property_async_finish"
2758
2759
c:identifier="ibus_bus_set_ibus_property_async_finish"
2760
<doc xml:whitespace="preserve">Finishes an operation started with ibus_bus_set_ibus_property_async().</doc>
2761
<doc xml:space="preserve">Finishes an operation started with ibus_bus_set_ibus_property_async().</doc>
2761
2762
<return-value transfer-ownership="none">
2762
<doc xml:whitespace="preserve">%TRUE if property is set with async. %FALSE failed.</doc>
2763
<doc xml:space="preserve">%TRUE if property is set with async. %FALSE failed.</doc>
2763
2764
<type name="gboolean" c:type="gboolean"/>
2764
2765
</return-value>
2766
2767
<instance-parameter name="bus" transfer-ownership="none">
2767
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2768
<doc xml:space="preserve">An #IBusBus.</doc>
2768
2769
<type name="Bus" c:type="IBusBus*"/>
2769
2770
</instance-parameter>
2770
2771
<parameter name="res" transfer-ownership="none">
2771
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_set_property_async().</doc>
2772
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback passed to ibus_bus_set_property_async().</doc>
2772
2773
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
2776
2777
<method name="set_watch_dbus_signal"
2777
2778
c:identifier="ibus_bus_set_watch_dbus_signal">
2778
<doc xml:whitespace="preserve">Start or stop watching the NameOwnerChanged DBus signal.</doc>
2779
<doc xml:space="preserve">Start or stop watching the NameOwnerChanged DBus signal.</doc>
2779
2780
<return-value transfer-ownership="none">
2780
2781
<type name="none" c:type="void"/>
2781
2782
</return-value>
2783
2784
<instance-parameter name="bus" transfer-ownership="none">
2784
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2785
<doc xml:space="preserve">An #IBusBus.</doc>
2785
2786
<type name="Bus" c:type="IBusBus*"/>
2786
2787
</instance-parameter>
2787
2788
<parameter name="watch" transfer-ownership="none">
2788
<doc xml:whitespace="preserve">%TRUE if you want ibusbus to emit "name-owner-changed" signal when ibus-daemon emits the NameOwnerChanged DBus signal.</doc>
2789
<doc xml:space="preserve">%TRUE if you want ibusbus to emit "name-owner-changed" signal when ibus-daemon emits the NameOwnerChanged DBus signal.</doc>
2789
2790
<type name="gboolean" c:type="gboolean"/>
2793
2794
<method name="set_watch_ibus_signal"
2794
2795
c:identifier="ibus_bus_set_watch_ibus_signal">
2795
<doc xml:whitespace="preserve">Start or stop watching the GlobalEngineChanged IBus signal.</doc>
2796
<doc xml:space="preserve">Start or stop watching the GlobalEngineChanged IBus signal.</doc>
2796
2797
<return-value transfer-ownership="none">
2797
2798
<type name="none" c:type="void"/>
2798
2799
</return-value>
2800
2801
<instance-parameter name="bus" transfer-ownership="none">
2801
<doc xml:whitespace="preserve">An #IBusBus.</doc>
2802
<doc xml:space="preserve">An #IBusBus.</doc>
2802
2803
<type name="Bus" c:type="IBusBus*"/>
2803
2804
</instance-parameter>
2804
2805
<parameter name="watch" transfer-ownership="none">
2805
<doc xml:whitespace="preserve">%TRUE if you want ibusbus to emit "global-engine-changed" signal when ibus-daemon emits the GlobalEngineChanged IBus signal.</doc>
2806
<doc xml:space="preserve">%TRUE if you want ibusbus to emit "global-engine-changed" signal when ibus-daemon emits the GlobalEngineChanged IBus signal.</doc>
2806
2807
<type name="gboolean" c:type="gboolean"/>
3047
3048
The format of a component XML file is described at
3048
3049
<ulink url="http://code.google.com/p/ibus/wiki/DevXML">http://code.google.com/p/ibus/wiki/DevXML</ulink></doc>
3049
3050
<constructor name="new" c:identifier="ibus_component_new">
3050
<doc xml:whitespace="preserve">New an IBusComponent.</doc>
3051
<doc xml:space="preserve">New an IBusComponent.</doc>
3051
3052
<return-value transfer-ownership="none">
3052
<doc xml:whitespace="preserve">A newly allocated IBusComponent.</doc>
3053
<doc xml:space="preserve">A newly allocated IBusComponent.</doc>
3053
3054
<type name="Component" c:type="IBusComponent*"/>
3054
3055
</return-value>
3056
3057
<parameter name="name" transfer-ownership="none">
3057
<doc xml:whitespace="preserve">Name of the component.</doc>
3058
<doc xml:space="preserve">Name of the component.</doc>
3058
3059
<type name="utf8" c:type="const gchar*"/>
3060
3061
<parameter name="description" transfer-ownership="none">
3061
<doc xml:whitespace="preserve">Detailed description of component.</doc>
3062
<doc xml:space="preserve">Detailed description of component.</doc>
3062
3063
<type name="utf8" c:type="const gchar*"/>
3064
3065
<parameter name="version" transfer-ownership="none">
3065
<doc xml:whitespace="preserve">Component version.</doc>
3066
<doc xml:space="preserve">Component version.</doc>
3066
3067
<type name="utf8" c:type="const gchar*"/>
3068
3069
<parameter name="license" transfer-ownership="none">
3069
<doc xml:whitespace="preserve">Distribution license of this component.</doc>
3070
<doc xml:space="preserve">Distribution license of this component.</doc>
3070
3071
<type name="utf8" c:type="const gchar*"/>
3072
3073
<parameter name="author" transfer-ownership="none">
3073
<doc xml:whitespace="preserve">Author(s) of the component.</doc>
3074
<doc xml:space="preserve">Author(s) of the component.</doc>
3074
3075
<type name="utf8" c:type="const gchar*"/>
3076
3077
<parameter name="homepage" transfer-ownership="none">
3077
<doc xml:whitespace="preserve">Homepage of the component.</doc>
3078
<doc xml:space="preserve">Homepage of the component.</doc>
3078
3079
<type name="utf8" c:type="const gchar*"/>
3080
3081
<parameter name="command_line" transfer-ownership="none">
3081
<doc xml:whitespace="preserve">path to component executable.</doc>
3082
<doc xml:space="preserve">path to component executable.</doc>
3082
3083
<type name="utf8" c:type="const gchar*"/>
3084
3085
<parameter name="textdomain" transfer-ownership="none">
3085
<doc xml:whitespace="preserve">Domain name for dgettext()</doc>
3086
<doc xml:space="preserve">Domain name for dgettext()</doc>
3086
3087
<type name="utf8" c:type="const gchar*"/>
3090
3091
<constructor name="new_from_file"
3091
3092
c:identifier="ibus_component_new_from_file">
3092
<doc xml:whitespace="preserve">New an IBusComponent from an XML file.
3093
<doc xml:space="preserve">New an IBusComponent from an XML file.
3093
3094
Note that a component file usually contains engine descriptions,
3094
3095
if it does, ibus_engine_desc_new_from_xml_node() will be called
3095
3096
to load the engine descriptions.</doc>
3096
3097
<return-value transfer-ownership="none">
3097
<doc xml:whitespace="preserve">A newly allocated IBusComponent.</doc>
3098
<doc xml:space="preserve">A newly allocated IBusComponent.</doc>
3098
3099
<type name="Component" c:type="IBusComponent*"/>
3099
3100
</return-value>
3101
3102
<parameter name="filename" transfer-ownership="none">
3102
<doc xml:whitespace="preserve">An XML file that contains component information.</doc>
3103
<doc xml:space="preserve">An XML file that contains component information.</doc>
3103
3104
<type name="utf8" c:type="const gchar*"/>
3145
3146
<method name="add_engine" c:identifier="ibus_component_add_engine">
3146
<doc xml:whitespace="preserve">Add an engine to IBusComponent according to the description in @engine.</doc>
3147
<doc xml:space="preserve">Add an engine to IBusComponent according to the description in @engine.</doc>
3147
3148
<return-value transfer-ownership="none">
3148
3149
<type name="none" c:type="void"/>
3149
3150
</return-value>
3151
3152
<instance-parameter name="component" transfer-ownership="none">
3152
<doc xml:whitespace="preserve">An IBusComponent</doc>
3153
<doc xml:space="preserve">An IBusComponent</doc>
3153
3154
<type name="Component" c:type="IBusComponent*"/>
3154
3155
</instance-parameter>
3155
3156
<parameter name="engine" transfer-ownership="none">
3156
<doc xml:whitespace="preserve">A description of an engine.</doc>
3157
<doc xml:space="preserve">A description of an engine.</doc>
3157
3158
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
3161
3162
<method name="add_observed_path"
3162
3163
c:identifier="ibus_component_add_observed_path">
3163
<doc xml:whitespace="preserve">Add an observed path to IBusComponent.</doc>
3164
<doc xml:space="preserve">Add an observed path to IBusComponent.</doc>
3164
3165
<return-value transfer-ownership="none">
3165
3166
<type name="none" c:type="void"/>
3166
3167
</return-value>
3168
3169
<instance-parameter name="component" transfer-ownership="none">
3169
<doc xml:whitespace="preserve">An IBusComponent</doc>
3170
<doc xml:space="preserve">An IBusComponent</doc>
3170
3171
<type name="Component" c:type="IBusComponent*"/>
3171
3172
</instance-parameter>
3172
3173
<parameter name="path" transfer-ownership="none">
3173
<doc xml:whitespace="preserve">Observed path to be added.</doc>
3174
<doc xml:space="preserve">Observed path to be added.</doc>
3174
3175
<type name="utf8" c:type="const gchar*"/>
3176
3177
<parameter name="access_fs" transfer-ownership="none">
3177
<doc xml:whitespace="preserve">TRUE for filling the file status; FALSE otherwise.</doc>
3178
<doc xml:space="preserve">TRUE for filling the file status; FALSE otherwise.</doc>
3178
3179
<type name="gboolean" c:type="gboolean"/>
3182
3183
<method name="check_modification"
3183
3184
c:identifier="ibus_component_check_modification">
3184
<doc xml:whitespace="preserve">Check whether the observed paths of component is modified.</doc>
3185
<doc xml:space="preserve">Check whether the observed paths of component is modified.</doc>
3185
3186
<return-value transfer-ownership="none">
3186
<doc xml:whitespace="preserve">TRUE if at least one of the observed paths is modified; FALSE otherwise.</doc>
3187
<doc xml:space="preserve">TRUE if at least one of the observed paths is modified; FALSE otherwise.</doc>
3187
3188
<type name="gboolean" c:type="gboolean"/>
3188
3189
</return-value>
3190
3191
<instance-parameter name="component" transfer-ownership="none">
3191
<doc xml:whitespace="preserve">An IBusComponent.</doc>
3192
<doc xml:space="preserve">An IBusComponent.</doc>
3192
3193
<type name="Component" c:type="IBusComponent*"/>
3193
3194
</instance-parameter>
3196
3197
<method name="get_author" c:identifier="ibus_component_get_author">
3197
<doc xml:whitespace="preserve">Return the author property in IBusComponent. It should not be freed.</doc>
3198
<doc xml:space="preserve">Return the author property in IBusComponent. It should not be freed.</doc>
3198
3199
<return-value transfer-ownership="none">
3199
<doc xml:whitespace="preserve">author property in IBusComponent</doc>
3200
<doc xml:space="preserve">author property in IBusComponent</doc>
3200
3201
<type name="utf8" c:type="const gchar*"/>
3201
3202
</return-value>
3203
3204
<instance-parameter name="component" transfer-ownership="none">
3204
<doc xml:whitespace="preserve">An IBusComponent</doc>
3205
<doc xml:space="preserve">An IBusComponent</doc>
3205
3206
<type name="Component" c:type="IBusComponent*"/>
3206
3207
</instance-parameter>
3209
3210
<method name="get_description"
3210
3211
c:identifier="ibus_component_get_description">
3211
<doc xml:whitespace="preserve">Return the description property in IBusComponent. It should not be freed.</doc>
3212
<doc xml:space="preserve">Return the description property in IBusComponent. It should not be freed.</doc>
3212
3213
<return-value transfer-ownership="none">
3213
<doc xml:whitespace="preserve">description property in IBusComponent</doc>
3214
<doc xml:space="preserve">description property in IBusComponent</doc>
3214
3215
<type name="utf8" c:type="const gchar*"/>
3215
3216
</return-value>
3217
3218
<instance-parameter name="component" transfer-ownership="none">
3218
<doc xml:whitespace="preserve">An IBusComponent</doc>
3219
<doc xml:space="preserve">An IBusComponent</doc>
3219
3220
<type name="Component" c:type="IBusComponent*"/>
3220
3221
</instance-parameter>
3223
3224
<method name="get_engines" c:identifier="ibus_component_get_engines">
3224
<doc xml:whitespace="preserve">Get the engines of this component.</doc>
3225
<doc xml:space="preserve">Get the engines of this component.</doc>
3225
3226
<return-value transfer-ownership="container">
3226
<doc xml:whitespace="preserve">A newly allocated GList that contains engines.</doc>
3227
<doc xml:space="preserve">A newly allocated GList that contains engines.</doc>
3227
3228
<type name="GLib.List" c:type="GList*">
3228
3229
<type name="EngineDesc"/>
3230
3231
</return-value>
3232
3233
<instance-parameter name="component" transfer-ownership="none">
3233
<doc xml:whitespace="preserve">An IBusComponent.</doc>
3234
<doc xml:space="preserve">An IBusComponent.</doc>
3234
3235
<type name="Component" c:type="IBusComponent*"/>
3235
3236
</instance-parameter>
3238
3239
<method name="get_exec" c:identifier="ibus_component_get_exec">
3239
<doc xml:whitespace="preserve">Return the exec property in IBusComponent. It should not be freed.</doc>
3240
<doc xml:space="preserve">Return the exec property in IBusComponent. It should not be freed.</doc>
3240
3241
<return-value transfer-ownership="none">
3241
<doc xml:whitespace="preserve">exec property in IBusComponent</doc>
3242
<doc xml:space="preserve">exec property in IBusComponent</doc>
3242
3243
<type name="utf8" c:type="const gchar*"/>
3243
3244
</return-value>
3245
3246
<instance-parameter name="component" transfer-ownership="none">
3246
<doc xml:whitespace="preserve">An IBusComponent</doc>
3247
<doc xml:space="preserve">An IBusComponent</doc>
3247
3248
<type name="Component" c:type="IBusComponent*"/>
3248
3249
</instance-parameter>
3251
3252
<method name="get_homepage" c:identifier="ibus_component_get_homepage">
3252
<doc xml:whitespace="preserve">Return the homepage property in IBusComponent. It should not be freed.</doc>
3253
<doc xml:space="preserve">Return the homepage property in IBusComponent. It should not be freed.</doc>
3253
3254
<return-value transfer-ownership="none">
3254
<doc xml:whitespace="preserve">homepage property in IBusComponent</doc>
3255
<doc xml:space="preserve">homepage property in IBusComponent</doc>
3255
3256
<type name="utf8" c:type="const gchar*"/>
3256
3257
</return-value>
3258
3259
<instance-parameter name="component" transfer-ownership="none">
3259
<doc xml:whitespace="preserve">An IBusComponent</doc>
3260
<doc xml:space="preserve">An IBusComponent</doc>
3260
3261
<type name="Component" c:type="IBusComponent*"/>
3261
3262
</instance-parameter>
3264
3265
<method name="get_license" c:identifier="ibus_component_get_license">
3265
<doc xml:whitespace="preserve">Return the license property in IBusComponent. It should not be freed.</doc>
3266
<doc xml:space="preserve">Return the license property in IBusComponent. It should not be freed.</doc>
3266
3267
<return-value transfer-ownership="none">
3267
<doc xml:whitespace="preserve">license property in IBusComponent</doc>
3268
<doc xml:space="preserve">license property in IBusComponent</doc>
3268
3269
<type name="utf8" c:type="const gchar*"/>
3269
3270
</return-value>
3271
3272
<instance-parameter name="component" transfer-ownership="none">
3272
<doc xml:whitespace="preserve">An IBusComponent</doc>
3273
<doc xml:space="preserve">An IBusComponent</doc>
3273
3274
<type name="Component" c:type="IBusComponent*"/>
3274
3275
</instance-parameter>
3277
3278
<method name="get_name" c:identifier="ibus_component_get_name">
3278
<doc xml:whitespace="preserve">Return the name property in IBusComponent. It should not be freed.</doc>
3279
<doc xml:space="preserve">Return the name property in IBusComponent. It should not be freed.</doc>
3279
3280
<return-value transfer-ownership="none">
3280
<doc xml:whitespace="preserve">name property in IBusComponent</doc>
3281
<doc xml:space="preserve">name property in IBusComponent</doc>
3281
3282
<type name="utf8" c:type="const gchar*"/>
3282
3283
</return-value>
3284
3285
<instance-parameter name="component" transfer-ownership="none">
3285
<doc xml:whitespace="preserve">An IBusComponent</doc>
3286
<doc xml:space="preserve">An IBusComponent</doc>
3286
3287
<type name="Component" c:type="IBusComponent*"/>
3287
3288
</instance-parameter>
3290
3291
<method name="get_observed_paths"
3291
3292
c:identifier="ibus_component_get_observed_paths">
3292
<doc xml:whitespace="preserve">Get the observed paths of this component.</doc>
3293
<doc xml:space="preserve">Get the observed paths of this component.</doc>
3293
3294
<return-value transfer-ownership="container">
3294
<doc xml:whitespace="preserve">A newly allocated GList that contains observed paths.</doc>
3295
<doc xml:space="preserve">A newly allocated GList that contains observed paths.</doc>
3295
3296
<type name="GLib.List" c:type="GList*">
3296
3297
<type name="ObservedPath"/>
3298
3299
</return-value>
3300
3301
<instance-parameter name="component" transfer-ownership="none">
3301
<doc xml:whitespace="preserve">An IBusComponent.</doc>
3302
<doc xml:space="preserve">An IBusComponent.</doc>
3302
3303
<type name="Component" c:type="IBusComponent*"/>
3303
3304
</instance-parameter>
3306
3307
<method name="get_textdomain"
3307
3308
c:identifier="ibus_component_get_textdomain">
3308
<doc xml:whitespace="preserve">Return the textdomain property in IBusComponent. It should not be freed.</doc>
3309
<doc xml:space="preserve">Return the textdomain property in IBusComponent. It should not be freed.</doc>
3309
3310
<return-value transfer-ownership="none">
3310
<doc xml:whitespace="preserve">textdomain property in IBusComponent</doc>
3311
<doc xml:space="preserve">textdomain property in IBusComponent</doc>
3311
3312
<type name="utf8" c:type="const gchar*"/>
3312
3313
</return-value>
3314
3315
<instance-parameter name="component" transfer-ownership="none">
3315
<doc xml:whitespace="preserve">An IBusComponent</doc>
3316
<doc xml:space="preserve">An IBusComponent</doc>
3316
3317
<type name="Component" c:type="IBusComponent*"/>
3317
3318
</instance-parameter>
3320
3321
<method name="get_version" c:identifier="ibus_component_get_version">
3321
<doc xml:whitespace="preserve">Return the version property in IBusComponent. It should not be freed.</doc>
3322
<doc xml:space="preserve">Return the version property in IBusComponent. It should not be freed.</doc>
3322
3323
<return-value transfer-ownership="none">
3323
<doc xml:whitespace="preserve">version property in IBusComponent</doc>
3324
<doc xml:space="preserve">version property in IBusComponent</doc>
3324
3325
<type name="utf8" c:type="const gchar*"/>
3325
3326
</return-value>
3327
3328
<instance-parameter name="component" transfer-ownership="none">
3328
<doc xml:whitespace="preserve">An IBusComponent</doc>
3329
<doc xml:space="preserve">An IBusComponent</doc>
3329
3330
<type name="Component" c:type="IBusComponent*"/>
3330
3331
</instance-parameter>
3333
3334
<method name="output" c:identifier="ibus_component_output">
3334
<doc xml:whitespace="preserve">Output IBusComponent as an XML-formatted string.
3335
<doc xml:space="preserve">Output IBusComponent as an XML-formatted string.
3335
3336
The output string can be then shown on the screen or written to file.</doc>
3336
3337
<return-value transfer-ownership="none">
3337
3338
<type name="none" c:type="void"/>
3338
3339
</return-value>
3340
3341
<instance-parameter name="component" transfer-ownership="none">
3341
<doc xml:whitespace="preserve">An IBusComponent.</doc>
3342
<doc xml:space="preserve">An IBusComponent.</doc>
3342
3343
<type name="Component" c:type="IBusComponent*"/>
3343
3344
</instance-parameter>
3344
3345
<parameter name="output" transfer-ownership="none">
3345
<doc xml:whitespace="preserve">GString that holds the result.</doc>
3346
<doc xml:space="preserve">GString that holds the result.</doc>
3346
3347
<type name="GLib.String" c:type="GString*"/>
3348
3349
<parameter name="indent" transfer-ownership="none">
3349
<doc xml:whitespace="preserve">level of indent.</doc>
3350
<doc xml:space="preserve">level of indent.</doc>
3350
3351
<type name="gint" c:type="gint"/>
3354
3355
<method name="output_engines"
3355
3356
c:identifier="ibus_component_output_engines">
3356
<doc xml:whitespace="preserve">Output engine description as an XML-formatted string.
3357
<doc xml:space="preserve">Output engine description as an XML-formatted string.
3357
3358
The output string can be then shown on the screen or written to file.</doc>
3358
3359
<return-value transfer-ownership="none">
3359
3360
<type name="none" c:type="void"/>
3360
3361
</return-value>
3362
3363
<instance-parameter name="component" transfer-ownership="none">
3363
<doc xml:whitespace="preserve">An IBusComponent.</doc>
3364
<doc xml:space="preserve">An IBusComponent.</doc>
3364
3365
<type name="Component" c:type="IBusComponent*"/>
3365
3366
</instance-parameter>
3366
3367
<parameter name="output" transfer-ownership="none">
3367
<doc xml:whitespace="preserve">GString that holds the result.</doc>
3368
<doc xml:space="preserve">GString that holds the result.</doc>
3368
3369
<type name="GLib.String" c:type="GString*"/>
3370
3371
<parameter name="indent" transfer-ownership="none">
3371
<doc xml:whitespace="preserve">level of indent.</doc>
3372
<doc xml:space="preserve">level of indent.</doc>
3372
3373
<type name="gint" c:type="gint"/>
3688
3689
<method name="get_values_async_finish"
3689
3690
c:identifier="ibus_config_get_values_async_finish"
3691
<doc xml:whitespace="preserve">Finish get values in a section.
3692
<doc xml:space="preserve">Finish get values in a section.
3693
3694
See also: ibus_config_get_values_async().</doc>
3694
3695
<return-value transfer-ownership="full">
3695
<doc xml:whitespace="preserve">A #GVariant or %NULL if error is set. Free with g_variant_unref().</doc>
3696
<doc xml:space="preserve">A #GVariant or %NULL if error is set. Free with g_variant_unref().</doc>
3696
3697
<type name="GLib.Variant" c:type="GVariant*"/>
3697
3698
</return-value>
3699
3700
<instance-parameter name="config" transfer-ownership="none">
3700
<doc xml:whitespace="preserve">A #IBusConfig.</doc>
3701
<doc xml:space="preserve">A #IBusConfig.</doc>
3701
3702
<type name="Config" c:type="IBusConfig*"/>
3702
3703
</instance-parameter>
3703
3704
<parameter name="result" transfer-ownership="none">
3704
<doc xml:whitespace="preserve">A #GAsyncResult.</doc>
3705
<doc xml:space="preserve">A #GAsyncResult.</doc>
3705
3706
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
3709
3710
<method name="set_value" c:identifier="ibus_config_set_value">
3710
<doc xml:whitespace="preserve">Set the value of a configuration option synchronously.
3711
<doc xml:space="preserve">Set the value of a configuration option synchronously.
3711
3712
See also: ibus_config_get_value().</doc>
3712
3713
<return-value transfer-ownership="none">
3713
<doc xml:whitespace="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3714
<doc xml:space="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3714
3715
<type name="gboolean" c:type="gboolean"/>
3715
3716
</return-value>
3717
3718
<instance-parameter name="config" transfer-ownership="none">
3718
<doc xml:whitespace="preserve">An #IBusConfig</doc>
3719
<doc xml:space="preserve">An #IBusConfig</doc>
3719
3720
<type name="Config" c:type="IBusConfig*"/>
3720
3721
</instance-parameter>
3721
3722
<parameter name="section" transfer-ownership="none">
3722
<doc xml:whitespace="preserve">Section name of the configuration option.</doc>
3723
<doc xml:space="preserve">Section name of the configuration option.</doc>
3723
3724
<type name="utf8" c:type="const gchar*"/>
3725
3726
<parameter name="name" transfer-ownership="none">
3726
<doc xml:whitespace="preserve">Name of the configure option its self.</doc>
3727
<doc xml:space="preserve">Name of the configure option its self.</doc>
3727
3728
<type name="utf8" c:type="const gchar*"/>
3729
3730
<parameter name="value" transfer-ownership="none">
3730
<doc xml:whitespace="preserve">A #GVariant that holds the value. If the value is floating, the function takes ownership of it.</doc>
3731
<doc xml:space="preserve">A #GVariant that holds the value. If the value is floating, the function takes ownership of it.</doc>
3731
3732
<type name="GLib.Variant" c:type="GVariant*"/>
3735
3736
<method name="set_value_async"
3736
3737
c:identifier="ibus_config_set_value_async">
3737
<doc xml:whitespace="preserve">Set the value of a configuration option asynchronously.
3738
<doc xml:space="preserve">Set the value of a configuration option asynchronously.
3739
3740
See also: ibus_config_set_value().</doc>
3740
3741
<return-value transfer-ownership="none">
3784
3785
<method name="set_value_async_finish"
3785
3786
c:identifier="ibus_config_set_value_async_finish"
3787
<doc xml:whitespace="preserve">Finish set value of a configuration option.
3788
<doc xml:space="preserve">Finish set value of a configuration option.
3789
3790
See also: ibus_config_set_value_async().</doc>
3790
3791
<return-value transfer-ownership="none">
3791
<doc xml:whitespace="preserve">%TRUE or %FALSE if error is set.</doc>
3792
<doc xml:space="preserve">%TRUE or %FALSE if error is set.</doc>
3792
3793
<type name="gboolean" c:type="gboolean"/>
3793
3794
</return-value>
3795
3796
<instance-parameter name="config" transfer-ownership="none">
3796
<doc xml:whitespace="preserve">A #IBusConfig.</doc>
3797
<doc xml:space="preserve">A #IBusConfig.</doc>
3797
3798
<type name="Config" c:type="IBusConfig*"/>
3798
3799
</instance-parameter>
3799
3800
<parameter name="result" transfer-ownership="none">
3800
<doc xml:whitespace="preserve">A #GAsyncResult.</doc>
3801
<doc xml:space="preserve">A #GAsyncResult.</doc>
3801
3802
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
3805
3806
<method name="unset" c:identifier="ibus_config_unset">
3806
<doc xml:whitespace="preserve">Remove an entry of a configuration option.
3807
<doc xml:space="preserve">Remove an entry of a configuration option.
3807
3808
See also: ibus_config_get_value().</doc>
3808
3809
<return-value transfer-ownership="none">
3809
<doc xml:whitespace="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3810
<doc xml:space="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3810
3811
<type name="gboolean" c:type="gboolean"/>
3811
3812
</return-value>
3813
3814
<instance-parameter name="config" transfer-ownership="none">
3814
<doc xml:whitespace="preserve">An #IBusConfig</doc>
3815
<doc xml:space="preserve">An #IBusConfig</doc>
3815
3816
<type name="Config" c:type="IBusConfig*"/>
3816
3817
</instance-parameter>
3817
3818
<parameter name="section" transfer-ownership="none">
3818
<doc xml:whitespace="preserve">Section name of the configuration option.</doc>
3819
<doc xml:space="preserve">Section name of the configuration option.</doc>
3819
3820
<type name="utf8" c:type="const gchar*"/>
3821
3822
<parameter name="name" transfer-ownership="none">
3822
<doc xml:whitespace="preserve">Name of the configure option its self.</doc>
3823
<doc xml:space="preserve">Name of the configure option its self.</doc>
3823
3824
<type name="utf8" c:type="const gchar*"/>
3827
3828
<method name="unwatch" c:identifier="ibus_config_unwatch">
3828
<doc xml:whitespace="preserve">Unsubscribe from the configuration option change notification.
3829
<doc xml:space="preserve">Unsubscribe from the configuration option change notification.
3830
3831
See also: ibus_config_watch.</doc>
3831
3832
<return-value transfer-ownership="none">
3832
<doc xml:whitespace="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3833
<doc xml:space="preserve">%TRUE if succeed; %FALSE otherwise.</doc>
3833
3834
<type name="gboolean" c:type="gboolean"/>
3834
3835
</return-value>
3836
3837
<instance-parameter name="config" transfer-ownership="none">
3837
<doc xml:whitespace="preserve">An #IBusConfig</doc>
3838
<doc xml:space="preserve">An #IBusConfig</doc>
3838
3839
<type name="Config" c:type="IBusConfig*"/>
3839
3840
</instance-parameter>
3840
3841
<parameter name="section" transfer-ownership="none" allow-none="1">
3841
<doc xml:whitespace="preserve">Section name of the configuration option.</doc>
3842
<doc xml:space="preserve">Section name of the configuration option.</doc>
3842
3843
<type name="utf8" c:type="const gchar*"/>
3844
3845
<parameter name="name" transfer-ownership="none" allow-none="1">
3845
<doc xml:whitespace="preserve">Name of the configure option its self.</doc>
3846
<doc xml:space="preserve">Name of the configure option its self.</doc>
3846
3847
<type name="utf8" c:type="const gchar*"/>
3850
3851
<method name="watch" c:identifier="ibus_config_watch">
3851
<doc xml:whitespace="preserve">Subscribe to the configuration option change notification.
3852
<doc xml:space="preserve">Subscribe to the configuration option change notification.
3853
3854
Until this function is called, every change will be notified to the
3854
3855
client through #IBusConfig::value-changed signal. Clients should
4705
4706
glib:type-name="IBusEngine"
4706
4707
glib:get-type="ibus_engine_get_type"
4707
4708
glib:type-struct="EngineClass">
4708
<doc xml:whitespace="preserve">An IBusEngine provides infrastructure for input method engine.
4709
<doc xml:space="preserve">An IBusEngine provides infrastructure for input method engine.
4709
4710
Developers can "extend" this class for input method engine development.
4711
4712
see_also: #IBusComponent, #IBusEngineDesc</doc>
4712
4713
<constructor name="new" c:identifier="ibus_engine_new">
4713
<doc xml:whitespace="preserve">New an IBusEngine.</doc>
4714
<doc xml:space="preserve">New an IBusEngine.</doc>
4714
4715
<return-value transfer-ownership="none">
4715
<doc xml:whitespace="preserve">A newly allocated IBusEngine.</doc>
4716
<doc xml:space="preserve">A newly allocated IBusEngine.</doc>
4716
4717
<type name="Engine" c:type="IBusEngine*"/>
4717
4718
</return-value>
4719
4720
<parameter name="engine_name" transfer-ownership="none">
4720
<doc xml:whitespace="preserve">Name of the IBusObject.</doc>
4721
<doc xml:space="preserve">Name of the IBusObject.</doc>
4721
4722
<type name="utf8" c:type="const gchar*"/>
4723
4724
<parameter name="object_path" transfer-ownership="none">
4724
<doc xml:whitespace="preserve">Path for IBusService.</doc>
4725
<doc xml:space="preserve">Path for IBusService.</doc>
4725
4726
<type name="utf8" c:type="const gchar*"/>
4727
4728
<parameter name="connection" transfer-ownership="none">
4728
<doc xml:whitespace="preserve">An opened GDBusConnection.</doc>
4729
<doc xml:space="preserve">An opened GDBusConnection.</doc>
4729
4730
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
4733
4734
<constructor name="new_with_type"
4734
4735
c:identifier="ibus_engine_new_with_type">
4735
<doc xml:whitespace="preserve">New an IBusEngine.</doc>
4736
<doc xml:space="preserve">New an IBusEngine.</doc>
4736
4737
<return-value transfer-ownership="none">
4737
<doc xml:whitespace="preserve">A newly allocated IBusEngine.</doc>
4738
<doc xml:space="preserve">A newly allocated IBusEngine.</doc>
4738
4739
<type name="Engine" c:type="IBusEngine*"/>
4739
4740
</return-value>
4741
4742
<parameter name="engine_type" transfer-ownership="none">
4742
<doc xml:whitespace="preserve">GType of #IBusEngine.</doc>
4743
<doc xml:space="preserve">GType of #IBusEngine.</doc>
4743
4744
<type name="GType" c:type="GType"/>
4745
4746
<parameter name="engine_name" transfer-ownership="none">
4746
<doc xml:whitespace="preserve">Name of the IBusObject.</doc>
4747
<doc xml:space="preserve">Name of the IBusObject.</doc>
4747
4748
<type name="utf8" c:type="const gchar*"/>
4749
4750
<parameter name="object_path" transfer-ownership="none">
4750
<doc xml:whitespace="preserve">Path for IBusService.</doc>
4751
<doc xml:space="preserve">Path for IBusService.</doc>
4751
4752
<type name="utf8" c:type="const gchar*"/>
4753
4754
<parameter name="connection" transfer-ownership="none">
4754
<doc xml:whitespace="preserve">An opened GDBusConnection.</doc>
4755
<doc xml:space="preserve">An opened GDBusConnection.</doc>
4755
4756
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
5036
5037
</return-value>
5038
5039
<instance-parameter name="engine" transfer-ownership="none">
5039
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5040
<doc xml:space="preserve">An IBusEngine.</doc>
5040
5041
<type name="Engine" c:type="IBusEngine*"/>
5041
5042
</instance-parameter>
5042
5043
<parameter name="text" transfer-ownership="none">
5043
<doc xml:whitespace="preserve">String commit to IBusEngine.</doc>
5044
<doc xml:space="preserve">String commit to IBusEngine.</doc>
5044
5045
<type name="Text" c:type="IBusText*"/>
5048
5049
<method name="delete_surrounding_text"
5049
5050
c:identifier="ibus_engine_delete_surrounding_text">
5050
<doc xml:whitespace="preserve">Delete surrounding text.</doc>
5051
<doc xml:space="preserve">Delete surrounding text.</doc>
5051
5052
<return-value transfer-ownership="none">
5052
5053
<type name="none" c:type="void"/>
5053
5054
</return-value>
5055
5056
<instance-parameter name="engine" transfer-ownership="none">
5056
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5057
<doc xml:space="preserve">An IBusEngine.</doc>
5057
5058
<type name="Engine" c:type="IBusEngine*"/>
5058
5059
</instance-parameter>
5059
5060
<parameter name="offset" transfer-ownership="none">
5060
<doc xml:whitespace="preserve">The offset of the first char.</doc>
5061
<doc xml:space="preserve">The offset of the first char.</doc>
5061
5062
<type name="gint" c:type="gint"/>
5063
5064
<parameter name="nchars" transfer-ownership="none">
5064
<doc xml:whitespace="preserve">Number of chars to be deleted.</doc>
5065
<doc xml:space="preserve">Number of chars to be deleted.</doc>
5065
5066
<type name="guint" c:type="guint"/>
5069
5070
<method name="forward_key_event"
5070
5071
c:identifier="ibus_engine_forward_key_event">
5071
<doc xml:whitespace="preserve">Forward the key event.</doc>
5072
<doc xml:space="preserve">Forward the key event.</doc>
5072
5073
<return-value transfer-ownership="none">
5073
5074
<type name="none" c:type="void"/>
5074
5075
</return-value>
5076
5077
<instance-parameter name="engine" transfer-ownership="none">
5077
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5078
<doc xml:space="preserve">An IBusEngine.</doc>
5078
5079
<type name="Engine" c:type="IBusEngine*"/>
5079
5080
</instance-parameter>
5080
5081
<parameter name="keyval" transfer-ownership="none">
5081
<doc xml:whitespace="preserve">KeySym.</doc>
5082
<doc xml:space="preserve">KeySym.</doc>
5082
5083
<type name="guint" c:type="guint"/>
5084
5085
<parameter name="keycode" transfer-ownership="none">
5085
<doc xml:whitespace="preserve">keyboard scancode.</doc>
5086
<doc xml:space="preserve">keyboard scancode.</doc>
5086
5087
<type name="guint" c:type="guint"/>
5088
5089
<parameter name="state" transfer-ownership="none">
5089
<doc xml:whitespace="preserve">Key modifier flags.</doc>
5090
<doc xml:space="preserve">Key modifier flags.</doc>
5090
5091
<type name="guint" c:type="guint"/>
5094
5095
<method name="get_content_type"
5095
5096
c:identifier="ibus_engine_get_content_type">
5096
<doc xml:whitespace="preserve">Get content-type (primary purpose and hints) of the current input
5097
<doc xml:space="preserve">Get content-type (primary purpose and hints) of the current input
5099
5100
See also: #IBusEngine::set-content-type</doc>
5231
5232
</return-value>
5233
5234
<instance-parameter name="engine" transfer-ownership="none">
5234
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5235
<doc xml:space="preserve">An IBusEngine.</doc>
5235
5236
<type name="Engine" c:type="IBusEngine*"/>
5236
5237
</instance-parameter>
5237
5238
<parameter name="prop_list" transfer-ownership="none">
5238
<doc xml:whitespace="preserve">Property List.</doc>
5239
<doc xml:space="preserve">Property List.</doc>
5239
5240
<type name="PropList" c:type="IBusPropList*"/>
5243
5244
<method name="show_auxiliary_text"
5244
5245
c:identifier="ibus_engine_show_auxiliary_text">
5245
<doc xml:whitespace="preserve">Show the auxiliary bar.</doc>
5246
<doc xml:space="preserve">Show the auxiliary bar.</doc>
5246
5247
<return-value transfer-ownership="none">
5247
5248
<type name="none" c:type="void"/>
5248
5249
</return-value>
5250
5251
<instance-parameter name="engine" transfer-ownership="none">
5251
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5252
<doc xml:space="preserve">An IBusEngine.</doc>
5252
5253
<type name="Engine" c:type="IBusEngine*"/>
5253
5254
</instance-parameter>
5256
5257
<method name="show_lookup_table"
5257
5258
c:identifier="ibus_engine_show_lookup_table">
5258
<doc xml:whitespace="preserve">Show the lookup table.</doc>
5259
<doc xml:space="preserve">Show the lookup table.</doc>
5259
5260
<return-value transfer-ownership="none">
5260
5261
<type name="none" c:type="void"/>
5261
5262
</return-value>
5263
5264
<instance-parameter name="engine" transfer-ownership="none">
5264
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5265
<doc xml:space="preserve">An IBusEngine.</doc>
5265
5266
<type name="Engine" c:type="IBusEngine*"/>
5266
5267
</instance-parameter>
5269
5270
<method name="show_preedit_text"
5270
5271
c:identifier="ibus_engine_show_preedit_text">
5271
<doc xml:whitespace="preserve">Show the pre-edit buffer.</doc>
5272
<doc xml:space="preserve">Show the pre-edit buffer.</doc>
5272
5273
<return-value transfer-ownership="none">
5273
5274
<type name="none" c:type="void"/>
5274
5275
</return-value>
5276
5277
<instance-parameter name="engine" transfer-ownership="none">
5277
<doc xml:whitespace="preserve">An IBusEngine.</doc>
5278
<doc xml:space="preserve">An IBusEngine.</doc>
5278
5279
<type name="Engine" c:type="IBusEngine*"/>
5279
5280
</instance-parameter>
5282
5283
<method name="update_auxiliary_text"
5283
5284
c:identifier="ibus_engine_update_auxiliary_text">
5284
<doc xml:whitespace="preserve">Update the auxiliary bar.
5285
<doc xml:space="preserve">Update the auxiliary bar.
5286
5287
(Note: The text object will be released, if it is floating.
5287
5288
If caller want to keep the object, caller should make the object
5595
5596
</return-value>
5597
5598
<parameter name="coordinates" transfer-ownership="none">
5598
<doc xml:whitespace="preserve">An array of double (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).</doc>
5599
<doc xml:space="preserve">An array of double (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).</doc>
5599
5600
<type name="gpointer" c:type="gpointer"/>
5601
5602
<parameter name="coordinates_len" transfer-ownership="none">
5602
<doc xml:whitespace="preserve">The number of elements in the array.</doc>
5603
<doc xml:space="preserve">The number of elements in the array.</doc>
5603
5604
<type name="guint" c:type="guint"/>
5607
5608
<glib:signal name="process-key-event" when="last">
5608
<doc xml:whitespace="preserve">Emitted when a key event is received.
5609
<doc xml:space="preserve">Emitted when a key event is received.
5609
5610
Implement the member function process_key_event() in extended class to receive this signal.
5610
5611
Both the key symbol and keycode are passed to the member function.
5611
5612
See ibus_input_context_process_key_event() for further explanation of
5612
5613
key symbol, keycode and which to use.</doc>
5613
5614
<return-value transfer-ownership="none">
5614
<doc xml:whitespace="preserve">TRUE for successfully process the key; FALSE otherwise. See also: ibus_input_context_process_key_event(). <note><para>Argument @user_data is ignored in this function.</para></note></doc>
5615
<doc xml:space="preserve">TRUE for successfully process the key; FALSE otherwise. See also: ibus_input_context_process_key_event(). <note><para>Argument @user_data is ignored in this function.</para></note></doc>
5615
5616
<type name="gboolean" c:type="gboolean"/>
5616
5617
</return-value>
5618
5619
<parameter name="keyval" transfer-ownership="none">
5619
<doc xml:whitespace="preserve">Key symbol of the key press.</doc>
5620
<doc xml:space="preserve">Key symbol of the key press.</doc>
5620
5621
<type name="guint" c:type="guint"/>
5622
5623
<parameter name="keycode" transfer-ownership="none">
5623
<doc xml:whitespace="preserve">KeyCode of the key press.</doc>
5624
<doc xml:space="preserve">KeyCode of the key press.</doc>
5624
5625
<type name="guint" c:type="guint"/>
5626
5627
<parameter name="state" transfer-ownership="none">
5627
<doc xml:whitespace="preserve">Key modifier flags.</doc>
5628
<doc xml:space="preserve">Key modifier flags.</doc>
5628
5629
<type name="guint" c:type="guint"/>
5632
5633
<glib:signal name="property-activate" when="last">
5633
<doc xml:whitespace="preserve">Emitted when a property is activated or change changed.
5634
<doc xml:space="preserve">Emitted when a property is activated or change changed.
5634
5635
Implement the member function property_activate() in extended class to receive this signal.
5636
5637
<note><para>Argument @user_data is ignored in this function.</para></note></doc>
6114
6115
glib:type-name="IBusEngineDesc"
6115
6116
glib:get-type="ibus_engine_desc_get_type"
6116
6117
glib:type-struct="EngineDescClass">
6117
<doc xml:whitespace="preserve">An IBusEngineDesc stores description data of IBusEngine.
6118
<doc xml:space="preserve">An IBusEngineDesc stores description data of IBusEngine.
6118
6119
The description data can either be passed to ibus_engine_desc_new(),
6119
6120
or loaded from an XML node through ibus_engine_desc_new_from_xml_node()
6120
6121
to construct IBusEngineDesc.
6122
6123
However, the recommended way to load engine description data is
6123
6124
using ibus_component_new_from_file() to load a component file,
6124
which also includes engine description data.</doc>
6125
which also includes engine description data.
6127
see_also: #IBusComponent, #IBusEngine</doc>
6125
6128
<constructor name="new" c:identifier="ibus_engine_desc_new">
6126
<doc xml:whitespace="preserve">New a IBusEngineDesc.</doc>
6129
<doc xml:space="preserve">New a IBusEngineDesc.</doc>
6127
6130
<return-value transfer-ownership="none">
6128
<doc xml:whitespace="preserve">A newly allocated IBusEngineDesc.</doc>
6131
<doc xml:space="preserve">A newly allocated IBusEngineDesc.</doc>
6129
6132
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6130
6133
</return-value>
6132
6135
<parameter name="name" transfer-ownership="none">
6133
<doc xml:whitespace="preserve">Name of the engine.</doc>
6136
<doc xml:space="preserve">Name of the engine.</doc>
6134
6137
<type name="utf8" c:type="const gchar*"/>
6136
6139
<parameter name="longname" transfer-ownership="none">
6137
<doc xml:whitespace="preserve">Long name of the input method engine.</doc>
6140
<doc xml:space="preserve">Long name of the input method engine.</doc>
6138
6141
<type name="utf8" c:type="const gchar*"/>
6140
6143
<parameter name="description" transfer-ownership="none">
6141
<doc xml:whitespace="preserve">Input method engine description.</doc>
6144
<doc xml:space="preserve">Input method engine description.</doc>
6142
6145
<type name="utf8" c:type="const gchar*"/>
6144
6147
<parameter name="language" transfer-ownership="none">
6145
<doc xml:whitespace="preserve">Language (e.g. zh, jp) supported by this input method engine.</doc>
6148
<doc xml:space="preserve">Language (e.g. zh, jp) supported by this input method engine.</doc>
6146
6149
<type name="utf8" c:type="const gchar*"/>
6148
6151
<parameter name="license" transfer-ownership="none">
6149
<doc xml:whitespace="preserve">License of the input method engine.</doc>
6152
<doc xml:space="preserve">License of the input method engine.</doc>
6150
6153
<type name="utf8" c:type="const gchar*"/>
6152
6155
<parameter name="author" transfer-ownership="none">
6153
<doc xml:whitespace="preserve">Author of the input method engine.</doc>
6156
<doc xml:space="preserve">Author of the input method engine.</doc>
6154
6157
<type name="utf8" c:type="const gchar*"/>
6156
6159
<parameter name="icon" transfer-ownership="none">
6157
<doc xml:whitespace="preserve">Icon file of this engine.</doc>
6160
<doc xml:space="preserve">Icon file of this engine.</doc>
6158
6161
<type name="utf8" c:type="const gchar*"/>
6160
6163
<parameter name="layout" transfer-ownership="none">
6161
<doc xml:whitespace="preserve">Keyboard layout</doc>
6164
<doc xml:space="preserve">Keyboard layout</doc>
6162
6165
<type name="utf8" c:type="const gchar*"/>
6205
6208
<method name="get_author" c:identifier="ibus_engine_desc_get_author">
6206
<doc xml:whitespace="preserve">Return the author property in IBusEngineDesc. It should not be freed.</doc>
6209
<doc xml:space="preserve">Return the author property in IBusEngineDesc. It should not be freed.</doc>
6207
6210
<return-value transfer-ownership="none">
6208
<doc xml:whitespace="preserve">author property in IBusEngineDesc</doc>
6211
<doc xml:space="preserve">author property in IBusEngineDesc</doc>
6209
6212
<type name="utf8" c:type="const gchar*"/>
6210
6213
</return-value>
6212
6215
<instance-parameter name="info" transfer-ownership="none">
6213
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6216
<doc xml:space="preserve">An IBusEngineDesc</doc>
6214
6217
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6215
6218
</instance-parameter>
6218
6221
<method name="get_description"
6219
6222
c:identifier="ibus_engine_desc_get_description">
6220
<doc xml:whitespace="preserve">Return the description property in IBusEngineDesc. It should not be freed.</doc>
6223
<doc xml:space="preserve">Return the description property in IBusEngineDesc. It should not be freed.</doc>
6221
6224
<return-value transfer-ownership="none">
6222
<doc xml:whitespace="preserve">description property in IBusEngineDesc</doc>
6225
<doc xml:space="preserve">description property in IBusEngineDesc</doc>
6223
6226
<type name="utf8" c:type="const gchar*"/>
6224
6227
</return-value>
6226
6229
<instance-parameter name="info" transfer-ownership="none">
6227
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6230
<doc xml:space="preserve">An IBusEngineDesc</doc>
6228
6231
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6229
6232
</instance-parameter>
6232
6235
<method name="get_hotkeys" c:identifier="ibus_engine_desc_get_hotkeys">
6233
<doc xml:whitespace="preserve">Return the hotkeys property in IBusEngineDesc. It should not be freed.</doc>
6236
<doc xml:space="preserve">Return the hotkeys property in IBusEngineDesc. It should not be freed.</doc>
6234
6237
<return-value transfer-ownership="none">
6235
<doc xml:whitespace="preserve">hotkeys property in IBusEngineDesc</doc>
6238
<doc xml:space="preserve">hotkeys property in IBusEngineDesc</doc>
6236
6239
<type name="utf8" c:type="const gchar*"/>
6237
6240
</return-value>
6239
6242
<instance-parameter name="info" transfer-ownership="none">
6240
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6243
<doc xml:space="preserve">An IBusEngineDesc</doc>
6241
6244
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6242
6245
</instance-parameter>
6245
6248
<method name="get_icon" c:identifier="ibus_engine_desc_get_icon">
6246
<doc xml:whitespace="preserve">Return the icon property in IBusEngineDesc. It should not be freed.</doc>
6249
<doc xml:space="preserve">Return the icon property in IBusEngineDesc. It should not be freed.</doc>
6247
6250
<return-value transfer-ownership="none">
6248
<doc xml:whitespace="preserve">icon property in IBusEngineDesc</doc>
6251
<doc xml:space="preserve">icon property in IBusEngineDesc</doc>
6249
6252
<type name="utf8" c:type="const gchar*"/>
6250
6253
</return-value>
6252
6255
<instance-parameter name="info" transfer-ownership="none">
6253
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6256
<doc xml:space="preserve">An IBusEngineDesc</doc>
6254
6257
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6255
6258
</instance-parameter>
6258
6261
<method name="get_language" c:identifier="ibus_engine_desc_get_language">
6259
<doc xml:whitespace="preserve">Return the language property in IBusEngineDesc. It should not be freed.</doc>
6262
<doc xml:space="preserve">Return the language property in IBusEngineDesc. It should not be freed.</doc>
6260
6263
<return-value transfer-ownership="none">
6261
<doc xml:whitespace="preserve">language property in IBusEngineDesc</doc>
6264
<doc xml:space="preserve">language property in IBusEngineDesc</doc>
6262
6265
<type name="utf8" c:type="const gchar*"/>
6263
6266
</return-value>
6265
6268
<instance-parameter name="info" transfer-ownership="none">
6266
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6269
<doc xml:space="preserve">An IBusEngineDesc</doc>
6267
6270
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6268
6271
</instance-parameter>
6271
6274
<method name="get_layout" c:identifier="ibus_engine_desc_get_layout">
6272
<doc xml:whitespace="preserve">Return the layout property in IBusEngineDesc. It should not be freed.</doc>
6275
<doc xml:space="preserve">Return the layout property in IBusEngineDesc. It should not be freed.</doc>
6273
6276
<return-value transfer-ownership="none">
6274
<doc xml:whitespace="preserve">layout property in IBusEngineDesc</doc>
6277
<doc xml:space="preserve">layout property in IBusEngineDesc</doc>
6275
6278
<type name="utf8" c:type="const gchar*"/>
6276
6279
</return-value>
6278
6281
<instance-parameter name="info" transfer-ownership="none">
6279
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6282
<doc xml:space="preserve">An IBusEngineDesc</doc>
6280
6283
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6281
6284
</instance-parameter>
6284
6287
<method name="get_layout_option"
6285
6288
c:identifier="ibus_engine_desc_get_layout_option">
6286
<doc xml:whitespace="preserve">Return the keyboard option property in IBusEngineDesc. It should not be freed.</doc>
6289
<doc xml:space="preserve">Return the keyboard option property in IBusEngineDesc. It should not be freed.</doc>
6287
6290
<return-value transfer-ownership="none">
6288
<doc xml:whitespace="preserve">keyboard option property in IBusEngineDesc</doc>
6291
<doc xml:space="preserve">keyboard option property in IBusEngineDesc</doc>
6289
6292
<type name="utf8" c:type="const gchar*"/>
6290
6293
</return-value>
6292
6295
<instance-parameter name="info" transfer-ownership="none">
6293
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6296
<doc xml:space="preserve">An IBusEngineDesc</doc>
6294
6297
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6295
6298
</instance-parameter>
6298
6301
<method name="get_layout_variant"
6299
6302
c:identifier="ibus_engine_desc_get_layout_variant">
6300
<doc xml:whitespace="preserve">Return the keyboard variant property in IBusEngineDesc. It should not be freed.</doc>
6303
<doc xml:space="preserve">Return the keyboard variant property in IBusEngineDesc. It should not be freed.</doc>
6301
6304
<return-value transfer-ownership="none">
6302
<doc xml:whitespace="preserve">keyboard variant property in IBusEngineDesc</doc>
6305
<doc xml:space="preserve">keyboard variant property in IBusEngineDesc</doc>
6303
6306
<type name="utf8" c:type="const gchar*"/>
6304
6307
</return-value>
6306
6309
<instance-parameter name="info" transfer-ownership="none">
6307
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6310
<doc xml:space="preserve">An IBusEngineDesc</doc>
6308
6311
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6309
6312
</instance-parameter>
6312
6315
<method name="get_license" c:identifier="ibus_engine_desc_get_license">
6313
<doc xml:whitespace="preserve">Return the license property in IBusEngineDesc. It should not be freed.</doc>
6316
<doc xml:space="preserve">Return the license property in IBusEngineDesc. It should not be freed.</doc>
6314
6317
<return-value transfer-ownership="none">
6315
<doc xml:whitespace="preserve">license property in IBusEngineDesc</doc>
6318
<doc xml:space="preserve">license property in IBusEngineDesc</doc>
6316
6319
<type name="utf8" c:type="const gchar*"/>
6317
6320
</return-value>
6319
6322
<instance-parameter name="info" transfer-ownership="none">
6320
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6323
<doc xml:space="preserve">An IBusEngineDesc</doc>
6321
6324
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6322
6325
</instance-parameter>
6325
6328
<method name="get_longname" c:identifier="ibus_engine_desc_get_longname">
6326
<doc xml:whitespace="preserve">Return the longname property in IBusEngineDesc. It should not be freed.</doc>
6329
<doc xml:space="preserve">Return the longname property in IBusEngineDesc. It should not be freed.</doc>
6327
6330
<return-value transfer-ownership="none">
6328
<doc xml:whitespace="preserve">longname property in IBusEngineDesc</doc>
6331
<doc xml:space="preserve">longname property in IBusEngineDesc</doc>
6329
6332
<type name="utf8" c:type="const gchar*"/>
6330
6333
</return-value>
6332
6335
<instance-parameter name="info" transfer-ownership="none">
6333
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6336
<doc xml:space="preserve">An IBusEngineDesc</doc>
6334
6337
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6335
6338
</instance-parameter>
6338
6341
<method name="get_name" c:identifier="ibus_engine_desc_get_name">
6339
<doc xml:whitespace="preserve">Return the name property in IBusEngineDesc. It should not be freed.</doc>
6342
<doc xml:space="preserve">Return the name property in IBusEngineDesc. It should not be freed.</doc>
6340
6343
<return-value transfer-ownership="none">
6341
<doc xml:whitespace="preserve">name property in IBusEngineDesc</doc>
6344
<doc xml:space="preserve">name property in IBusEngineDesc</doc>
6342
6345
<type name="utf8" c:type="const gchar*"/>
6343
6346
</return-value>
6345
6348
<instance-parameter name="info" transfer-ownership="none">
6346
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6349
<doc xml:space="preserve">An IBusEngineDesc</doc>
6347
6350
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6348
6351
</instance-parameter>
6351
6354
<method name="get_rank" c:identifier="ibus_engine_desc_get_rank">
6352
<doc xml:whitespace="preserve">Return the rank property in IBusEngineDesc.</doc>
6355
<doc xml:space="preserve">Return the rank property in IBusEngineDesc.</doc>
6353
6356
<return-value transfer-ownership="none">
6354
<doc xml:whitespace="preserve">rank property in IBusEngineDesc</doc>
6357
<doc xml:space="preserve">rank property in IBusEngineDesc</doc>
6355
6358
<type name="guint" c:type="guint"/>
6356
6359
</return-value>
6358
6361
<instance-parameter name="info" transfer-ownership="none">
6359
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6362
<doc xml:space="preserve">An IBusEngineDesc</doc>
6360
6363
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6361
6364
</instance-parameter>
6364
6367
<method name="get_setup" c:identifier="ibus_engine_desc_get_setup">
6365
<doc xml:whitespace="preserve">Return the setup property in IBusEngineDesc. It should not be freed.</doc>
6368
<doc xml:space="preserve">Return the setup property in IBusEngineDesc. It should not be freed.</doc>
6366
6369
<return-value transfer-ownership="none">
6367
<doc xml:whitespace="preserve">setup property in IBusEngineDesc</doc>
6370
<doc xml:space="preserve">setup property in IBusEngineDesc</doc>
6368
6371
<type name="utf8" c:type="const gchar*"/>
6369
6372
</return-value>
6371
6374
<instance-parameter name="info" transfer-ownership="none">
6372
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6375
<doc xml:space="preserve">An IBusEngineDesc</doc>
6373
6376
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6374
6377
</instance-parameter>
6377
6380
<method name="get_symbol" c:identifier="ibus_engine_desc_get_symbol">
6378
<doc xml:whitespace="preserve">Return the symbol property in IBusEngineDesc. It should not be freed.</doc>
6381
<doc xml:space="preserve">Return the symbol property in IBusEngineDesc. It should not be freed.</doc>
6379
6382
<return-value transfer-ownership="none">
6380
<doc xml:whitespace="preserve">symbol property in IBusEngineDesc</doc>
6383
<doc xml:space="preserve">symbol property in IBusEngineDesc</doc>
6381
6384
<type name="utf8" c:type="const gchar*"/>
6382
6385
</return-value>
6384
6387
<instance-parameter name="info" transfer-ownership="none">
6385
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6388
<doc xml:space="preserve">An IBusEngineDesc</doc>
6386
6389
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6387
6390
</instance-parameter>
6390
6393
<method name="get_textdomain"
6391
6394
c:identifier="ibus_engine_desc_get_textdomain">
6392
<doc xml:whitespace="preserve">Return the textdomain property in IBusEngineDesc. It should not be freed.</doc>
6395
<doc xml:space="preserve">Return the textdomain property in IBusEngineDesc. It should not be freed.</doc>
6393
6396
<return-value transfer-ownership="none">
6394
<doc xml:whitespace="preserve">textdomain in IBusEngineDesc</doc>
6397
<doc xml:space="preserve">textdomain in IBusEngineDesc</doc>
6395
6398
<type name="utf8" c:type="const gchar*"/>
6396
6399
</return-value>
6398
6401
<instance-parameter name="info" transfer-ownership="none">
6399
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6402
<doc xml:space="preserve">An IBusEngineDesc</doc>
6400
6403
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6401
6404
</instance-parameter>
6404
6407
<method name="get_version" c:identifier="ibus_engine_desc_get_version">
6405
<doc xml:whitespace="preserve">Return the version property in IBusEngineDesc. It should not be freed.</doc>
6408
<doc xml:space="preserve">Return the version property in IBusEngineDesc. It should not be freed.</doc>
6406
6409
<return-value transfer-ownership="none">
6407
<doc xml:whitespace="preserve">version in IBusEngineDesc</doc>
6410
<doc xml:space="preserve">version in IBusEngineDesc</doc>
6408
6411
<type name="utf8" c:type="const gchar*"/>
6409
6412
</return-value>
6411
6414
<instance-parameter name="info" transfer-ownership="none">
6412
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6415
<doc xml:space="preserve">An IBusEngineDesc</doc>
6413
6416
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6414
6417
</instance-parameter>
6417
6420
<method name="output" c:identifier="ibus_engine_desc_output">
6418
<doc xml:whitespace="preserve">Output XML-formatted input method engine description.
6421
<doc xml:space="preserve">Output XML-formatted input method engine description.
6419
6422
The result will be append to GString specified in @output.</doc>
6420
6423
<return-value transfer-ownership="none">
6421
6424
<type name="none" c:type="void"/>
6422
6425
</return-value>
6424
6427
<instance-parameter name="info" transfer-ownership="none">
6425
<doc xml:whitespace="preserve">An IBusEngineDesc</doc>
6428
<doc xml:space="preserve">An IBusEngineDesc</doc>
6426
6429
<type name="EngineDesc" c:type="IBusEngineDesc*"/>
6427
6430
</instance-parameter>
6428
6431
<parameter name="output" transfer-ownership="none">
6429
<doc xml:whitespace="preserve">XML-formatted Input method engine description.</doc>
6432
<doc xml:space="preserve">XML-formatted Input method engine description.</doc>
6430
6433
<type name="GLib.String" c:type="GString*"/>
6432
6435
<parameter name="indent" transfer-ownership="none">
6433
<doc xml:whitespace="preserve">Number of indent (showed as 4 spaces).</doc>
6436
<doc xml:space="preserve">Number of indent (showed as 4 spaces).</doc>
6434
6437
<type name="gint" c:type="gint"/>
6440
6443
construct-only="1"
6441
6444
transfer-ownership="none">
6442
<doc xml:whitespace="preserve">The author of engine description</doc>
6445
<doc xml:space="preserve">The author of engine description</doc>
6443
6446
<type name="utf8" c:type="gchar*"/>
6445
6448
<property name="description"
6447
6450
construct-only="1"
6448
6451
transfer-ownership="none">
6449
<doc xml:whitespace="preserve">The description of engine description</doc>
6452
<doc xml:space="preserve">The description of engine description</doc>
6450
6453
<type name="utf8" c:type="gchar*"/>
6452
6455
<property name="hotkeys"
6454
6457
construct-only="1"
6455
6458
transfer-ownership="none">
6456
<doc xml:whitespace="preserve">The hotkeys of engine description</doc>
6459
<doc xml:space="preserve">The hotkeys of engine description</doc>
6457
6460
<type name="utf8" c:type="gchar*"/>
6459
6462
<property name="icon"
6461
6464
construct-only="1"
6462
6465
transfer-ownership="none">
6463
<doc xml:whitespace="preserve">The icon of engine description</doc>
6466
<doc xml:space="preserve">The icon of engine description</doc>
6464
6467
<type name="utf8" c:type="gchar*"/>
6466
6469
<property name="language"
6468
6471
construct-only="1"
6469
6472
transfer-ownership="none">
6470
<doc xml:whitespace="preserve">The language of engine description</doc>
6473
<doc xml:space="preserve">The language of engine description</doc>
6471
6474
<type name="utf8" c:type="gchar*"/>
6473
6476
<property name="layout"
6475
6478
construct-only="1"
6476
6479
transfer-ownership="none">
6477
<doc xml:whitespace="preserve">The layout of engine description</doc>
6480
<doc xml:space="preserve">The layout of engine description</doc>
6478
6481
<type name="utf8" c:type="gchar*"/>
6480
6483
<property name="layout-option"
6482
6485
construct-only="1"
6483
6486
transfer-ownership="none">
6484
<doc xml:whitespace="preserve">The keyboard option of engine description</doc>
6487
<doc xml:space="preserve">The keyboard option of engine description</doc>
6485
6488
<type name="utf8" c:type="gchar*"/>
6487
6490
<property name="layout-variant"
6489
6492
construct-only="1"
6490
6493
transfer-ownership="none">
6491
<doc xml:whitespace="preserve">The keyboard variant of engine description</doc>
6494
<doc xml:space="preserve">The keyboard variant of engine description</doc>
6492
6495
<type name="utf8" c:type="gchar*"/>
6494
6497
<property name="license"
6496
6499
construct-only="1"
6497
6500
transfer-ownership="none">
6498
<doc xml:whitespace="preserve">The license of engine description</doc>
6501
<doc xml:space="preserve">The license of engine description</doc>
6499
6502
<type name="utf8" c:type="gchar*"/>
6501
6504
<property name="longname"
6503
6506
construct-only="1"
6504
6507
transfer-ownership="none">
6505
<doc xml:whitespace="preserve">The longname of engine description</doc>
6508
<doc xml:space="preserve">The longname of engine description</doc>
6506
6509
<type name="utf8" c:type="gchar*"/>
6508
6511
<property name="name"
6510
6513
construct-only="1"
6511
6514
transfer-ownership="none">
6512
<doc xml:whitespace="preserve">The name of engine description</doc>
6515
<doc xml:space="preserve">The name of engine description</doc>
6513
6516
<type name="utf8" c:type="gchar*"/>
6515
6518
<property name="rank"
6517
6520
construct-only="1"
6518
6521
transfer-ownership="none">
6519
<doc xml:whitespace="preserve">The rank of engine description</doc>
6522
<doc xml:space="preserve">The rank of engine description</doc>
6520
6523
<type name="guint" c:type="guint"/>
6522
6525
<property name="setup"
6524
6527
construct-only="1"
6525
6528
transfer-ownership="none">
6526
<doc xml:whitespace="preserve">The exec lists of the engine setup command</doc>
6529
<doc xml:space="preserve">The exec lists of the engine setup command</doc>
6527
6530
<type name="utf8" c:type="gchar*"/>
6529
6532
<property name="symbol"
6531
6534
construct-only="1"
6532
6535
transfer-ownership="none">
6533
<doc xml:whitespace="preserve">The symbol chars of engine description instead of icon image</doc>
6536
<doc xml:space="preserve">The symbol chars of engine description instead of icon image</doc>
6534
6537
<type name="utf8" c:type="gchar*"/>
6536
6539
<property name="textdomain"
6538
6541
construct-only="1"
6539
6542
transfer-ownership="none">
6540
<doc xml:whitespace="preserve">The textdomain of engine description</doc>
6543
<doc xml:space="preserve">The textdomain of engine description</doc>
6541
6544
<type name="utf8" c:type="gchar*"/>
6543
6546
<property name="version"
6545
6548
construct-only="1"
6546
6549
transfer-ownership="none">
6547
<doc xml:whitespace="preserve">The version number of engine description</doc>
6550
<doc xml:space="preserve">The version number of engine description</doc>
6548
6551
<type name="utf8" c:type="gchar*"/>
6550
6553
<field name="parent">
7879
7902
</virtual-method>
7880
7903
<method name="add_hotkey" c:identifier="ibus_hotkey_profile_add_hotkey">
7881
<doc xml:whitespace="preserve">Add a hotkey and its associated event to an IBusHotkeyProfile.</doc>
7904
<doc xml:space="preserve">Add a hotkey and its associated event to an IBusHotkeyProfile.</doc>
7882
7905
<return-value transfer-ownership="none">
7883
<doc xml:whitespace="preserve">Always TRUE.</doc>
7906
<doc xml:space="preserve">Always TRUE.</doc>
7884
7907
<type name="gboolean" c:type="gboolean"/>
7885
7908
</return-value>
7887
7910
<instance-parameter name="profile" transfer-ownership="none">
7888
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
7911
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
7889
7912
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
7890
7913
</instance-parameter>
7891
7914
<parameter name="keyval" transfer-ownership="none">
7892
<doc xml:whitespace="preserve">Keycode of the hotkey.</doc>
7915
<doc xml:space="preserve">Keycode of the hotkey.</doc>
7893
7916
<type name="guint" c:type="guint"/>
7895
7918
<parameter name="modifiers" transfer-ownership="none">
7896
<doc xml:whitespace="preserve">Modifiers of the hotkey.</doc>
7919
<doc xml:space="preserve">Modifiers of the hotkey.</doc>
7897
7920
<type name="guint" c:type="guint"/>
7899
7922
<parameter name="event" transfer-ownership="none">
7900
<doc xml:whitespace="preserve">The event to be associated.</doc>
7923
<doc xml:space="preserve">The event to be associated.</doc>
7901
7924
<type name="GLib.Quark" c:type="GQuark"/>
7905
7928
<method name="add_hotkey_from_string"
7906
7929
c:identifier="ibus_hotkey_profile_add_hotkey_from_string">
7907
<doc xml:whitespace="preserve">Add a hotkey and its associated event to an IBusHotkeyProfile.
7930
<doc xml:space="preserve">Add a hotkey and its associated event to an IBusHotkeyProfile.
7908
7931
The hotkey is in string format, such like <constant>Control+Shift+A</constant>.</doc>
7909
7932
<return-value transfer-ownership="none">
7910
<doc xml:whitespace="preserve">FALSE if @str contains invalid symbol; TRUE otherwise.</doc>
7933
<doc xml:space="preserve">FALSE if @str contains invalid symbol; TRUE otherwise.</doc>
7911
7934
<type name="gboolean" c:type="gboolean"/>
7912
7935
</return-value>
7914
7937
<instance-parameter name="profile" transfer-ownership="none">
7915
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
7938
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
7916
7939
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
7917
7940
</instance-parameter>
7918
7941
<parameter name="str" transfer-ownership="none">
7919
<doc xml:whitespace="preserve">Key in string representation. '+' is the separator.</doc>
7942
<doc xml:space="preserve">Key in string representation. '+' is the separator.</doc>
7920
7943
<type name="utf8" c:type="const gchar*"/>
7922
7945
<parameter name="event" transfer-ownership="none">
7923
<doc xml:whitespace="preserve">The event to be associated.</doc>
7946
<doc xml:space="preserve">The event to be associated.</doc>
7924
7947
<type name="GLib.Quark" c:type="GQuark"/>
7928
7951
<method name="filter_key_event"
7929
7952
c:identifier="ibus_hotkey_profile_filter_key_event">
7930
<doc xml:whitespace="preserve">Emit a <constant>::trigger</constant> signal when a hotkey is in a profile.
7953
<doc xml:space="preserve">Emit a <constant>::trigger</constant> signal when a hotkey is in a profile.
7932
7955
See also: ::trigger</doc>
7933
7956
<return-value transfer-ownership="none">
7934
<doc xml:whitespace="preserve">0 if releasing a hotkey and the hotkey is not in the profile ; an associated event otherwise.</doc>
7957
<doc xml:space="preserve">0 if releasing a hotkey and the hotkey is not in the profile ; an associated event otherwise.</doc>
7935
7958
<type name="GLib.Quark" c:type="GQuark"/>
7936
7959
</return-value>
7938
7961
<instance-parameter name="profile" transfer-ownership="none">
7939
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
7962
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
7940
7963
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
7941
7964
</instance-parameter>
7942
7965
<parameter name="keyval" transfer-ownership="none">
7943
<doc xml:whitespace="preserve">Keycode of the hotkey.</doc>
7966
<doc xml:space="preserve">Keycode of the hotkey.</doc>
7944
7967
<type name="guint" c:type="guint"/>
7946
7969
<parameter name="modifiers" transfer-ownership="none">
7947
<doc xml:whitespace="preserve">Modifiers of the hotkey.</doc>
7970
<doc xml:space="preserve">Modifiers of the hotkey.</doc>
7948
7971
<type name="guint" c:type="guint"/>
7950
7973
<parameter name="prev_keyval" transfer-ownership="none">
7951
<doc xml:whitespace="preserve">Keycode of the hotkey.</doc>
7974
<doc xml:space="preserve">Keycode of the hotkey.</doc>
7952
7975
<type name="guint" c:type="guint"/>
7954
7977
<parameter name="prev_modifiers" transfer-ownership="none">
7955
<doc xml:whitespace="preserve">Modifiers of the hotkey.</doc>
7978
<doc xml:space="preserve">Modifiers of the hotkey.</doc>
7956
7979
<type name="guint" c:type="guint"/>
7958
7981
<parameter name="user_data" transfer-ownership="none">
7959
<doc xml:whitespace="preserve">user data for signal "trigger".</doc>
7982
<doc xml:space="preserve">user data for signal "trigger".</doc>
7960
7983
<type name="gpointer" c:type="gpointer"/>
7964
7987
<method name="lookup_hotkey"
7965
7988
c:identifier="ibus_hotkey_profile_lookup_hotkey">
7966
7989
<return-value transfer-ownership="none">
7967
<doc xml:whitespace="preserve">The event associated to the hotkey or 0 if the hotkey is not in the profile.</doc>
7990
<doc xml:space="preserve">The event associated to the hotkey or 0 if the hotkey is not in the profile.</doc>
7968
7991
<type name="GLib.Quark" c:type="GQuark"/>
7969
7992
</return-value>
7971
7994
<instance-parameter name="profile" transfer-ownership="none">
7972
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
7995
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
7973
7996
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
7974
7997
</instance-parameter>
7975
7998
<parameter name="keyval" transfer-ownership="none">
7976
<doc xml:whitespace="preserve">Keycode of the hotkey.</doc>
7999
<doc xml:space="preserve">Keycode of the hotkey.</doc>
7977
8000
<type name="guint" c:type="guint"/>
7979
8002
<parameter name="modifiers" transfer-ownership="none">
7980
<doc xml:whitespace="preserve">Modifiers of the hotkey.</doc>
8003
<doc xml:space="preserve">Modifiers of the hotkey.</doc>
7981
8004
<type name="guint" c:type="guint"/>
7985
8008
<method name="remove_hotkey"
7986
8009
c:identifier="ibus_hotkey_profile_remove_hotkey">
7987
<doc xml:whitespace="preserve">Remove the hotkey for an IBusHotkeyProfile.</doc>
8010
<doc xml:space="preserve">Remove the hotkey for an IBusHotkeyProfile.</doc>
7988
8011
<return-value transfer-ownership="none">
7989
<doc xml:whitespace="preserve">FALSE if the key is not in @profile, TRUE otherwise.</doc>
8012
<doc xml:space="preserve">FALSE if the key is not in @profile, TRUE otherwise.</doc>
7990
8013
<type name="gboolean" c:type="gboolean"/>
7991
8014
</return-value>
7993
8016
<instance-parameter name="profile" transfer-ownership="none">
7994
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
8017
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
7995
8018
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
7996
8019
</instance-parameter>
7997
8020
<parameter name="keyval" transfer-ownership="none">
7998
<doc xml:whitespace="preserve">Keycode of the hotkey.</doc>
8021
<doc xml:space="preserve">Keycode of the hotkey.</doc>
7999
8022
<type name="guint" c:type="guint"/>
8001
8024
<parameter name="modifiers" transfer-ownership="none">
8002
<doc xml:whitespace="preserve">Modifiers of the hotkey.</doc>
8025
<doc xml:space="preserve">Modifiers of the hotkey.</doc>
8003
8026
<type name="guint" c:type="guint"/>
8007
8030
<method name="remove_hotkey_by_event"
8008
8031
c:identifier="ibus_hotkey_profile_remove_hotkey_by_event">
8009
<doc xml:whitespace="preserve">Remove the hotkey for an IBusHotkeyProfile by event.</doc>
8032
<doc xml:space="preserve">Remove the hotkey for an IBusHotkeyProfile by event.</doc>
8010
8033
<return-value transfer-ownership="none">
8011
<doc xml:whitespace="preserve">FALSE if no such event in @profile, TRUE otherwise.</doc>
8034
<doc xml:space="preserve">FALSE if no such event in @profile, TRUE otherwise.</doc>
8012
8035
<type name="gboolean" c:type="gboolean"/>
8013
8036
</return-value>
8015
8038
<instance-parameter name="profile" transfer-ownership="none">
8016
<doc xml:whitespace="preserve">An IBusHotkeyProfile.</doc>
8039
<doc xml:space="preserve">An IBusHotkeyProfile.</doc>
8017
8040
<type name="HotkeyProfile" c:type="IBusHotkeyProfile*"/>
8018
8041
</instance-parameter>
8019
8042
<parameter name="event" transfer-ownership="none">
8020
<doc xml:whitespace="preserve">The associated event.</doc>
8043
<doc xml:space="preserve">The associated event.</doc>
8021
8044
<type name="GLib.Quark" c:type="GQuark"/>
8377
8400
<constructor name="new_async_finish"
8378
8401
c:identifier="ibus_input_context_new_async_finish"
8380
<doc xml:whitespace="preserve">Finishes an operation started with ibus_input_context_new_async().</doc>
8403
<doc xml:space="preserve">Finishes an operation started with ibus_input_context_new_async().</doc>
8381
8404
<return-value transfer-ownership="full">
8382
<doc xml:whitespace="preserve">A newly allocated #IBusInputContext.</doc>
8405
<doc xml:space="preserve">A newly allocated #IBusInputContext.</doc>
8383
8406
<type name="InputContext" c:type="IBusInputContext*"/>
8384
8407
</return-value>
8386
8409
<parameter name="res" transfer-ownership="none">
8387
<doc xml:whitespace="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback pass to ibus_input_context_new_async().</doc>
8410
<doc xml:space="preserve">A #GAsyncResult obtained from the #GAsyncReadyCallback pass to ibus_input_context_new_async().</doc>
8388
8411
<type name="Gio.AsyncResult" c:type="GAsyncResult*"/>
8392
8415
<function name="get_input_context"
8393
8416
c:identifier="ibus_input_context_get_input_context">
8394
<doc xml:whitespace="preserve">Gets an existing IBusInputContext.</doc>
8417
<doc xml:space="preserve">Gets an existing IBusInputContext.</doc>
8395
8418
<return-value transfer-ownership="none">
8396
<doc xml:whitespace="preserve">An existing #IBusInputContext.</doc>
8419
<doc xml:space="preserve">An existing #IBusInputContext.</doc>
8397
8420
<type name="InputContext" c:type="IBusInputContext*"/>
8398
8421
</return-value>
8400
8423
<parameter name="path" transfer-ownership="none">
8401
<doc xml:whitespace="preserve">The path to the object that emitting the signal.</doc>
8424
<doc xml:space="preserve">The path to the object that emitting the signal.</doc>
8402
8425
<type name="utf8" c:type="const gchar*"/>
8404
8427
<parameter name="connection" transfer-ownership="none">
8405
<doc xml:whitespace="preserve">An #GDBusConnection.</doc>
8428
<doc xml:space="preserve">An #GDBusConnection.</doc>
8406
8429
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
8410
8433
<function name="get_input_context_async"
8411
8434
c:identifier="ibus_input_context_get_input_context_async">
8412
<doc xml:whitespace="preserve">Get an existing #IBusInputContext asynchronously.</doc>
8435
<doc xml:space="preserve">Get an existing #IBusInputContext asynchronously.</doc>
8413
8436
<return-value transfer-ownership="none">
8414
8437
<type name="none" c:type="void"/>
8415
8438
</return-value>
8417
8440
<parameter name="path" transfer-ownership="none">
8418
<doc xml:whitespace="preserve">The path to the object that emitting the signal.</doc>
8441
<doc xml:space="preserve">The path to the object that emitting the signal.</doc>
8419
8442
<type name="utf8" c:type="const gchar*"/>
8421
8444
<parameter name="connection" transfer-ownership="none">
8422
<doc xml:whitespace="preserve">An #GDBusConnection.</doc>
8445
<doc xml:space="preserve">An #GDBusConnection.</doc>
8423
8446
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
8425
8448
<parameter name="cancellable"
8426
8449
transfer-ownership="none"
8427
8450
allow-none="1">
8428
<doc xml:whitespace="preserve">A #GCancellable or %NULL.</doc>
8451
<doc xml:space="preserve">A #GCancellable or %NULL.</doc>
8429
8452
<type name="Gio.Cancellable" c:type="GCancellable*"/>
8431
8454
<parameter name="callback"
8638
8661
</return-value>
8640
8663
<instance-parameter name="context" transfer-ownership="none">
8641
<doc xml:whitespace="preserve">An IBusInputContext.</doc>
8664
<doc xml:space="preserve">An IBusInputContext.</doc>
8642
8665
<type name="InputContext" c:type="IBusInputContext*"/>
8643
8666
</instance-parameter>
8644
8667
<parameter name="coordinates" transfer-ownership="none">
8645
<doc xml:whitespace="preserve">An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).</doc>
8668
<doc xml:space="preserve">An array of gdouble (0.0 to 1.0) which represents a stroke (i.e. [x1, y1, x2, y2, x3, y3, ...]).</doc>
8646
8669
<type name="gdouble" c:type="const gdouble*"/>
8648
8671
<parameter name="coordinates_len" transfer-ownership="none">
8649
<doc xml:whitespace="preserve">The number of elements in the array. The number should be even and >= 4.</doc>
8672
<doc xml:space="preserve">The number of elements in the array. The number should be even and >= 4.</doc>
8650
8673
<type name="guint" c:type="guint"/>
8654
8677
<method name="process_key_event"
8655
8678
c:identifier="ibus_input_context_process_key_event">
8656
<doc xml:whitespace="preserve">Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).
8679
<doc xml:space="preserve">Pass the key event to input method engine and wait for the reply from ibus (i.e. synchronous IPC).
8658
8681
See also: ibus_input_context_process_key_event_async()</doc>
8659
8682
<return-value transfer-ownership="none">
8660
<doc xml:whitespace="preserve">TRUE for successfully process the key; FALSE otherwise.</doc>
8683
<doc xml:space="preserve">TRUE for successfully process the key; FALSE otherwise.</doc>
8661
8684
<type name="gboolean" c:type="gboolean"/>
8662
8685
</return-value>
8664
8687
<instance-parameter name="context" transfer-ownership="none">
8665
<doc xml:whitespace="preserve">An IBusInputContext.</doc>
8688
<doc xml:space="preserve">An IBusInputContext.</doc>
8666
8689
<type name="InputContext" c:type="IBusInputContext*"/>
8667
8690
</instance-parameter>
8668
8691
<parameter name="keyval" transfer-ownership="none">
8669
<doc xml:whitespace="preserve">Key symbol of a key event.</doc>
8692
<doc xml:space="preserve">Key symbol of a key event.</doc>
8670
8693
<type name="guint32" c:type="guint32"/>
8672
8695
<parameter name="keycode" transfer-ownership="none">
8673
<doc xml:whitespace="preserve">Keycode of a key event.</doc>
8696
<doc xml:space="preserve">Keycode of a key event.</doc>
8674
8697
<type name="guint32" c:type="guint32"/>
8676
8699
<parameter name="state" transfer-ownership="none">
8677
<doc xml:whitespace="preserve">Key modifier flags.</doc>
8700
<doc xml:space="preserve">Key modifier flags.</doc>
8678
8701
<type name="guint32" c:type="guint32"/>
8682
8705
<method name="process_key_event_async"
8683
8706
c:identifier="ibus_input_context_process_key_event_async">
8684
<doc xml:whitespace="preserve">Pass the key event to input method engine.
8707
<doc xml:space="preserve">Pass the key event to input method engine.
8686
8709
Key symbols are characters/symbols produced by key press, for example,
8687
8710
pressing "s" generates key symbol "s"; pressing shift-"s" generates key symbol "S".
8935
8958
</return-value>
8937
8960
<parameter name="text" transfer-ownership="none">
8938
<doc xml:whitespace="preserve">Text to be committed.</doc>
8961
<doc xml:space="preserve">Text to be committed.</doc>
8939
8962
<type name="Text"/>
8943
8966
<glib:signal name="cursor-down-lookup-table" when="last">
8944
<doc xml:whitespace="preserve">Emitted to select next candidate of lookup table.</doc>
8967
<doc xml:space="preserve">Emitted to select next candidate of lookup table.</doc>
8945
8968
<return-value transfer-ownership="none">
8946
8969
<type name="none" c:type="void"/>
8947
8970
</return-value>
8949
8972
<glib:signal name="cursor-up-lookup-table" when="last">
8950
<doc xml:whitespace="preserve">Emitted to select previous candidate of lookup table.</doc>
8973
<doc xml:space="preserve">Emitted to select previous candidate of lookup table.</doc>
8951
8974
<return-value transfer-ownership="none">
8952
8975
<type name="none" c:type="void"/>
8953
8976
</return-value>
8955
8978
<glib:signal name="delete-surrounding-text" when="last">
8956
<doc xml:whitespace="preserve">Emitted to delete surrounding text event from IME to client of IME.</doc>
8979
<doc xml:space="preserve">Emitted to delete surrounding text event from IME to client of IME.</doc>
8957
8980
<return-value transfer-ownership="none">
8958
8981
<type name="none" c:type="void"/>
8959
8982
</return-value>
8961
8984
<parameter name="offset" transfer-ownership="none">
8962
<doc xml:whitespace="preserve">the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor.</doc>
8985
<doc xml:space="preserve">the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor.</doc>
8963
8986
<type name="gint" c:type="gint"/>
8965
8988
<parameter name="n_chars" transfer-ownership="none">
8966
<doc xml:whitespace="preserve">the number of characters to be deleted.</doc>
8989
<doc xml:space="preserve">the number of characters to be deleted.</doc>
8967
8990
<type name="guint" c:type="guint"/>
8971
8994
<glib:signal name="disabled" when="last">
8972
<doc xml:whitespace="preserve">Emitted when an IME is disabled.</doc>
8995
<doc xml:space="preserve">Emitted when an IME is disabled.</doc>
8973
8996
<return-value transfer-ownership="none">
8974
8997
<type name="none" c:type="void"/>
8975
8998
</return-value>
8977
9000
<glib:signal name="enabled" when="last">
8978
<doc xml:whitespace="preserve">Emitted when an IME is enabled.</doc>
9001
<doc xml:space="preserve">Emitted when an IME is enabled.</doc>
8979
9002
<return-value transfer-ownership="none">
8980
9003
<type name="none" c:type="void"/>
8981
9004
</return-value>
8983
9006
<glib:signal name="forward-key-event" when="last">
8984
<doc xml:whitespace="preserve">Emitted to forward key event from IME to client of IME.</doc>
9007
<doc xml:space="preserve">Emitted to forward key event from IME to client of IME.</doc>
8985
9008
<return-value transfer-ownership="none">
8986
9009
<type name="none" c:type="void"/>
8987
9010
</return-value>
8989
9012
<parameter name="keyval" transfer-ownership="none">
8990
<doc xml:whitespace="preserve">Key symbol of the keyboard event.</doc>
9013
<doc xml:space="preserve">Key symbol of the keyboard event.</doc>
8991
9014
<type name="guint" c:type="guint"/>
8993
9016
<parameter name="keycode" transfer-ownership="none">
8994
<doc xml:whitespace="preserve">Key symbol of the keyboard event.</doc>
9017
<doc xml:space="preserve">Key symbol of the keyboard event.</doc>
8995
9018
<type name="guint" c:type="guint"/>
8997
9020
<parameter name="modifiers" transfer-ownership="none">
8998
<doc xml:whitespace="preserve">Key modifier flags.</doc>
9021
<doc xml:space="preserve">Key modifier flags.</doc>
8999
9022
<type name="guint" c:type="guint"/>
9003
9026
<glib:signal name="hide-auxiliary-text" when="last">
9004
<doc xml:whitespace="preserve">Emitted to hide auxiliary text.</doc>
9027
<doc xml:space="preserve">Emitted to hide auxiliary text.</doc>
9005
9028
<return-value transfer-ownership="none">
9006
9029
<type name="none" c:type="void"/>
9007
9030
</return-value>
9009
9032
<glib:signal name="hide-lookup-table" when="last">
9010
<doc xml:whitespace="preserve">Emitted to hide lookup table.</doc>
9033
<doc xml:space="preserve">Emitted to hide lookup table.</doc>
9011
9034
<return-value transfer-ownership="none">
9012
9035
<type name="none" c:type="void"/>
9013
9036
</return-value>
9015
9038
<glib:signal name="hide-preedit-text" when="last">
9016
<doc xml:whitespace="preserve">Emitted to hide preedit text.</doc>
9039
<doc xml:space="preserve">Emitted to hide preedit text.</doc>
9017
9040
<return-value transfer-ownership="none">
9018
9041
<type name="none" c:type="void"/>
9019
9042
</return-value>
9021
9044
<glib:signal name="page-down-lookup-table" when="last">
9022
<doc xml:whitespace="preserve">Emitted to view the next page of lookup table.</doc>
9045
<doc xml:space="preserve">Emitted to view the next page of lookup table.</doc>
9023
9046
<return-value transfer-ownership="none">
9024
9047
<type name="none" c:type="void"/>
9025
9048
</return-value>
9027
9050
<glib:signal name="page-up-lookup-table" when="last">
9028
<doc xml:whitespace="preserve">Emitted to view the previous page of lookup table.</doc>
9051
<doc xml:space="preserve">Emitted to view the previous page of lookup table.</doc>
9029
9052
<return-value transfer-ownership="none">
9030
9053
<type name="none" c:type="void"/>
9031
9054
</return-value>
9033
9056
<glib:signal name="register-properties" when="last">
9034
<doc xml:whitespace="preserve">Emitted to register the properties in @props.
9057
<doc xml:space="preserve">Emitted to register the properties in @props.
9036
9059
(Note: The props object is floating, and it will be released after the signal.
9037
9060
If singal handler want to keep the object, the handler should use g_object_ref_sink()
9159
9184
glib:type-name="IBusInputHints"
9160
9185
glib:get-type="ibus_input_hints_get_type"
9161
9186
c:type="IBusInputHints">
9162
<doc xml:whitespace="preserve">Describes hints that might be taken into account by engines. Note
9187
<doc xml:space="preserve">Describes hints that might be taken into account by engines. Note
9163
9188
that engines may already tailor their behaviour according to the
9164
9189
#IBusInputPurpose of the entry.</doc>
9165
9190
<member name="none"
9167
9192
c:identifier="IBUS_INPUT_HINT_NONE"
9168
9193
glib:nick="none">
9169
<doc xml:whitespace="preserve">No special behaviour suggested</doc>
9194
<doc xml:space="preserve">No special behaviour suggested</doc>
9171
9196
<member name="spellcheck"
9173
9198
c:identifier="IBUS_INPUT_HINT_SPELLCHECK"
9174
9199
glib:nick="spellcheck">
9175
<doc xml:whitespace="preserve">Suggest checking for typos</doc>
9200
<doc xml:space="preserve">Suggest checking for typos</doc>
9177
9202
<member name="no_spellcheck"
9179
9204
c:identifier="IBUS_INPUT_HINT_NO_SPELLCHECK"
9180
9205
glib:nick="no-spellcheck">
9181
<doc xml:whitespace="preserve">Suggest not checking for typos</doc>
9206
<doc xml:space="preserve">Suggest not checking for typos</doc>
9183
9208
<member name="word_completion"
9185
9210
c:identifier="IBUS_INPUT_HINT_WORD_COMPLETION"
9186
9211
glib:nick="word-completion">
9187
<doc xml:whitespace="preserve">Suggest word completion</doc>
9212
<doc xml:space="preserve">Suggest word completion</doc>
9189
9214
<member name="lowercase"
9191
9216
c:identifier="IBUS_INPUT_HINT_LOWERCASE"
9192
9217
glib:nick="lowercase">
9193
<doc xml:whitespace="preserve">Suggest to convert all text to lowercase</doc>
9218
<doc xml:space="preserve">Suggest to convert all text to lowercase</doc>
9195
9220
<member name="uppercase_chars"
9197
9222
c:identifier="IBUS_INPUT_HINT_UPPERCASE_CHARS"
9198
9223
glib:nick="uppercase-chars">
9199
<doc xml:whitespace="preserve">Suggest to capitalize all text</doc>
9224
<doc xml:space="preserve">Suggest to capitalize all text</doc>
9201
9226
<member name="uppercase_words"
9203
9228
c:identifier="IBUS_INPUT_HINT_UPPERCASE_WORDS"
9204
9229
glib:nick="uppercase-words">
9205
<doc xml:whitespace="preserve">Suggest to capitalize the first character of each word</doc>
9230
<doc xml:space="preserve">Suggest to capitalize the first character of each word</doc>
9207
9232
<member name="uppercase_sentences"
9209
9234
c:identifier="IBUS_INPUT_HINT_UPPERCASE_SENTENCES"
9210
9235
glib:nick="uppercase-sentences">
9211
<doc xml:whitespace="preserve">Suggest to capitalize the first word of each sentence</doc>
9236
<doc xml:space="preserve">Suggest to capitalize the first word of each sentence</doc>
9213
9238
<member name="inhibit_osk"
9215
9240
c:identifier="IBUS_INPUT_HINT_INHIBIT_OSK"
9216
9241
glib:nick="inhibit-osk">
9217
<doc xml:whitespace="preserve">Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).</doc>
9242
<doc xml:space="preserve">Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).</doc>
9220
9245
<enumeration name="InputPurpose"
9221
9246
glib:type-name="IBusInputPurpose"
9222
9247
glib:get-type="ibus_input_purpose_get_type"
9223
9248
c:type="IBusInputPurpose">
9224
<doc xml:whitespace="preserve">Describes primary purpose of the input context. This information
9249
<doc xml:space="preserve">Describes primary purpose of the input context. This information
9225
9250
is particularly useful to implement intelligent behavior in
9226
9251
engines, such as automatic input-mode switch and text prediction.
18088
18122
These input methods should new an IBusKeymap
18089
18123
instance and define the keyboard layout.
18090
18124
Then ibus_keymap_lookup_keysym() can
18091
convert scancodes back to the key symbols.</doc>
18125
convert scancodes back to the key symbols.
18127
see_also: #IBusComponent, #IBusEngineDesc</doc>
18092
18128
<constructor name="new"
18093
18129
c:identifier="ibus_keymap_new"
18094
18130
deprecated="This function has been deprecated and should not be used in newly written code. Please use ibus_keymap_get().">
18095
<doc xml:whitespace="preserve">Get an IBusKeymap associated with the giving name.
18131
<doc xml:space="preserve">Get an IBusKeymap associated with the giving name.
18097
18133
This function loads the keymap file specified in @name
18098
18134
in the IBUS_DATA_DIR/keymaps directory.</doc>
18099
18135
<return-value transfer-ownership="none">
18100
<doc xml:whitespace="preserve">An IBusKeymap associated with the giving name; or NULL if failed.</doc>
18136
<doc xml:space="preserve">An IBusKeymap associated with the giving name; or NULL if failed.</doc>
18101
18137
<type name="Keymap" c:type="IBusKeymap*"/>
18102
18138
</return-value>
18104
18140
<parameter name="name" transfer-ownership="none">
18105
<doc xml:whitespace="preserve">The keymap file to be loaded, such as 'us', 'jp'.</doc>
18141
<doc xml:space="preserve">The keymap file to be loaded, such as 'us', 'jp'.</doc>
18106
18142
<type name="utf8" c:type="const gchar*"/>
18108
18144
</parameters>
18109
18145
</constructor>
18110
<function name="get" c:identifier="ibus_keymap_get" introspectable="0">
18111
<doc xml:whitespace="preserve">Get an IBusKeymap associated with the giving name.
18146
<function name="get" c:identifier="ibus_keymap_get">
18147
<doc xml:space="preserve">Get an IBusKeymap associated with the giving name.
18113
18149
This function loads the keymap file specified in @name
18114
18150
in the IBUS_DATA_DIR/keymaps directory.</doc>
18116
<doc xml:whitespace="preserve">An IBusKeymap associated with the giving name; or NULL if failed.</doc>
18151
<return-value transfer-ownership="full">
18152
<doc xml:space="preserve">An IBusKeymap associated with the giving name; or %NULL if failed.</doc>
18117
18153
<type name="Keymap" c:type="IBusKeymap*"/>
18118
18154
</return-value>
18120
18156
<parameter name="name" transfer-ownership="none">
18121
<doc xml:whitespace="preserve">The keymap file to be loaded, such as 'us', 'jp'.</doc>
18157
<doc xml:space="preserve">The keymap file to be loaded, such as 'us', 'jp'.</doc>
18122
18158
<type name="utf8" c:type="const gchar*"/>
18124
18160
</parameters>
18126
18162
<method name="lookup_keysym" c:identifier="ibus_keymap_lookup_keysym">
18127
<doc xml:whitespace="preserve">Convert the scancode to keysym, given the keymap.</doc>
18163
<doc xml:space="preserve">Convert the scancode to keysym, given the keymap.</doc>
18128
18164
<return-value transfer-ownership="none">
18129
<doc xml:whitespace="preserve">Corresponding keysym.</doc>
18165
<doc xml:space="preserve">Corresponding keysym.</doc>
18130
18166
<type name="guint" c:type="guint"/>
18131
18167
</return-value>
18133
18169
<instance-parameter name="keymap" transfer-ownership="none">
18134
<doc xml:whitespace="preserve">An IBusKeymap.</doc>
18170
<doc xml:space="preserve">An IBusKeymap.</doc>
18135
18171
<type name="Keymap" c:type="IBusKeymap*"/>
18136
18172
</instance-parameter>
18137
18173
<parameter name="keycode" transfer-ownership="none">
18138
<doc xml:whitespace="preserve">A scancode to be converted.</doc>
18174
<doc xml:space="preserve">A scancode to be converted.</doc>
18139
18175
<type name="guint16" c:type="guint16"/>
18141
18177
<parameter name="state" transfer-ownership="none">
18142
<doc xml:whitespace="preserve">Modifier flags(such as Ctrl, Shift).</doc>
18178
<doc xml:space="preserve">Modifier flags(such as Ctrl, Shift).</doc>
18143
18179
<type name="guint32" c:type="guint32"/>
18145
18181
</parameters>
18232
18268
glib:type-name="IBusLookupTable"
18233
18269
glib:get-type="ibus_lookup_table_get_type"
18234
18270
glib:type-struct="LookupTableClass">
18235
<doc xml:whitespace="preserve">An IBusLookuptable stores the candidate words or phrases for users to choose from.
18271
<doc xml:space="preserve">An IBusLookuptable stores the candidate words or phrases for users to
18237
18274
Use ibus_engine_update_lookup_table(), ibus_engine_show_lookup_table(),
18238
18275
and ibus_engine_hide_lookup_table() to update, show and hide the lookup
18278
see_also: #IBusEngine</doc>
18240
18279
<constructor name="new" c:identifier="ibus_lookup_table_new">
18241
<doc xml:whitespace="preserve">New a IBusLookupTable.</doc>
18280
<doc xml:space="preserve">New a IBusLookupTable.</doc>
18242
18281
<return-value transfer-ownership="none">
18243
<doc xml:whitespace="preserve">A newly allocated IBusLookupTable.</doc>
18282
<doc xml:space="preserve">A newly allocated IBusLookupTable.</doc>
18244
18283
<type name="LookupTable" c:type="IBusLookupTable*"/>
18245
18284
</return-value>
18247
18286
<parameter name="page_size" transfer-ownership="none">
18248
<doc xml:whitespace="preserve">number of candidate shown per page, the max value is 16.</doc>
18287
<doc xml:space="preserve">number of candidate shown per page, the max value is 16.</doc>
18249
18288
<type name="guint" c:type="guint"/>
18251
18290
<parameter name="cursor_pos" transfer-ownership="none">
18252
<doc xml:whitespace="preserve">position index of cursor.</doc>
18291
<doc xml:space="preserve">position index of cursor.</doc>
18253
18292
<type name="guint" c:type="guint"/>
18255
18294
<parameter name="cursor_visible" transfer-ownership="none">
18256
<doc xml:whitespace="preserve">whether the cursor is visible.</doc>
18295
<doc xml:space="preserve">whether the cursor is visible.</doc>
18257
18296
<type name="gboolean" c:type="gboolean"/>
18259
18298
<parameter name="round" transfer-ownership="none">
18260
<doc xml:whitespace="preserve">TRUE for lookup table wrap around.</doc>
18299
<doc xml:space="preserve">TRUE for lookup table wrap around.</doc>
18261
18300
<type name="gboolean" c:type="gboolean"/>
18263
18302
</parameters>
18264
18303
</constructor>
18265
18304
<method name="append_candidate"
18266
18305
c:identifier="ibus_lookup_table_append_candidate">
18267
<doc xml:whitespace="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.</doc>
18306
<doc xml:space="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.</doc>
18268
18307
<return-value transfer-ownership="none">
18269
18308
<type name="none" c:type="void"/>
18270
18309
</return-value>
18272
18311
<instance-parameter name="table" transfer-ownership="none">
18273
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18312
<doc xml:space="preserve">An IBusLookupTable.</doc>
18274
18313
<type name="LookupTable" c:type="IBusLookupTable*"/>
18275
18314
</instance-parameter>
18276
18315
<parameter name="text" transfer-ownership="none">
18277
<doc xml:whitespace="preserve">candidate word/phrase to be appended (in IBusText format).</doc>
18316
<doc xml:space="preserve">candidate word/phrase to be appended (in IBusText format).</doc>
18278
18317
<type name="Text" c:type="IBusText*"/>
18280
18319
</parameters>
18282
18321
<method name="append_label"
18283
18322
c:identifier="ibus_lookup_table_append_label">
18284
<doc xml:whitespace="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.
18323
<doc xml:space="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.
18285
18324
This function is needed if the input method select candidate with
18286
18325
non-numeric keys such as "asdfghjkl;".</doc>
18287
18326
<return-value transfer-ownership="none">
18289
18328
</return-value>
18291
18330
<instance-parameter name="table" transfer-ownership="none">
18292
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18331
<doc xml:space="preserve">An IBusLookupTable.</doc>
18293
18332
<type name="LookupTable" c:type="IBusLookupTable*"/>
18294
18333
</instance-parameter>
18295
18334
<parameter name="text" transfer-ownership="none">
18296
<doc xml:whitespace="preserve">A candidate label to be appended (in IBusText format).</doc>
18335
<doc xml:space="preserve">A candidate label to be appended (in IBusText format).</doc>
18297
18336
<type name="Text" c:type="IBusText*"/>
18299
18338
</parameters>
18301
18340
<method name="clear" c:identifier="ibus_lookup_table_clear">
18302
<doc xml:whitespace="preserve">Clear and remove all candidate from an IBusLookupTable.</doc>
18341
<doc xml:space="preserve">Clear and remove all candidate from an IBusLookupTable.</doc>
18303
18342
<return-value transfer-ownership="none">
18304
18343
<type name="none" c:type="void"/>
18305
18344
</return-value>
18307
18346
<instance-parameter name="table" transfer-ownership="none">
18308
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18347
<doc xml:space="preserve">An IBusLookupTable.</doc>
18309
18348
<type name="LookupTable" c:type="IBusLookupTable*"/>
18310
18349
</instance-parameter>
18311
18350
</parameters>
18313
18352
<method name="cursor_down" c:identifier="ibus_lookup_table_cursor_down">
18314
<doc xml:whitespace="preserve">Go to next candidate of an IBusLookupTable.
18353
<doc xml:space="preserve">Go to next candidate of an IBusLookupTable.
18316
18355
It returns FALSE if it is already at the last candidate,
18317
18356
unless <code>table&gt;-round==TRUE</code>, where it will go
18318
18357
to the first candidate.</doc>
18319
18358
<return-value transfer-ownership="none">
18320
<doc xml:whitespace="preserve">TRUE if succeed.</doc>
18359
<doc xml:space="preserve">TRUE if succeed.</doc>
18321
18360
<type name="gboolean" c:type="gboolean"/>
18322
18361
</return-value>
18324
18363
<instance-parameter name="table" transfer-ownership="none">
18325
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18364
<doc xml:space="preserve">An IBusLookupTable.</doc>
18326
18365
<type name="LookupTable" c:type="IBusLookupTable*"/>
18327
18366
</instance-parameter>
18328
18367
</parameters>
18330
18369
<method name="cursor_up" c:identifier="ibus_lookup_table_cursor_up">
18331
<doc xml:whitespace="preserve">Go to previous candidate of an IBusLookupTable.
18370
<doc xml:space="preserve">Go to previous candidate of an IBusLookupTable.
18333
18372
It returns FALSE if it is already at the first candidate,
18334
18373
unless <code>table&gt;-round==TRUE</code>, where it will go
18335
18374
to the last candidate.</doc>
18336
18375
<return-value transfer-ownership="none">
18337
<doc xml:whitespace="preserve">TRUE if succeed.</doc>
18376
<doc xml:space="preserve">TRUE if succeed.</doc>
18338
18377
<type name="gboolean" c:type="gboolean"/>
18339
18378
</return-value>
18341
18380
<instance-parameter name="table" transfer-ownership="none">
18342
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18381
<doc xml:space="preserve">An IBusLookupTable.</doc>
18343
18382
<type name="LookupTable" c:type="IBusLookupTable*"/>
18344
18383
</instance-parameter>
18345
18384
</parameters>
18347
18386
<method name="get_candidate"
18348
18387
c:identifier="ibus_lookup_table_get_candidate">
18349
<doc xml:whitespace="preserve">Return IBusText at the given index. Borrowed reference.</doc>
18388
<doc xml:space="preserve">Return IBusText at the given index. Borrowed reference.</doc>
18350
18389
<return-value transfer-ownership="none">
18351
<doc xml:whitespace="preserve">IBusText at the given index; NULL if no such IBusText.</doc>
18390
<doc xml:space="preserve">IBusText at the given index; NULL if no such IBusText.</doc>
18352
18391
<type name="Text" c:type="IBusText*"/>
18353
18392
</return-value>
18355
18394
<instance-parameter name="table" transfer-ownership="none">
18356
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18395
<doc xml:space="preserve">An IBusLookupTable.</doc>
18357
18396
<type name="LookupTable" c:type="IBusLookupTable*"/>
18358
18397
</instance-parameter>
18359
18398
<parameter name="index" transfer-ownership="none">
18360
<doc xml:whitespace="preserve">Index in the Lookup table.</doc>
18399
<doc xml:space="preserve">Index in the Lookup table.</doc>
18361
18400
<type name="guint" c:type="guint"/>
18363
18402
</parameters>
18365
18404
<method name="get_cursor_in_page"
18366
18405
c:identifier="ibus_lookup_table_get_cursor_in_page">
18367
<doc xml:whitespace="preserve">Get the cursor position in current page of IBusLookupTable.</doc>
18406
<doc xml:space="preserve">Get the cursor position in current page of IBusLookupTable.</doc>
18368
18407
<return-value transfer-ownership="none">
18369
<doc xml:whitespace="preserve">The position of cursor in current page.</doc>
18408
<doc xml:space="preserve">The position of cursor in current page.</doc>
18370
18409
<type name="guint" c:type="guint"/>
18371
18410
</return-value>
18373
18412
<instance-parameter name="table" transfer-ownership="none">
18374
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18413
<doc xml:space="preserve">An IBusLookupTable.</doc>
18375
18414
<type name="LookupTable" c:type="IBusLookupTable*"/>
18376
18415
</instance-parameter>
18377
18416
</parameters>
18379
18418
<method name="get_cursor_pos"
18380
18419
c:identifier="ibus_lookup_table_get_cursor_pos">
18381
<doc xml:whitespace="preserve">Get the cursor position of IBusLookupTable.</doc>
18420
<doc xml:space="preserve">Get the cursor position of IBusLookupTable.</doc>
18382
18421
<return-value transfer-ownership="none">
18383
<doc xml:whitespace="preserve">The position of cursor.</doc>
18422
<doc xml:space="preserve">The position of cursor.</doc>
18384
18423
<type name="guint" c:type="guint"/>
18385
18424
</return-value>
18387
18426
<instance-parameter name="table" transfer-ownership="none">
18388
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18427
<doc xml:space="preserve">An IBusLookupTable.</doc>
18389
18428
<type name="LookupTable" c:type="IBusLookupTable*"/>
18390
18429
</instance-parameter>
18391
18430
</parameters>
18393
18432
<method name="get_label" c:identifier="ibus_lookup_table_get_label">
18394
<doc xml:whitespace="preserve">Return IBusText at the given index. Borrowed reference.</doc>
18433
<doc xml:space="preserve">Return IBusText at the given index. Borrowed reference.</doc>
18395
18434
<return-value transfer-ownership="none">
18396
<doc xml:whitespace="preserve">IBusText at the given index; NULL if no such IBusText.</doc>
18435
<doc xml:space="preserve">IBusText at the given index; NULL if no such IBusText.</doc>
18397
18436
<type name="Text" c:type="IBusText*"/>
18398
18437
</return-value>
18400
18439
<instance-parameter name="table" transfer-ownership="none">
18401
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18440
<doc xml:space="preserve">An IBusLookupTable.</doc>
18402
18441
<type name="LookupTable" c:type="IBusLookupTable*"/>
18403
18442
</instance-parameter>
18404
18443
<parameter name="index" transfer-ownership="none">
18405
<doc xml:whitespace="preserve">Index in the Lookup table.</doc>
18444
<doc xml:space="preserve">Index in the Lookup table.</doc>
18406
18445
<type name="guint" c:type="guint"/>
18408
18447
</parameters>
18410
18449
<method name="get_number_of_candidates"
18411
18450
c:identifier="ibus_lookup_table_get_number_of_candidates">
18412
<doc xml:whitespace="preserve">Return the number of candidate in the table.</doc>
18451
<doc xml:space="preserve">Return the number of candidate in the table.</doc>
18413
18452
<return-value transfer-ownership="none">
18414
<doc xml:whitespace="preserve">The number of candidates in the table</doc>
18453
<doc xml:space="preserve">The number of candidates in the table</doc>
18415
18454
<type name="guint" c:type="guint"/>
18416
18455
</return-value>
18418
18457
<instance-parameter name="table" transfer-ownership="none">
18419
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18458
<doc xml:space="preserve">An IBusLookupTable.</doc>
18420
18459
<type name="LookupTable" c:type="IBusLookupTable*"/>
18421
18460
</instance-parameter>
18422
18461
</parameters>
18424
18463
<method name="get_orientation"
18425
18464
c:identifier="ibus_lookup_table_get_orientation">
18426
<doc xml:whitespace="preserve">Returns the orientation of the IBusLookupTable.</doc>
18465
<doc xml:space="preserve">Returns the orientation of the IBusLookupTable.</doc>
18427
18466
<return-value transfer-ownership="none">
18428
<doc xml:whitespace="preserve">The orientation of the @table.</doc>
18467
<doc xml:space="preserve">The orientation of the @table.</doc>
18429
18468
<type name="gint" c:type="gint"/>
18430
18469
</return-value>
18432
18471
<instance-parameter name="table" transfer-ownership="none">
18433
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18472
<doc xml:space="preserve">An IBusLookupTable.</doc>
18434
18473
<type name="LookupTable" c:type="IBusLookupTable*"/>
18435
18474
</instance-parameter>
18436
18475
</parameters>
18438
18477
<method name="get_page_size"
18439
18478
c:identifier="ibus_lookup_table_get_page_size">
18440
<doc xml:whitespace="preserve">Get the number of candidate shown per page.</doc>
18479
<doc xml:space="preserve">Get the number of candidate shown per page.</doc>
18441
18480
<return-value transfer-ownership="none">
18442
<doc xml:whitespace="preserve">Page size, i.e., number of candidate shown per page.</doc>
18481
<doc xml:space="preserve">Page size, i.e., number of candidate shown per page.</doc>
18443
18482
<type name="guint" c:type="guint"/>
18444
18483
</return-value>
18446
18485
<instance-parameter name="table" transfer-ownership="none">
18447
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18486
<doc xml:space="preserve">An IBusLookupTable.</doc>
18448
18487
<type name="LookupTable" c:type="IBusLookupTable*"/>
18449
18488
</instance-parameter>
18450
18489
</parameters>
18452
18491
<method name="is_cursor_visible"
18453
18492
c:identifier="ibus_lookup_table_is_cursor_visible">
18454
<doc xml:whitespace="preserve">Returns whether the cursor of an IBusLookupTable is visible.</doc>
18493
<doc xml:space="preserve">Returns whether the cursor of an IBusLookupTable is visible.</doc>
18455
18494
<return-value transfer-ownership="none">
18456
<doc xml:whitespace="preserve">Whether the cursor of @table is visible.</doc>
18495
<doc xml:space="preserve">Whether the cursor of @table is visible.</doc>
18457
18496
<type name="gboolean" c:type="gboolean"/>
18458
18497
</return-value>
18460
18499
<instance-parameter name="table" transfer-ownership="none">
18461
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18500
<doc xml:space="preserve">An IBusLookupTable.</doc>
18462
18501
<type name="LookupTable" c:type="IBusLookupTable*"/>
18463
18502
</instance-parameter>
18464
18503
</parameters>
18466
18505
<method name="is_round" c:identifier="ibus_lookup_table_is_round">
18467
<doc xml:whitespace="preserve">Returns whether the IBusLookupTable is round.</doc>
18506
<doc xml:space="preserve">Returns whether the IBusLookupTable is round.</doc>
18468
18507
<return-value transfer-ownership="none">
18469
<doc xml:whitespace="preserve">Whether the @table is round.</doc>
18508
<doc xml:space="preserve">Whether the @table is round.</doc>
18470
18509
<type name="gboolean" c:type="gboolean"/>
18471
18510
</return-value>
18473
18512
<instance-parameter name="table" transfer-ownership="none">
18474
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18513
<doc xml:space="preserve">An IBusLookupTable.</doc>
18475
18514
<type name="LookupTable" c:type="IBusLookupTable*"/>
18476
18515
</instance-parameter>
18477
18516
</parameters>
18479
18518
<method name="page_down" c:identifier="ibus_lookup_table_page_down">
18480
<doc xml:whitespace="preserve">Go to next page of an IBusLookupTable.
18519
<doc xml:space="preserve">Go to next page of an IBusLookupTable.
18482
18521
It returns FALSE if it is already at the last page,
18483
18522
unless <code>table&gt;-round==TRUE</code>, where it will go
18484
18523
to the first page.</doc>
18485
18524
<return-value transfer-ownership="none">
18486
<doc xml:whitespace="preserve">TRUE if succeed.</doc>
18525
<doc xml:space="preserve">TRUE if succeed.</doc>
18487
18526
<type name="gboolean" c:type="gboolean"/>
18488
18527
</return-value>
18490
18529
<instance-parameter name="table" transfer-ownership="none">
18491
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18530
<doc xml:space="preserve">An IBusLookupTable.</doc>
18492
18531
<type name="LookupTable" c:type="IBusLookupTable*"/>
18493
18532
</instance-parameter>
18494
18533
</parameters>
18496
18535
<method name="page_up" c:identifier="ibus_lookup_table_page_up">
18497
<doc xml:whitespace="preserve">Go to previous page of an IBusLookupTable.
18536
<doc xml:space="preserve">Go to previous page of an IBusLookupTable.
18499
18538
It returns FALSE if it is already at the first page,
18500
18539
unless <code>table&gt;-round==TRUE</code>, where it will go
18501
18540
to the last page.</doc>
18502
18541
<return-value transfer-ownership="none">
18503
<doc xml:whitespace="preserve">TRUE if succeed.</doc>
18542
<doc xml:space="preserve">TRUE if succeed.</doc>
18504
18543
<type name="gboolean" c:type="gboolean"/>
18505
18544
</return-value>
18507
18546
<instance-parameter name="table" transfer-ownership="none">
18508
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18547
<doc xml:space="preserve">An IBusLookupTable.</doc>
18509
18548
<type name="LookupTable" c:type="IBusLookupTable*"/>
18510
18549
</instance-parameter>
18511
18550
</parameters>
18513
18552
<method name="set_cursor_pos"
18514
18553
c:identifier="ibus_lookup_table_set_cursor_pos">
18515
<doc xml:whitespace="preserve">Set the cursor position of IBusLookupTable.</doc>
18554
<doc xml:space="preserve">Set the cursor position of IBusLookupTable.</doc>
18516
18555
<return-value transfer-ownership="none">
18517
18556
<type name="none" c:type="void"/>
18518
18557
</return-value>
18520
18559
<instance-parameter name="table" transfer-ownership="none">
18521
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18560
<doc xml:space="preserve">An IBusLookupTable.</doc>
18522
18561
<type name="LookupTable" c:type="IBusLookupTable*"/>
18523
18562
</instance-parameter>
18524
18563
<parameter name="cursor_pos" transfer-ownership="none">
18525
<doc xml:whitespace="preserve">The position of cursor.</doc>
18564
<doc xml:space="preserve">The position of cursor.</doc>
18526
18565
<type name="guint" c:type="guint"/>
18528
18567
</parameters>
18530
18569
<method name="set_cursor_visible"
18531
18570
c:identifier="ibus_lookup_table_set_cursor_visible">
18532
<doc xml:whitespace="preserve">Set whether to make the cursor of an IBusLookupTable visible or not.</doc>
18571
<doc xml:space="preserve">Set whether to make the cursor of an IBusLookupTable visible or not.</doc>
18533
18572
<return-value transfer-ownership="none">
18534
18573
<type name="none" c:type="void"/>
18535
18574
</return-value>
18537
18576
<instance-parameter name="table" transfer-ownership="none">
18538
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18577
<doc xml:space="preserve">An IBusLookupTable.</doc>
18539
18578
<type name="LookupTable" c:type="IBusLookupTable*"/>
18540
18579
</instance-parameter>
18541
18580
<parameter name="visible" transfer-ownership="none">
18542
<doc xml:whitespace="preserve">Whether to make the cursor of @table visible.</doc>
18581
<doc xml:space="preserve">Whether to make the cursor of @table visible.</doc>
18543
18582
<type name="gboolean" c:type="gboolean"/>
18545
18584
</parameters>
18547
18586
<method name="set_label" c:identifier="ibus_lookup_table_set_label">
18548
<doc xml:whitespace="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.
18587
<doc xml:space="preserve">Append a candidate word/phrase to IBusLookupTable, and increase reference.
18549
18588
This function is needed if the input method select candidate with
18550
18589
non-numeric keys such as "asdfghjkl;".</doc>
18551
18590
<return-value transfer-ownership="none">
18553
18592
</return-value>
18555
18594
<instance-parameter name="table" transfer-ownership="none">
18556
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18595
<doc xml:space="preserve">An IBusLookupTable.</doc>
18557
18596
<type name="LookupTable" c:type="IBusLookupTable*"/>
18558
18597
</instance-parameter>
18559
18598
<parameter name="index" transfer-ownership="none">
18560
<doc xml:whitespace="preserve">Intex in the Lookup table.</doc>
18599
<doc xml:space="preserve">Intex in the Lookup table.</doc>
18561
18600
<type name="guint" c:type="guint"/>
18563
18602
<parameter name="text" transfer-ownership="none">
18564
<doc xml:whitespace="preserve">A candidate label to be appended (in IBusText format).</doc>
18603
<doc xml:space="preserve">A candidate label to be appended (in IBusText format).</doc>
18565
18604
<type name="Text" c:type="IBusText*"/>
18567
18606
</parameters>
18569
18608
<method name="set_orientation"
18570
18609
c:identifier="ibus_lookup_table_set_orientation">
18571
<doc xml:whitespace="preserve">Set the orientation.</doc>
18610
<doc xml:space="preserve">Set the orientation.</doc>
18572
18611
<return-value transfer-ownership="none">
18573
18612
<type name="none" c:type="void"/>
18574
18613
</return-value>
18576
18615
<instance-parameter name="table" transfer-ownership="none">
18577
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18616
<doc xml:space="preserve">An IBusLookupTable.</doc>
18578
18617
<type name="LookupTable" c:type="IBusLookupTable*"/>
18579
18618
</instance-parameter>
18580
18619
<parameter name="orientation" transfer-ownership="none">
18581
<doc xml:whitespace="preserve">.</doc>
18620
<doc xml:space="preserve">.</doc>
18582
18621
<type name="gint" c:type="gint"/>
18584
18623
</parameters>
18586
18625
<method name="set_page_size"
18587
18626
c:identifier="ibus_lookup_table_set_page_size">
18588
<doc xml:whitespace="preserve">Set the number of candidate shown per page.</doc>
18627
<doc xml:space="preserve">Set the number of candidate shown per page.</doc>
18589
18628
<return-value transfer-ownership="none">
18590
18629
<type name="none" c:type="void"/>
18591
18630
</return-value>
18593
18632
<instance-parameter name="table" transfer-ownership="none">
18594
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18633
<doc xml:space="preserve">An IBusLookupTable.</doc>
18595
18634
<type name="LookupTable" c:type="IBusLookupTable*"/>
18596
18635
</instance-parameter>
18597
18636
<parameter name="page_size" transfer-ownership="none">
18598
<doc xml:whitespace="preserve">number of candidate shown per page.</doc>
18637
<doc xml:space="preserve">number of candidate shown per page.</doc>
18599
18638
<type name="guint" c:type="guint"/>
18601
18640
</parameters>
18603
18642
<method name="set_round" c:identifier="ibus_lookup_table_set_round">
18604
<doc xml:whitespace="preserve">Set whether to make the IBusLookupTable round or not.</doc>
18643
<doc xml:space="preserve">Set whether to make the IBusLookupTable round or not.</doc>
18605
18644
<return-value transfer-ownership="none">
18606
18645
<type name="none" c:type="void"/>
18607
18646
</return-value>
18609
18648
<instance-parameter name="table" transfer-ownership="none">
18610
<doc xml:whitespace="preserve">An IBusLookupTable.</doc>
18649
<doc xml:space="preserve">An IBusLookupTable.</doc>
18611
18650
<type name="LookupTable" c:type="IBusLookupTable*"/>
18612
18651
</instance-parameter>
18613
18652
<parameter name="round" transfer-ownership="none">
18614
<doc xml:whitespace="preserve">Whether to make @table round.</doc>
18653
<doc xml:space="preserve">Whether to make @table round.</doc>
18615
18654
<type name="gboolean" c:type="gboolean"/>
18617
18656
</parameters>
18719
18758
glib:type-name="IBusModifierType"
18720
18759
glib:get-type="ibus_modifier_type_get_type"
18721
18760
c:type="IBusModifierType">
18722
<doc xml:whitespace="preserve">Handles key modifier such as control, shift and alt and release event.
18761
<doc xml:space="preserve">Handles key modifier such as control, shift and alt and release event.
18723
18762
Note that nits 15 - 25 are currently unused, while bit 29 is used internally.</doc>
18724
18763
<member name="shift_mask"
18726
18765
c:identifier="IBUS_SHIFT_MASK"
18727
18766
glib:nick="shift-mask">
18728
<doc xml:whitespace="preserve">Shift is activated.</doc>
18767
<doc xml:space="preserve">Shift is activated.</doc>
18730
18769
<member name="lock_mask"
18732
18771
c:identifier="IBUS_LOCK_MASK"
18733
18772
glib:nick="lock-mask">
18734
<doc xml:whitespace="preserve">Cap Lock is locked.</doc>
18773
<doc xml:space="preserve">Cap Lock is locked.</doc>
18736
18775
<member name="control_mask"
18738
18777
c:identifier="IBUS_CONTROL_MASK"
18739
18778
glib:nick="control-mask">
18740
<doc xml:whitespace="preserve">Control key is activated.</doc>
18779
<doc xml:space="preserve">Control key is activated.</doc>
18742
18781
<member name="mod1_mask"
18744
18783
c:identifier="IBUS_MOD1_MASK"
18745
18784
glib:nick="mod1-mask">
18746
<doc xml:whitespace="preserve">Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated.</doc>
18785
<doc xml:space="preserve">Modifier 1 (Usually Alt_L (0x40), Alt_R (0x6c), Meta_L (0xcd)) activated.</doc>
18748
18787
<member name="mod2_mask"
18750
18789
c:identifier="IBUS_MOD2_MASK"
18751
18790
glib:nick="mod2-mask">
18752
<doc xml:whitespace="preserve">Modifier 2 (Usually Num_Lock (0x4d)) activated.</doc>
18791
<doc xml:space="preserve">Modifier 2 (Usually Num_Lock (0x4d)) activated.</doc>
18754
18793
<member name="mod3_mask"
18756
18795
c:identifier="IBUS_MOD3_MASK"
18757
18796
glib:nick="mod3-mask">
18758
<doc xml:whitespace="preserve">Modifier 3 activated.</doc>
18797
<doc xml:space="preserve">Modifier 3 activated.</doc>
18760
18799
<member name="mod4_mask"
18762
18801
c:identifier="IBUS_MOD4_MASK"
18763
18802
glib:nick="mod4-mask">
18764
<doc xml:whitespace="preserve">Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated.</doc>
18803
<doc xml:space="preserve">Modifier 4 (Usually Super_L (0xce), Hyper_L (0xcf)) activated.</doc>
18766
18805
<member name="mod5_mask"
18768
18807
c:identifier="IBUS_MOD5_MASK"
18769
18808
glib:nick="mod5-mask">
18770
<doc xml:whitespace="preserve">Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated.</doc>
18809
<doc xml:space="preserve">Modifier 5 (ISO_Level3_Shift (0x5c), Mode_switch (0xcb)) activated.</doc>
18772
18811
<member name="button1_mask"
18774
18813
c:identifier="IBUS_BUTTON1_MASK"
18775
18814
glib:nick="button1-mask">
18776
<doc xml:whitespace="preserve">Mouse button 1 (left) is activated.</doc>
18815
<doc xml:space="preserve">Mouse button 1 (left) is activated.</doc>
18778
18817
<member name="button2_mask"
18780
18819
c:identifier="IBUS_BUTTON2_MASK"
18781
18820
glib:nick="button2-mask">
18782
<doc xml:whitespace="preserve">Mouse button 2 (middle) is activated.</doc>
18821
<doc xml:space="preserve">Mouse button 2 (middle) is activated.</doc>
18784
18823
<member name="button3_mask"
18786
18825
c:identifier="IBUS_BUTTON3_MASK"
18787
18826
glib:nick="button3-mask">
18788
<doc xml:whitespace="preserve">Mouse button 3 (right) is activated.</doc>
18827
<doc xml:space="preserve">Mouse button 3 (right) is activated.</doc>
18790
18829
<member name="button4_mask"
18792
18831
c:identifier="IBUS_BUTTON4_MASK"
18793
18832
glib:nick="button4-mask">
18794
<doc xml:whitespace="preserve">Mouse button 4 (scroll up) is activated.</doc>
18833
<doc xml:space="preserve">Mouse button 4 (scroll up) is activated.</doc>
18796
18835
<member name="button5_mask"
18798
18837
c:identifier="IBUS_BUTTON5_MASK"
18799
18838
glib:nick="button5-mask">
18800
<doc xml:whitespace="preserve">Mouse button 5 (scroll down) is activated.</doc>
18839
<doc xml:space="preserve">Mouse button 5 (scroll down) is activated.</doc>
18802
18841
<member name="handled_mask"
18803
18842
value="16777216"
18804
18843
c:identifier="IBUS_HANDLED_MASK"
18805
18844
glib:nick="handled-mask">
18806
<doc xml:whitespace="preserve">Handled mask indicates the event has been handled by ibus.</doc>
18845
<doc xml:space="preserve">Handled mask indicates the event has been handled by ibus.</doc>
18808
18847
<member name="forward_mask"
18809
18848
value="33554432"
18810
18849
c:identifier="IBUS_FORWARD_MASK"
18811
18850
glib:nick="forward-mask">
18812
<doc xml:whitespace="preserve">Forward mask indicates the event has been forward from ibus.</doc>
18851
<doc xml:space="preserve">Forward mask indicates the event has been forward from ibus.</doc>
18814
18853
<member name="ignored_mask"
18815
18854
value="33554432"
18816
18855
c:identifier="IBUS_IGNORED_MASK"
18817
18856
glib:nick="ignored-mask">
18818
<doc xml:whitespace="preserve">It is an alias of IBUS_FORWARD_MASK.</doc>
18857
<doc xml:space="preserve">It is an alias of IBUS_FORWARD_MASK.</doc>
18820
18859
<member name="super_mask"
18821
18860
value="67108864"
18822
18861
c:identifier="IBUS_SUPER_MASK"
18823
18862
glib:nick="super-mask">
18824
<doc xml:whitespace="preserve">Super (Usually Win) key is activated.</doc>
18863
<doc xml:space="preserve">Super (Usually Win) key is activated.</doc>
18826
18865
<member name="hyper_mask"
18827
18866
value="134217728"
18828
18867
c:identifier="IBUS_HYPER_MASK"
18829
18868
glib:nick="hyper-mask">
18830
<doc xml:whitespace="preserve">Hyper key is activated.</doc>
18869
<doc xml:space="preserve">Hyper key is activated.</doc>
18832
18871
<member name="meta_mask"
18833
18872
value="268435456"
18834
18873
c:identifier="IBUS_META_MASK"
18835
18874
glib:nick="meta-mask">
18836
<doc xml:whitespace="preserve">Meta key is activated.</doc>
18875
<doc xml:space="preserve">Meta key is activated.</doc>
18838
18877
<member name="release_mask"
18839
18878
value="1073741824"
18840
18879
c:identifier="IBUS_RELEASE_MASK"
18841
18880
glib:nick="release-mask">
18842
<doc xml:whitespace="preserve">Key is released.</doc>
18881
<doc xml:space="preserve">Key is released.</doc>
18844
18883
<member name="modifier_mask"
18845
18884
value="1593843711"
18846
18885
c:identifier="IBUS_MODIFIER_MASK"
18847
18886
glib:nick="modifier-mask">
18848
<doc xml:whitespace="preserve">Modifier mask for the all the masks above.</doc>
18887
<doc xml:space="preserve">Modifier mask for the all the masks above.</doc>
18851
18890
<constant name="MouseKeys_Accel_Enable"
19080
19119
<constructor name="new_from_xml_node"
19081
19120
c:identifier="ibus_observed_path_new_from_xml_node"
19082
19121
introspectable="0">
19083
<doc xml:whitespace="preserve">New an IBusObservedPath from an XML node.</doc>
19122
<doc xml:space="preserve">New an IBusObservedPath from an XML node.</doc>
19084
19123
<return-value transfer-ownership="none">
19085
<doc xml:whitespace="preserve">A newly allocated IBusObservedPath.</doc>
19124
<doc xml:space="preserve">A newly allocated IBusObservedPath.</doc>
19086
19125
<type name="ObservedPath" c:type="IBusObservedPath*"/>
19087
19126
</return-value>
19089
19128
<parameter name="node" transfer-ownership="none">
19090
<doc xml:whitespace="preserve">An XML node that contain path.</doc>
19129
<doc xml:space="preserve">An XML node that contain path.</doc>
19091
19130
<type c:type="XMLNode*"/>
19093
19132
<parameter name="fill_stat" transfer-ownership="none">
19094
<doc xml:whitespace="preserve">Auto-fill the path status.</doc>
19133
<doc xml:space="preserve">Auto-fill the path status.</doc>
19095
19134
<type name="gboolean" c:type="gboolean"/>
19097
19136
</parameters>
19098
19137
</constructor>
19099
19138
<method name="check_modification"
19100
19139
c:identifier="ibus_observed_path_check_modification">
19101
<doc xml:whitespace="preserve">Checks whether the path is modified by comparing the mtime in object and mtime in file system.
19140
<doc xml:space="preserve">Checks whether the path is modified by comparing the mtime in object and mtime in file system.
19102
19141
Returns TRUE if imtime is changed, otherwise FALSE.</doc>
19103
19142
<return-value transfer-ownership="none">
19104
<doc xml:whitespace="preserve">TRUE if mtime is changed; FALSE otherwise.</doc>
19143
<doc xml:space="preserve">TRUE if mtime is changed; FALSE otherwise.</doc>
19105
19144
<type name="gboolean" c:type="gboolean"/>
19106
19145
</return-value>
19108
19147
<instance-parameter name="path" transfer-ownership="none">
19109
<doc xml:whitespace="preserve">An IBusObservedPath.</doc>
19148
<doc xml:space="preserve">An IBusObservedPath.</doc>
19110
19149
<type name="ObservedPath" c:type="IBusObservedPath*"/>
19111
19150
</instance-parameter>
19112
19151
</parameters>
19114
19153
<method name="output" c:identifier="ibus_observed_path_output">
19115
<doc xml:whitespace="preserve">Append the observed path to a string with following format:
19154
<doc xml:space="preserve">Append the observed path to a string with following format:
19116
19155
&lt;path mtime="&lt;i&gt;modified time&lt;/i&gt;" &gt;&lt;i&gt;path&lt;/i&gt;&lt;/path&gt;</doc>
19117
19156
<return-value transfer-ownership="none">
19118
19157
<type name="none" c:type="void"/>
19119
19158
</return-value>
19121
19160
<instance-parameter name="path" transfer-ownership="none">
19122
<doc xml:whitespace="preserve">An IBusObservedPath.</doc>
19161
<doc xml:space="preserve">An IBusObservedPath.</doc>
19123
19162
<type name="ObservedPath" c:type="IBusObservedPath*"/>
19124
19163
</instance-parameter>
19125
19164
<parameter name="output" transfer-ownership="none">
19126
<doc xml:whitespace="preserve">Path is appended to.</doc>
19165
<doc xml:space="preserve">Path is appended to.</doc>
19127
19166
<type name="GLib.String" c:type="GString*"/>
19129
19168
<parameter name="indent" transfer-ownership="none">
19130
<doc xml:whitespace="preserve">number of indent.</doc>
19169
<doc xml:space="preserve">number of indent.</doc>
19131
19170
<type name="gint" c:type="gint"/>
19133
19172
</parameters>
19135
<method name="traverse"
19136
c:identifier="ibus_observed_path_traverse"
19137
introspectable="0">
19138
<doc xml:whitespace="preserve">Recursively traverse the path and put the files and subdirectory in to a newly allocated
19174
<method name="traverse" c:identifier="ibus_observed_path_traverse">
19175
<doc xml:space="preserve">Recursively traverse the path and put the files and subdirectory in to
19139
19177
GLists, if the @path is a directory. Otherwise returns NULL.</doc>
19141
<doc xml:whitespace="preserve">A newly allocate GList which holds content in path; NULL if @path is not directory.</doc>
19178
<return-value transfer-ownership="full">
19179
<doc xml:space="preserve">A newly allocate GList which holds content in path; NULL if @path is not directory.</doc>
19142
19180
<type name="GLib.List" c:type="GList*">
19143
19181
<type name="ObservedPath"/>
19145
19183
</return-value>
19147
19185
<instance-parameter name="path" transfer-ownership="none">
19148
<doc xml:whitespace="preserve">An IBusObservedPath.</doc>
19186
<doc xml:space="preserve">An IBusObservedPath.</doc>
19149
19187
<type name="ObservedPath" c:type="IBusObservedPath*"/>
19150
19188
</instance-parameter>
19151
19189
<parameter name="dir_only" transfer-ownership="none">
19152
<doc xml:whitespace="preserve">Only looks for subdirs, not files</doc>
19190
<doc xml:space="preserve">Only looks for subdirs, not files</doc>
19153
19191
<type name="gboolean" c:type="gboolean"/>
19155
19193
</parameters>
19646
19684
</virtual-method>
19647
19685
<method name="candidate_clicked"
19648
19686
c:identifier="ibus_panel_service_candidate_clicked">
19649
<doc xml:whitespace="preserve">Notify that a candidate is clicked
19687
<doc xml:space="preserve">Notify that a candidate is clicked
19650
19688
by sending a "CandidateClicked" to IBus service.</doc>
19651
19689
<return-value transfer-ownership="none">
19652
19690
<type name="none" c:type="void"/>
19653
19691
</return-value>
19655
19693
<instance-parameter name="panel" transfer-ownership="none">
19656
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19694
<doc xml:space="preserve">An IBusPanelService</doc>
19657
19695
<type name="PanelService" c:type="IBusPanelService*"/>
19658
19696
</instance-parameter>
19659
19697
<parameter name="index" transfer-ownership="none">
19660
<doc xml:whitespace="preserve">Index in the Lookup table</doc>
19698
<doc xml:space="preserve">Index in the Lookup table</doc>
19661
19699
<type name="guint" c:type="guint"/>
19663
19701
<parameter name="button" transfer-ownership="none">
19664
<doc xml:whitespace="preserve">GdkEventButton::button (1: left button, etc.)</doc>
19702
<doc xml:space="preserve">GdkEventButton::button (1: left button, etc.)</doc>
19665
19703
<type name="guint" c:type="guint"/>
19667
19705
<parameter name="state" transfer-ownership="none">
19668
<doc xml:whitespace="preserve">GdkEventButton::state (key modifier flags)</doc>
19706
<doc xml:space="preserve">GdkEventButton::state (key modifier flags)</doc>
19669
19707
<type name="guint" c:type="guint"/>
19671
19709
</parameters>
19673
19711
<method name="cursor_down" c:identifier="ibus_panel_service_cursor_down">
19674
<doc xml:whitespace="preserve">Notify that the cursor is down
19712
<doc xml:space="preserve">Notify that the cursor is down
19675
19713
by sending a "CursorDown" to IBus service.</doc>
19676
19714
<return-value transfer-ownership="none">
19677
19715
<type name="none" c:type="void"/>
19678
19716
</return-value>
19680
19718
<instance-parameter name="panel" transfer-ownership="none">
19681
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19719
<doc xml:space="preserve">An IBusPanelService</doc>
19682
19720
<type name="PanelService" c:type="IBusPanelService*"/>
19683
19721
</instance-parameter>
19684
19722
</parameters>
19686
19724
<method name="cursor_up" c:identifier="ibus_panel_service_cursor_up">
19687
<doc xml:whitespace="preserve">Notify that the cursor is up
19725
<doc xml:space="preserve">Notify that the cursor is up
19688
19726
by sending a "CursorUp" to IBus service.</doc>
19689
19727
<return-value transfer-ownership="none">
19690
19728
<type name="none" c:type="void"/>
19691
19729
</return-value>
19693
19731
<instance-parameter name="panel" transfer-ownership="none">
19694
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19732
<doc xml:space="preserve">An IBusPanelService</doc>
19695
19733
<type name="PanelService" c:type="IBusPanelService*"/>
19696
19734
</instance-parameter>
19697
19735
</parameters>
19699
19737
<method name="page_down" c:identifier="ibus_panel_service_page_down">
19700
<doc xml:whitespace="preserve">Notify that the page is down
19738
<doc xml:space="preserve">Notify that the page is down
19701
19739
by sending a "PageDown" to IBus service.</doc>
19702
19740
<return-value transfer-ownership="none">
19703
19741
<type name="none" c:type="void"/>
19704
19742
</return-value>
19706
19744
<instance-parameter name="panel" transfer-ownership="none">
19707
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19745
<doc xml:space="preserve">An IBusPanelService</doc>
19708
19746
<type name="PanelService" c:type="IBusPanelService*"/>
19709
19747
</instance-parameter>
19710
19748
</parameters>
19712
19750
<method name="page_up" c:identifier="ibus_panel_service_page_up">
19713
<doc xml:whitespace="preserve">Notify that the page is up
19751
<doc xml:space="preserve">Notify that the page is up
19714
19752
by sending a "PageUp" to IBus service.</doc>
19715
19753
<return-value transfer-ownership="none">
19716
19754
<type name="none" c:type="void"/>
19717
19755
</return-value>
19719
19757
<instance-parameter name="panel" transfer-ownership="none">
19720
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19758
<doc xml:space="preserve">An IBusPanelService</doc>
19721
19759
<type name="PanelService" c:type="IBusPanelService*"/>
19722
19760
</instance-parameter>
19723
19761
</parameters>
19725
19763
<method name="property_activate"
19726
19764
c:identifier="ibus_panel_service_property_activate">
19727
<doc xml:whitespace="preserve">Notify that a property is active
19765
<doc xml:space="preserve">Notify that a property is active
19728
19766
by sending a "PropertyActivate" message to IBus service.</doc>
19729
19767
<return-value transfer-ownership="none">
19730
19768
<type name="none" c:type="void"/>
19731
19769
</return-value>
19733
19771
<instance-parameter name="panel" transfer-ownership="none">
19734
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19772
<doc xml:space="preserve">An IBusPanelService</doc>
19735
19773
<type name="PanelService" c:type="IBusPanelService*"/>
19736
19774
</instance-parameter>
19737
19775
<parameter name="prop_name" transfer-ownership="none">
19738
<doc xml:whitespace="preserve">A property name</doc>
19776
<doc xml:space="preserve">A property name</doc>
19739
19777
<type name="utf8" c:type="const gchar*"/>
19741
19779
<parameter name="prop_state" transfer-ownership="none">
19742
<doc xml:whitespace="preserve">State of the property</doc>
19780
<doc xml:space="preserve">State of the property</doc>
19743
19781
<type name="guint" c:type="guint"/>
19745
19783
</parameters>
19747
19785
<method name="property_hide"
19748
19786
c:identifier="ibus_panel_service_property_hide">
19749
<doc xml:whitespace="preserve">Notify that a property is hidden
19787
<doc xml:space="preserve">Notify that a property is hidden
19750
19788
by sending a "ValueChanged" message to IBus service.</doc>
19751
19789
<return-value transfer-ownership="none">
19752
19790
<type name="none" c:type="void"/>
19753
19791
</return-value>
19755
19793
<instance-parameter name="panel" transfer-ownership="none">
19756
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19794
<doc xml:space="preserve">An IBusPanelService</doc>
19757
19795
<type name="PanelService" c:type="IBusPanelService*"/>
19758
19796
</instance-parameter>
19759
19797
<parameter name="prop_name" transfer-ownership="none">
19760
<doc xml:whitespace="preserve">A property name</doc>
19798
<doc xml:space="preserve">A property name</doc>
19761
19799
<type name="utf8" c:type="const gchar*"/>
19763
19801
</parameters>
19765
19803
<method name="property_show"
19766
19804
c:identifier="ibus_panel_service_property_show">
19767
<doc xml:whitespace="preserve">Notify that a property is shown
19805
<doc xml:space="preserve">Notify that a property is shown
19768
19806
by sending a "ValueChanged" message to IBus service.</doc>
19769
19807
<return-value transfer-ownership="none">
19770
19808
<type name="none" c:type="void"/>
19771
19809
</return-value>
19773
19811
<instance-parameter name="panel" transfer-ownership="none">
19774
<doc xml:whitespace="preserve">An IBusPanelService</doc>
19812
<doc xml:space="preserve">An IBusPanelService</doc>
19775
19813
<type name="PanelService" c:type="IBusPanelService*"/>
19776
19814
</instance-parameter>
19777
19815
<parameter name="prop_name" transfer-ownership="none">
19778
<doc xml:whitespace="preserve">A property name</doc>
19816
<doc xml:space="preserve">A property name</doc>
19779
19817
<type name="utf8" c:type="const gchar*"/>
19781
19819
</parameters>
20639
20693
glib:type-name="IBusPropList"
20640
20694
glib:get-type="ibus_prop_list_get_type"
20641
20695
glib:type-struct="PropListClass">
20696
<doc xml:space="preserve">See_also: #IBusProperty, #IBusEngine</doc>
20642
20697
<constructor name="new" c:identifier="ibus_prop_list_new">
20643
<doc xml:whitespace="preserve">New a IBusPropList.</doc>
20698
<doc xml:space="preserve">New a IBusPropList.</doc>
20644
20699
<return-value transfer-ownership="none">
20645
<doc xml:whitespace="preserve">A newly allocated IBusPropList.</doc>
20700
<doc xml:space="preserve">A newly allocated IBusPropList.</doc>
20646
20701
<type name="PropList" c:type="IBusPropList*"/>
20647
20702
</return-value>
20648
20703
</constructor>
20649
20704
<method name="append" c:identifier="ibus_prop_list_append">
20650
<doc xml:whitespace="preserve">Append an IBusProperty to an IBusPropList, and increase reference.</doc>
20705
<doc xml:space="preserve">Append an IBusProperty to an IBusPropList, and increase reference.</doc>
20651
20706
<return-value transfer-ownership="none">
20652
20707
<type name="none" c:type="void"/>
20653
20708
</return-value>
20655
20710
<instance-parameter name="prop_list" transfer-ownership="none">
20656
<doc xml:whitespace="preserve">An IBusPropList.</doc>
20711
<doc xml:space="preserve">An IBusPropList.</doc>
20657
20712
<type name="PropList" c:type="IBusPropList*"/>
20658
20713
</instance-parameter>
20659
20714
<parameter name="prop" transfer-ownership="none">
20660
<doc xml:whitespace="preserve">IBusProperty to be append to @prop_list.</doc>
20715
<doc xml:space="preserve">IBusProperty to be append to @prop_list.</doc>
20661
20716
<type name="Property" c:type="IBusProperty*"/>
20663
20718
</parameters>
20665
20720
<method name="get" c:identifier="ibus_prop_list_get">
20666
<doc xml:whitespace="preserve">Returns IBusProperty at given index. Borrowed reference.</doc>
20721
<doc xml:space="preserve">Returns IBusProperty at given index. Borrowed reference.</doc>
20667
20722
<return-value transfer-ownership="none">
20668
<doc xml:whitespace="preserve">IBusProperty at given index, NULL if no such IBusProperty.</doc>
20723
<doc xml:space="preserve">IBusProperty at given index, NULL if no such IBusProperty.</doc>
20669
20724
<type name="Property" c:type="IBusProperty*"/>
20670
20725
</return-value>
20672
20727
<instance-parameter name="prop_list" transfer-ownership="none">
20673
<doc xml:whitespace="preserve">An IBusPropList.</doc>
20728
<doc xml:space="preserve">An IBusPropList.</doc>
20674
20729
<type name="PropList" c:type="IBusPropList*"/>
20675
20730
</instance-parameter>
20676
20731
<parameter name="index" transfer-ownership="none">
20677
<doc xml:whitespace="preserve">Index of an IBusPropList.</doc>
20732
<doc xml:space="preserve">Index of an IBusPropList.</doc>
20678
20733
<type name="guint" c:type="guint"/>
20680
20735
</parameters>
20682
20737
<method name="update_property"
20683
20738
c:identifier="ibus_prop_list_update_property">
20684
<doc xml:whitespace="preserve">Update an IBusProperty in IBusPropList.</doc>
20739
<doc xml:space="preserve">Update an IBusProperty in IBusPropList.</doc>
20685
20740
<return-value transfer-ownership="none">
20686
<doc xml:whitespace="preserve">TRUE if succeeded, FALSE otherwise.</doc>
20741
<doc xml:space="preserve">TRUE if succeeded, FALSE otherwise.</doc>
20687
20742
<type name="gboolean" c:type="gboolean"/>
20688
20743
</return-value>
20690
20745
<instance-parameter name="prop_list" transfer-ownership="none">
20691
<doc xml:whitespace="preserve">An IBusPropList.</doc>
20746
<doc xml:space="preserve">An IBusPropList.</doc>
20692
20747
<type name="PropList" c:type="IBusPropList*"/>
20693
20748
</instance-parameter>
20694
20749
<parameter name="prop" transfer-ownership="none">
20695
<doc xml:whitespace="preserve">IBusProperty to be update.</doc>
20750
<doc xml:space="preserve">IBusProperty to be update.</doc>
20696
20751
<type name="Property" c:type="IBusProperty*"/>
20698
20753
</parameters>
20803
20858
see_also: #IBusPropList, #IBusEngine</doc>
20804
20859
<constructor name="new" c:identifier="ibus_property_new">
20805
<doc xml:whitespace="preserve">New a #IBusProperty.</doc>
20860
<doc xml:space="preserve">New a #IBusProperty.</doc>
20806
20861
<return-value transfer-ownership="none">
20807
<doc xml:whitespace="preserve">A newly allocated #IBusProperty.</doc>
20862
<doc xml:space="preserve">A newly allocated #IBusProperty.</doc>
20808
20863
<type name="Property" c:type="IBusProperty*"/>
20809
20864
</return-value>
20811
20866
<parameter name="key" transfer-ownership="none">
20812
<doc xml:whitespace="preserve">Unique Identity for the #IBusProperty.</doc>
20867
<doc xml:space="preserve">Unique Identity for the #IBusProperty.</doc>
20813
20868
<type name="utf8" c:type="const gchar*"/>
20815
20870
<parameter name="type" transfer-ownership="none">
20816
<doc xml:whitespace="preserve">#IBusPropType of #IBusProperty.</doc>
20871
<doc xml:space="preserve">#IBusPropType of #IBusProperty.</doc>
20817
20872
<type name="PropType" c:type="IBusPropType"/>
20819
20874
<parameter name="label" transfer-ownership="none">
20820
<doc xml:whitespace="preserve">Text shown in UI.</doc>
20875
<doc xml:space="preserve">Text shown in UI.</doc>
20821
20876
<type name="Text" c:type="IBusText*"/>
20823
20878
<parameter name="icon" transfer-ownership="none" allow-none="1">
20824
<doc xml:whitespace="preserve">Icon file for the #IBusProperty.</doc>
20879
<doc xml:space="preserve">Icon file for the #IBusProperty.</doc>
20825
20880
<type name="utf8" c:type="const gchar*"/>
20827
20882
<parameter name="tooltip" transfer-ownership="none">
20828
<doc xml:whitespace="preserve">Message shown if mouse hovered the #IBusProperty.</doc>
20883
<doc xml:space="preserve">Message shown if mouse hovered the #IBusProperty.</doc>
20829
20884
<type name="Text" c:type="IBusText*"/>
20831
20886
<parameter name="sensitive" transfer-ownership="none">
20832
<doc xml:whitespace="preserve">Whether the #IBusProperty is sensitive to keyboard and mouse event.</doc>
20887
<doc xml:space="preserve">Whether the #IBusProperty is sensitive to keyboard and mouse event.</doc>
20833
20888
<type name="gboolean" c:type="gboolean"/>
20835
20890
<parameter name="visible" transfer-ownership="none">
20836
<doc xml:whitespace="preserve">Whether the #IBusProperty is visible.</doc>
20891
<doc xml:space="preserve">Whether the #IBusProperty is visible.</doc>
20837
20892
<type name="gboolean" c:type="gboolean"/>
20839
20894
<parameter name="state" transfer-ownership="none">
20840
<doc xml:whitespace="preserve">IBusPropState of #IBusProperty.</doc>
20895
<doc xml:space="preserve">IBusPropState of #IBusProperty.</doc>
20841
20896
<type name="PropState" c:type="IBusPropState"/>
20843
20898
<parameter name="prop_list" transfer-ownership="none" allow-none="1">
20844
<doc xml:whitespace="preserve">#IBusPropList that contains sub IBusProperties.</doc>
20899
<doc xml:space="preserve">#IBusPropList that contains sub IBusProperties.</doc>
20845
20900
<type name="PropList" c:type="IBusPropList*"/>
20847
20902
</parameters>
20917
20972
</parameters>
20919
20974
<method name="get_sensitive" c:identifier="ibus_property_get_sensitive">
20920
<doc xml:whitespace="preserve">Get the sensitive of #IBusProperty.</doc>
20975
<doc xml:space="preserve">Get the sensitive of #IBusProperty.</doc>
20921
20976
<return-value transfer-ownership="none">
20922
<doc xml:whitespace="preserve">the sensitive of #IBusProperty.</doc>
20977
<doc xml:space="preserve">the sensitive of #IBusProperty.</doc>
20923
20978
<type name="gboolean" c:type="gboolean"/>
20924
20979
</return-value>
20926
20981
<instance-parameter name="prop" transfer-ownership="none">
20927
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
20982
<doc xml:space="preserve">An #IBusProperty.</doc>
20928
20983
<type name="Property" c:type="IBusProperty*"/>
20929
20984
</instance-parameter>
20930
20985
</parameters>
20932
20987
<method name="get_state" c:identifier="ibus_property_get_state">
20933
<doc xml:whitespace="preserve">Get the state of #IBusProperty.</doc>
20988
<doc xml:space="preserve">Get the state of #IBusProperty.</doc>
20934
20989
<return-value transfer-ownership="none">
20935
<doc xml:whitespace="preserve">the state of #IBusProperty.</doc>
20990
<doc xml:space="preserve">the state of #IBusProperty.</doc>
20936
20991
<type name="PropState" c:type="IBusPropState"/>
20937
20992
</return-value>
20939
20994
<instance-parameter name="prop" transfer-ownership="none">
20940
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
20995
<doc xml:space="preserve">An #IBusProperty.</doc>
20941
20996
<type name="Property" c:type="IBusProperty*"/>
20942
20997
</instance-parameter>
20943
20998
</parameters>
20945
21000
<method name="get_sub_props" c:identifier="ibus_property_get_sub_props">
20946
<doc xml:whitespace="preserve">Get the IBusPropList of #IBusProperty.</doc>
21001
<doc xml:space="preserve">Get the IBusPropList of #IBusProperty.</doc>
20947
21002
<return-value transfer-ownership="none">
20948
<doc xml:whitespace="preserve">the IBusPropList of #IBusProperty. Should not be freed.</doc>
21003
<doc xml:space="preserve">the IBusPropList of #IBusProperty. Should not be freed.</doc>
20949
21004
<type name="PropList" c:type="IBusPropList*"/>
20950
21005
</return-value>
20952
21007
<instance-parameter name="prop" transfer-ownership="none">
20953
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21008
<doc xml:space="preserve">An #IBusProperty.</doc>
20954
21009
<type name="Property" c:type="IBusProperty*"/>
20955
21010
</instance-parameter>
20956
21011
</parameters>
20958
21013
<method name="get_symbol" c:identifier="ibus_property_get_symbol">
20959
<doc xml:whitespace="preserve">Get the symbol of #IBusProperty.</doc>
21014
<doc xml:space="preserve">Get the symbol of #IBusProperty.</doc>
20960
21015
<return-value transfer-ownership="none">
20961
<doc xml:whitespace="preserve">the symbol of #IBusProperty. Should not be freed.</doc>
21016
<doc xml:space="preserve">the symbol of #IBusProperty. Should not be freed.</doc>
20962
21017
<type name="Text" c:type="IBusText*"/>
20963
21018
</return-value>
20965
21020
<instance-parameter name="prop" transfer-ownership="none">
20966
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21021
<doc xml:space="preserve">An #IBusProperty.</doc>
20967
21022
<type name="Property" c:type="IBusProperty*"/>
20968
21023
</instance-parameter>
20969
21024
</parameters>
20971
21026
<method name="get_tooltip" c:identifier="ibus_property_get_tooltip">
20972
<doc xml:whitespace="preserve">Get the tooltip of #IBusProperty.</doc>
21027
<doc xml:space="preserve">Get the tooltip of #IBusProperty.</doc>
20973
21028
<return-value transfer-ownership="none">
20974
<doc xml:whitespace="preserve">the tooltip of #IBusProperty. Should not be freed.</doc>
21029
<doc xml:space="preserve">the tooltip of #IBusProperty. Should not be freed.</doc>
20975
21030
<type name="Text" c:type="IBusText*"/>
20976
21031
</return-value>
20978
21033
<instance-parameter name="prop" transfer-ownership="none">
20979
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21034
<doc xml:space="preserve">An #IBusProperty.</doc>
20980
21035
<type name="Property" c:type="IBusProperty*"/>
20981
21036
</instance-parameter>
20982
21037
</parameters>
20984
21039
<method name="get_visible" c:identifier="ibus_property_get_visible">
20985
<doc xml:whitespace="preserve">Get the visible of #IBusProperty.</doc>
21040
<doc xml:space="preserve">Get the visible of #IBusProperty.</doc>
20986
21041
<return-value transfer-ownership="none">
20987
<doc xml:whitespace="preserve">the visible of #IBusProperty.</doc>
21042
<doc xml:space="preserve">the visible of #IBusProperty.</doc>
20988
21043
<type name="gboolean" c:type="gboolean"/>
20989
21044
</return-value>
20991
21046
<instance-parameter name="prop" transfer-ownership="none">
20992
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21047
<doc xml:space="preserve">An #IBusProperty.</doc>
20993
21048
<type name="Property" c:type="IBusProperty*"/>
20994
21049
</instance-parameter>
20995
21050
</parameters>
20997
21052
<method name="set_icon" c:identifier="ibus_property_set_icon">
20998
<doc xml:whitespace="preserve">Set the icon of #IBusProperty.</doc>
21053
<doc xml:space="preserve">Set the icon of #IBusProperty.</doc>
20999
21054
<return-value transfer-ownership="none">
21000
21055
<type name="none" c:type="void"/>
21001
21056
</return-value>
21003
21058
<instance-parameter name="prop" transfer-ownership="none">
21004
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21059
<doc xml:space="preserve">An #IBusProperty.</doc>
21005
21060
<type name="Property" c:type="IBusProperty*"/>
21006
21061
</instance-parameter>
21007
21062
<parameter name="icon" transfer-ownership="none">
21008
<doc xml:whitespace="preserve">Icon shown in UI. It could be a full path of an icon file or an icon name.</doc>
21063
<doc xml:space="preserve">Icon shown in UI. It could be a full path of an icon file or an icon name.</doc>
21009
21064
<type name="utf8" c:type="const gchar*"/>
21011
21066
</parameters>
21013
21068
<method name="set_label" c:identifier="ibus_property_set_label">
21014
<doc xml:whitespace="preserve">Set the label of #IBusProperty.</doc>
21069
<doc xml:space="preserve">Set the label of #IBusProperty.</doc>
21015
21070
<return-value transfer-ownership="none">
21016
21071
<type name="none" c:type="void"/>
21017
21072
</return-value>
21019
21074
<instance-parameter name="prop" transfer-ownership="none">
21020
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21075
<doc xml:space="preserve">An #IBusProperty.</doc>
21021
21076
<type name="Property" c:type="IBusProperty*"/>
21022
21077
</instance-parameter>
21023
21078
<parameter name="label" transfer-ownership="none">
21024
<doc xml:whitespace="preserve">Text shown in UI.</doc>
21079
<doc xml:space="preserve">Text shown in UI.</doc>
21025
21080
<type name="Text" c:type="IBusText*"/>
21027
21082
</parameters>
21029
21084
<method name="set_sensitive" c:identifier="ibus_property_set_sensitive">
21030
<doc xml:whitespace="preserve">Set whether the #IBusProperty is sensitive.</doc>
21085
<doc xml:space="preserve">Set whether the #IBusProperty is sensitive.</doc>
21031
21086
<return-value transfer-ownership="none">
21032
21087
<type name="none" c:type="void"/>
21033
21088
</return-value>
21035
21090
<instance-parameter name="prop" transfer-ownership="none">
21036
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21091
<doc xml:space="preserve">An #IBusProperty.</doc>
21037
21092
<type name="Property" c:type="IBusProperty*"/>
21038
21093
</instance-parameter>
21039
21094
<parameter name="sensitive" transfer-ownership="none">
21040
<doc xml:whitespace="preserve">Whether the #IBusProperty is sensitive.</doc>
21095
<doc xml:space="preserve">Whether the #IBusProperty is sensitive.</doc>
21041
21096
<type name="gboolean" c:type="gboolean"/>
21043
21098
</parameters>
21045
21100
<method name="set_state" c:identifier="ibus_property_set_state">
21046
<doc xml:whitespace="preserve">Set the state of the #IBusProperty.</doc>
21101
<doc xml:space="preserve">Set the state of the #IBusProperty.</doc>
21047
21102
<return-value transfer-ownership="none">
21048
21103
<type name="none" c:type="void"/>
21049
21104
</return-value>
21051
21106
<instance-parameter name="prop" transfer-ownership="none">
21052
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21107
<doc xml:space="preserve">An #IBusProperty.</doc>
21053
21108
<type name="Property" c:type="IBusProperty*"/>
21054
21109
</instance-parameter>
21055
21110
<parameter name="state" transfer-ownership="none">
21056
<doc xml:whitespace="preserve">The state of the #IBusProperty.</doc>
21111
<doc xml:space="preserve">The state of the #IBusProperty.</doc>
21057
21112
<type name="PropState" c:type="IBusPropState"/>
21059
21114
</parameters>
21061
21116
<method name="set_sub_props" c:identifier="ibus_property_set_sub_props">
21062
<doc xml:whitespace="preserve">Set the sub IBusProperties.</doc>
21117
<doc xml:space="preserve">Set the sub IBusProperties.</doc>
21063
21118
<return-value transfer-ownership="none">
21064
21119
<type name="none" c:type="void"/>
21065
21120
</return-value>
21067
21122
<instance-parameter name="prop" transfer-ownership="none">
21068
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21123
<doc xml:space="preserve">An #IBusProperty.</doc>
21069
21124
<type name="Property" c:type="IBusProperty*"/>
21070
21125
</instance-parameter>
21071
21126
<parameter name="prop_list" transfer-ownership="none">
21072
<doc xml:whitespace="preserve">#IBusPropList that contains sub IBusProperties.</doc>
21127
<doc xml:space="preserve">#IBusPropList that contains sub IBusProperties.</doc>
21073
21128
<type name="PropList" c:type="IBusPropList*"/>
21075
21130
</parameters>
21077
21132
<method name="set_symbol" c:identifier="ibus_property_set_symbol">
21078
<doc xml:whitespace="preserve">Set the symbol of #IBusProperty.</doc>
21133
<doc xml:space="preserve">Set the symbol of #IBusProperty.</doc>
21079
21134
<return-value transfer-ownership="none">
21080
21135
<type name="none" c:type="void"/>
21081
21136
</return-value>
21083
21138
<instance-parameter name="prop" transfer-ownership="none">
21084
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21139
<doc xml:space="preserve">An #IBusProperty.</doc>
21085
21140
<type name="Property" c:type="IBusProperty*"/>
21086
21141
</instance-parameter>
21087
21142
<parameter name="symbol" transfer-ownership="none">
21088
<doc xml:whitespace="preserve">Text shown in UI.</doc>
21143
<doc xml:space="preserve">Text shown in UI.</doc>
21089
21144
<type name="Text" c:type="IBusText*"/>
21091
21146
</parameters>
21093
21148
<method name="set_tooltip" c:identifier="ibus_property_set_tooltip">
21094
<doc xml:whitespace="preserve">Set the tooltip of #IBusProperty.</doc>
21149
<doc xml:space="preserve">Set the tooltip of #IBusProperty.</doc>
21095
21150
<return-value transfer-ownership="none">
21096
21151
<type name="none" c:type="void"/>
21097
21152
</return-value>
21099
21154
<instance-parameter name="prop" transfer-ownership="none">
21100
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21155
<doc xml:space="preserve">An #IBusProperty.</doc>
21101
21156
<type name="Property" c:type="IBusProperty*"/>
21102
21157
</instance-parameter>
21103
21158
<parameter name="tooltip" transfer-ownership="none">
21104
<doc xml:whitespace="preserve">Text of the tooltip.</doc>
21159
<doc xml:space="preserve">Text of the tooltip.</doc>
21105
21160
<type name="Text" c:type="IBusText*"/>
21107
21162
</parameters>
21109
21164
<method name="set_visible" c:identifier="ibus_property_set_visible">
21110
<doc xml:whitespace="preserve">Set whether the #IBusProperty is visible.</doc>
21165
<doc xml:space="preserve">Set whether the #IBusProperty is visible.</doc>
21111
21166
<return-value transfer-ownership="none">
21112
21167
<type name="none" c:type="void"/>
21113
21168
</return-value>
21115
21170
<instance-parameter name="prop" transfer-ownership="none">
21116
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21171
<doc xml:space="preserve">An #IBusProperty.</doc>
21117
21172
<type name="Property" c:type="IBusProperty*"/>
21118
21173
</instance-parameter>
21119
21174
<parameter name="visible" transfer-ownership="none">
21120
<doc xml:whitespace="preserve">Whether the #IBusProperty is visible.</doc>
21175
<doc xml:space="preserve">Whether the #IBusProperty is visible.</doc>
21121
21176
<type name="gboolean" c:type="gboolean"/>
21123
21178
</parameters>
21125
21180
<method name="update" c:identifier="ibus_property_update">
21126
<doc xml:whitespace="preserve">Update the content of an #IBusProperty.
21181
<doc xml:space="preserve">Update the content of an #IBusProperty.
21127
21182
#IBusProperty @prop_update can either be sub-property of @prop,
21128
21183
or holds new values for @prop.</doc>
21129
21184
<return-value transfer-ownership="none">
21130
<doc xml:whitespace="preserve">TRUE for update suceeded; FALSE otherwise.</doc>
21185
<doc xml:space="preserve">TRUE for update suceeded; FALSE otherwise.</doc>
21131
21186
<type name="gboolean" c:type="gboolean"/>
21132
21187
</return-value>
21134
21189
<instance-parameter name="prop" transfer-ownership="none">
21135
<doc xml:whitespace="preserve">An #IBusProperty.</doc>
21190
<doc xml:space="preserve">An #IBusProperty.</doc>
21136
21191
<type name="Property" c:type="IBusProperty*"/>
21137
21192
</instance-parameter>
21138
21193
<parameter name="prop_update" transfer-ownership="none">
21139
<doc xml:whitespace="preserve">#IBusPropList that contains sub IBusProperties.</doc>
21194
<doc xml:space="preserve">#IBusPropList that contains sub IBusProperties.</doc>
21140
21195
<type name="Property" c:type="IBusProperty*"/>
21142
21197
</parameters>
21379
21437
glib:type-name="IBusRegistry"
21380
21438
glib:get-type="ibus_registry_get_type"
21381
21439
glib:type-struct="RegistryClass">
21382
<doc xml:whitespace="preserve">An #IBusRegistry loads IBus component files and generates the cache files.
21440
<doc xml:space="preserve">An #IBusRegistry loads IBus component files and generates the cache files.
21384
21442
see_also: #IBusComponent</doc>
21385
21443
<constructor name="new" c:identifier="ibus_registry_new">
21386
<doc xml:whitespace="preserve">New a #IBusRegistry</doc>
21444
<doc xml:space="preserve">New a #IBusRegistry</doc>
21387
21445
<return-value transfer-ownership="none">
21388
<doc xml:whitespace="preserve">A newly allocated #IBusRegistry.</doc>
21446
<doc xml:space="preserve">A newly allocated #IBusRegistry.</doc>
21389
21447
<type name="Registry" c:type="IBusRegistry*"/>
21390
21448
</return-value>
21391
21449
</constructor>
21392
21450
<method name="check_modification"
21393
21451
c:identifier="ibus_registry_check_modification">
21394
<doc xml:whitespace="preserve">Check if the registry is updated.</doc>
21452
<doc xml:space="preserve">Check if the registry is updated.</doc>
21395
21453
<return-value transfer-ownership="none">
21396
<doc xml:whitespace="preserve">%TRUE if mtime is changed; %FALSE otherwise.</doc>
21454
<doc xml:space="preserve">%TRUE if mtime is changed; %FALSE otherwise.</doc>
21397
21455
<type name="gboolean" c:type="gboolean"/>
21398
21456
</return-value>
21400
21458
<instance-parameter name="registry" transfer-ownership="none">
21401
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21459
<doc xml:space="preserve">An #IBusRegistry.</doc>
21402
21460
<type name="Registry" c:type="IBusRegistry*"/>
21403
21461
</instance-parameter>
21404
21462
</parameters>
21406
21464
<method name="get_components"
21407
21465
c:identifier="ibus_registry_get_components">
21408
<doc xml:whitespace="preserve">List components.</doc>
21466
<doc xml:space="preserve">List components.</doc>
21409
21467
<return-value transfer-ownership="container">
21410
<doc xml:whitespace="preserve">a list of #IBusComponent objects. The caller has to call g_list_free() for the returned list.</doc>
21468
<doc xml:space="preserve">a list of #IBusComponent objects. The caller has to call g_list_free() for the returned list.</doc>
21411
21469
<type name="GLib.List" c:type="GList*">
21412
21470
<type name="Component"/>
21414
21472
</return-value>
21416
21474
<instance-parameter name="registry" transfer-ownership="none">
21417
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21475
<doc xml:space="preserve">An #IBusRegistry.</doc>
21418
21476
<type name="Registry" c:type="IBusRegistry*"/>
21419
21477
</instance-parameter>
21420
21478
</parameters>
21422
21480
<method name="get_observed_paths"
21423
21481
c:identifier="ibus_registry_get_observed_paths">
21424
<doc xml:whitespace="preserve">List observed paths.</doc>
21482
<doc xml:space="preserve">List observed paths.</doc>
21425
21483
<return-value transfer-ownership="container">
21426
<doc xml:whitespace="preserve">a list of #IBusObservedPath objects. The caller has to call g_list_free() for the returned list.</doc>
21484
<doc xml:space="preserve">a list of #IBusObservedPath objects. The caller has to call g_list_free() for the returned list.</doc>
21427
21485
<type name="GLib.List" c:type="GList*">
21428
21486
<type name="ObservedPath"/>
21430
21488
</return-value>
21432
21490
<instance-parameter name="registry" transfer-ownership="none">
21433
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21491
<doc xml:space="preserve">An #IBusRegistry.</doc>
21434
21492
<type name="Registry" c:type="IBusRegistry*"/>
21435
21493
</instance-parameter>
21436
21494
</parameters>
21438
21496
<method name="load" c:identifier="ibus_registry_load">
21439
<doc xml:whitespace="preserve">Read all XML files in a IBus component directory (typically
21497
<doc xml:space="preserve">Read all XML files in a IBus component directory (typically
21440
21498
/usr/share/ibus/component/ *.xml) and update the registry object.
21441
21499
IBUS_COMPONENT_PATH environment valuable is also available for
21442
21500
the custom component directories, whose delimiter is ':'.</doc>
21445
21503
</return-value>
21447
21505
<instance-parameter name="registry" transfer-ownership="none">
21448
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21506
<doc xml:space="preserve">An #IBusRegistry.</doc>
21449
21507
<type name="Registry" c:type="IBusRegistry*"/>
21450
21508
</instance-parameter>
21451
21509
</parameters>
21453
21511
<method name="load_cache" c:identifier="ibus_registry_load_cache">
21454
<doc xml:whitespace="preserve">Load the user or system registry cache.</doc>
21512
<doc xml:space="preserve">Load the user or system registry cache.</doc>
21455
21513
<return-value transfer-ownership="none">
21456
<doc xml:whitespace="preserve">%TRUE if the cache exists and is loaded successfully, %FALSE otherwise.</doc>
21514
<doc xml:space="preserve">%TRUE if the cache exists and is loaded successfully, %FALSE otherwise.</doc>
21457
21515
<type name="gboolean" c:type="gboolean"/>
21458
21516
</return-value>
21460
21518
<instance-parameter name="registry" transfer-ownership="none">
21461
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21519
<doc xml:space="preserve">An #IBusRegistry.</doc>
21462
21520
<type name="Registry" c:type="IBusRegistry*"/>
21463
21521
</instance-parameter>
21464
21522
<parameter name="is_user" transfer-ownership="none">
21465
<doc xml:whitespace="preserve">%TRUE if the registry cache is loaded in the user directory.</doc>
21523
<doc xml:space="preserve">%TRUE if the registry cache is loaded in the user directory.</doc>
21466
21524
<type name="gboolean" c:type="gboolean"/>
21468
21526
</parameters>
21470
21528
<method name="load_cache_file"
21471
21529
c:identifier="ibus_registry_load_cache_file">
21472
<doc xml:whitespace="preserve">Load the registry cache @filename.</doc>
21530
<doc xml:space="preserve">Load the registry cache @filename.</doc>
21473
21531
<return-value transfer-ownership="none">
21474
<doc xml:whitespace="preserve">%TRUE if the cache exists and is loaded successfully, %FALSE otherwise.</doc>
21532
<doc xml:space="preserve">%TRUE if the cache exists and is loaded successfully, %FALSE otherwise.</doc>
21475
21533
<type name="gboolean" c:type="gboolean"/>
21476
21534
</return-value>
21478
21536
<instance-parameter name="registry" transfer-ownership="none">
21479
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21537
<doc xml:space="preserve">An #IBusRegistry.</doc>
21480
21538
<type name="Registry" c:type="IBusRegistry*"/>
21481
21539
</instance-parameter>
21482
21540
<parameter name="filename" transfer-ownership="none">
21483
<doc xml:whitespace="preserve">The file path of the registry cache</doc>
21541
<doc xml:space="preserve">The file path of the registry cache</doc>
21484
21542
<type name="utf8" c:type="const gchar*"/>
21486
21544
</parameters>
21488
21546
<method name="load_in_dir" c:identifier="ibus_registry_load_in_dir">
21489
<doc xml:whitespace="preserve">Read all XML files in @dirname, create a #IBusComponent object for each file,
21547
<doc xml:space="preserve">Read all XML files in @dirname, create a #IBusComponent object for each file,
21490
21548
and add the component objects to the registry.
21491
21549
If @dirname is "/usr/share/ibus/component", this API and
21492
21550
ibus_registry_load() are same.</doc>
21495
21553
</return-value>
21497
21555
<instance-parameter name="registry" transfer-ownership="none">
21498
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21556
<doc xml:space="preserve">An #IBusRegistry.</doc>
21499
21557
<type name="Registry" c:type="IBusRegistry*"/>
21500
21558
</instance-parameter>
21501
21559
<parameter name="dirname" transfer-ownership="none">
21502
<doc xml:whitespace="preserve">IBus component directory which includes XML files.</doc>
21560
<doc xml:space="preserve">IBus component directory which includes XML files.</doc>
21503
21561
<type name="utf8" c:type="const gchar*"/>
21505
21563
</parameters>
21507
21565
<method name="output" c:identifier="ibus_registry_output">
21508
<doc xml:whitespace="preserve">Output #IBusRegistry as an XML-formatted string.
21566
<doc xml:space="preserve">Output #IBusRegistry as an XML-formatted string.
21509
21567
The output string can be then shown on the screen or written to file.</doc>
21510
21568
<return-value transfer-ownership="none">
21511
21569
<type name="none" c:type="void"/>
21512
21570
</return-value>
21514
21572
<instance-parameter name="registry" transfer-ownership="none">
21515
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21573
<doc xml:space="preserve">An #IBusRegistry.</doc>
21516
21574
<type name="Registry" c:type="IBusRegistry*"/>
21517
21575
</instance-parameter>
21518
21576
<parameter name="output" transfer-ownership="none">
21519
<doc xml:whitespace="preserve">GString that holds the result.</doc>
21577
<doc xml:space="preserve">GString that holds the result.</doc>
21520
21578
<type name="GLib.String" c:type="GString*"/>
21522
21580
<parameter name="indent" transfer-ownership="none">
21523
<doc xml:whitespace="preserve">level of indent.</doc>
21581
<doc xml:space="preserve">level of indent.</doc>
21524
21582
<type name="gint" c:type="int"/>
21526
21584
</parameters>
21528
21586
<method name="save_cache" c:identifier="ibus_registry_save_cache">
21529
<doc xml:whitespace="preserve">Save the registry in a user directory or system directory.</doc>
21587
<doc xml:space="preserve">Save the registry in a user directory or system directory.</doc>
21530
21588
<return-value transfer-ownership="none">
21531
<doc xml:whitespace="preserve">%TRUE if the cache is saved successfully, %FALSE otherwise.</doc>
21589
<doc xml:space="preserve">%TRUE if the cache is saved successfully, %FALSE otherwise.</doc>
21532
21590
<type name="gboolean" c:type="gboolean"/>
21533
21591
</return-value>
21535
21593
<instance-parameter name="registry" transfer-ownership="none">
21536
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21594
<doc xml:space="preserve">An #IBusRegistry.</doc>
21537
21595
<type name="Registry" c:type="IBusRegistry*"/>
21538
21596
</instance-parameter>
21539
21597
<parameter name="is_user" transfer-ownership="none">
21540
<doc xml:whitespace="preserve">%TRUE if the registry cache is saved in the user directory.</doc>
21598
<doc xml:space="preserve">%TRUE if the registry cache is saved in the user directory.</doc>
21541
21599
<type name="gboolean" c:type="gboolean"/>
21543
21601
</parameters>
21545
21603
<method name="save_cache_file"
21546
21604
c:identifier="ibus_registry_save_cache_file">
21547
<doc xml:whitespace="preserve">Save the registry cache @filename.</doc>
21605
<doc xml:space="preserve">Save the registry cache @filename.</doc>
21548
21606
<return-value transfer-ownership="none">
21549
<doc xml:whitespace="preserve">%TRUE if the cache is saved successfully, %FALSE otherwise.</doc>
21607
<doc xml:space="preserve">%TRUE if the cache is saved successfully, %FALSE otherwise.</doc>
21550
21608
<type name="gboolean" c:type="gboolean"/>
21551
21609
</return-value>
21553
21611
<instance-parameter name="registry" transfer-ownership="none">
21554
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21612
<doc xml:space="preserve">An #IBusRegistry.</doc>
21555
21613
<type name="Registry" c:type="IBusRegistry*"/>
21556
21614
</instance-parameter>
21557
21615
<parameter name="filename" transfer-ownership="none">
21558
<doc xml:whitespace="preserve">The file path of the registry cache</doc>
21616
<doc xml:space="preserve">The file path of the registry cache</doc>
21559
21617
<type name="utf8" c:type="const gchar*"/>
21561
21619
</parameters>
21563
21621
<method name="start_monitor_changes"
21564
21622
c:identifier="ibus_registry_start_monitor_changes">
21565
<doc xml:whitespace="preserve">Start to monitor observed paths.</doc>
21623
<doc xml:space="preserve">Start to monitor observed paths.</doc>
21566
21624
<return-value transfer-ownership="none">
21567
21625
<type name="none" c:type="void"/>
21568
21626
</return-value>
21570
21628
<instance-parameter name="registry" transfer-ownership="none">
21571
<doc xml:whitespace="preserve">An #IBusRegistry.</doc>
21629
<doc xml:space="preserve">An #IBusRegistry.</doc>
21572
21630
<type name="Registry" c:type="IBusRegistry*"/>
21573
21631
</instance-parameter>
21574
21632
</parameters>
21793
21851
</parameters>
21794
21852
</virtual-method>
21795
21853
<method name="copy" c:identifier="ibus_serializable_copy">
21796
<doc xml:whitespace="preserve">Clone an #IBusSerializable.
21854
<doc xml:space="preserve">Clone an #IBusSerializable.
21797
21855
The copy method should be implemented in extended class.
21799
21857
See also: IBusSerializableCopyFunc().</doc>
21800
21858
<return-value transfer-ownership="none">
21801
<doc xml:whitespace="preserve">A newly allocated clone object; or %NULL if @object is not serializable.</doc>
21859
<doc xml:space="preserve">A newly allocated clone object; or %NULL if @object is not serializable.</doc>
21802
21860
<type name="Serializable" c:type="IBusSerializable*"/>
21803
21861
</return-value>
21805
21863
<instance-parameter name="serializable" transfer-ownership="none">
21806
<doc xml:whitespace="preserve">An #IBusSerializable.</doc>
21864
<doc xml:space="preserve">An #IBusSerializable.</doc>
21807
21865
<type name="Serializable" c:type="IBusSerializable*"/>
21808
21866
</instance-parameter>
21809
21867
</parameters>
21811
21869
<method name="get_qattachment"
21812
21870
c:identifier="ibus_serializable_get_qattachment">
21813
<doc xml:whitespace="preserve">Get a value from attachment of an #IBusSerializable.
21871
<doc xml:space="preserve">Get a value from attachment of an #IBusSerializable.
21814
21872
See also: ibus_serializable_set_attachment().</doc>
21815
21873
<return-value transfer-ownership="full">
21816
<doc xml:whitespace="preserve">The attached value; or %NULL if fail to retrieve the value.</doc>
21874
<doc xml:space="preserve">The attached value; or %NULL if fail to retrieve the value.</doc>
21817
21875
<type name="GLib.Variant" c:type="GVariant*"/>
21818
21876
</return-value>
21820
21878
<instance-parameter name="serializable" transfer-ownership="none">
21821
<doc xml:whitespace="preserve">An #IBusSerializable.</doc>
21879
<doc xml:space="preserve">An #IBusSerializable.</doc>
21822
21880
<type name="Serializable" c:type="IBusSerializable*"/>
21823
21881
</instance-parameter>
21824
21882
<parameter name="key" transfer-ownership="none">
21825
<doc xml:whitespace="preserve">String formatted key for indexing value.</doc>
21883
<doc xml:space="preserve">String formatted key for indexing value.</doc>
21826
21884
<type name="GLib.Quark" c:type="GQuark"/>
21828
21886
</parameters>
21830
21888
<method name="remove_qattachment"
21831
21889
c:identifier="ibus_serializable_remove_qattachment">
21832
<doc xml:whitespace="preserve">Remove a value from attachment of an #IBusSerializable.
21890
<doc xml:space="preserve">Remove a value from attachment of an #IBusSerializable.
21833
21891
See also: ibus_serializable_remove_attachment().</doc>
21834
21892
<return-value transfer-ownership="none">
21835
21893
<type name="none" c:type="void"/>
21836
21894
</return-value>
21838
21896
<instance-parameter name="serializable" transfer-ownership="none">
21839
<doc xml:whitespace="preserve">An #IBusSerializable.</doc>
21897
<doc xml:space="preserve">An #IBusSerializable.</doc>
21840
21898
<type name="Serializable" c:type="IBusSerializable*"/>
21841
21899
</instance-parameter>
21842
21900
<parameter name="key" transfer-ownership="none">
21843
<doc xml:whitespace="preserve">String formatted key for indexing value.</doc>
21901
<doc xml:space="preserve">String formatted key for indexing value.</doc>
21844
21902
<type name="GLib.Quark" c:type="GQuark"/>
21846
21904
</parameters>
21848
21906
<method name="serialize" c:identifier="ibus_serializable_serialize">
21849
<doc xml:whitespace="preserve">Serialize an #IBusSerializable to a #GVariant.
21907
<doc xml:space="preserve">Serialize an #IBusSerializable to a #GVariant.
21850
21908
The serialize method should be implemented in extended class.
21852
21910
See also: IBusSerializableCopyFunc().</doc>
21853
21911
<return-value transfer-ownership="full">
21854
<doc xml:whitespace="preserve">A #GVariant.</doc>
21912
<doc xml:space="preserve">A #GVariant.</doc>
21855
21913
<type name="GLib.Variant" c:type="GVariant*"/>
21856
21914
</return-value>
21858
21916
<instance-parameter name="serializable" transfer-ownership="none">
21859
<doc xml:whitespace="preserve">An #IBusSerializable.</doc>
21917
<doc xml:space="preserve">An #IBusSerializable.</doc>
21860
21918
<type name="Serializable" c:type="IBusSerializable*"/>
21861
21919
</instance-parameter>
21862
21920
</parameters>
21864
21922
<method name="set_qattachment"
21865
21923
c:identifier="ibus_serializable_set_qattachment">
21866
<doc xml:whitespace="preserve">Attach a value to an #IBusSerializable. If the value is floating,
21924
<doc xml:space="preserve">Attach a value to an #IBusSerializable. If the value is floating,
21867
21925
the serializable will take the ownership.
21869
21927
See also: ibus_serializable_set_attachment().</doc>
22148
22206
</parameters>
22150
22208
<method name="get_connection" c:identifier="ibus_service_get_connection">
22151
<doc xml:whitespace="preserve">Returns a connections.</doc>
22209
<doc xml:space="preserve">Returns a connections.</doc>
22152
22210
<return-value transfer-ownership="none">
22153
<doc xml:whitespace="preserve">A #GDBusConnection of an #IBusService instance.</doc>
22211
<doc xml:space="preserve">A #GDBusConnection of an #IBusService instance.</doc>
22154
22212
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
22155
22213
</return-value>
22157
22215
<instance-parameter name="service" transfer-ownership="none">
22158
<doc xml:whitespace="preserve">An IBusService.</doc>
22216
<doc xml:space="preserve">An IBusService.</doc>
22159
22217
<type name="Service" c:type="IBusService*"/>
22160
22218
</instance-parameter>
22161
22219
</parameters>
22163
22221
<method name="get_object_path"
22164
22222
c:identifier="ibus_service_get_object_path">
22165
<doc xml:whitespace="preserve">Returns the object path of an IBusService.</doc>
22223
<doc xml:space="preserve">Returns the object path of an IBusService.</doc>
22166
22224
<return-value transfer-ownership="none">
22167
<doc xml:whitespace="preserve">The object path of @service</doc>
22225
<doc xml:space="preserve">The object path of @service</doc>
22168
22226
<type name="utf8" c:type="const gchar*"/>
22169
22227
</return-value>
22171
22229
<instance-parameter name="service" transfer-ownership="none">
22172
<doc xml:whitespace="preserve">An IBusService.</doc>
22230
<doc xml:space="preserve">An IBusService.</doc>
22173
22231
<type name="Service" c:type="IBusService*"/>
22174
22232
</instance-parameter>
22175
22233
</parameters>
22177
22235
<method name="register" c:identifier="ibus_service_register" throws="1">
22178
<doc xml:whitespace="preserve">Registers service to a connection.</doc>
22236
<doc xml:space="preserve">Registers service to a connection.</doc>
22179
22237
<return-value transfer-ownership="none">
22180
<doc xml:whitespace="preserve">TRUE if the service was registered, FALSE otherwise.</doc>
22238
<doc xml:space="preserve">TRUE if the service was registered, FALSE otherwise.</doc>
22181
22239
<type name="gboolean" c:type="gboolean"/>
22182
22240
</return-value>
22184
22242
<instance-parameter name="service" transfer-ownership="none">
22185
<doc xml:whitespace="preserve">An IBusService.</doc>
22243
<doc xml:space="preserve">An IBusService.</doc>
22186
22244
<type name="Service" c:type="IBusService*"/>
22187
22245
</instance-parameter>
22188
22246
<parameter name="connection" transfer-ownership="none">
22189
<doc xml:whitespace="preserve">A GDBusConnection the service will be registered to.</doc>
22247
<doc xml:space="preserve">A GDBusConnection the service will be registered to.</doc>
22190
22248
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
22192
22250
</parameters>
22194
22252
<method name="unregister" c:identifier="ibus_service_unregister">
22195
<doc xml:whitespace="preserve">Unregisters service from a connection.</doc>
22253
<doc xml:space="preserve">Unregisters service from a connection.</doc>
22196
22254
<return-value transfer-ownership="none">
22197
22255
<type name="none" c:type="void"/>
22198
22256
</return-value>
22200
22258
<instance-parameter name="service" transfer-ownership="none">
22201
<doc xml:whitespace="preserve">An IBusService.</doc>
22259
<doc xml:space="preserve">An IBusService.</doc>
22202
22260
<type name="Service" c:type="IBusService*"/>
22203
22261
</instance-parameter>
22204
22262
<parameter name="connection" transfer-ownership="none">
22205
<doc xml:whitespace="preserve">A GDBusConnection the service was registered with.</doc>
22263
<doc xml:space="preserve">A GDBusConnection the service was registered with.</doc>
22206
22264
<type name="Gio.DBusConnection" c:type="GDBusConnection*"/>
22208
22266
</parameters>
22446
22506
<constructor name="new_from_static_string"
22447
22507
c:identifier="ibus_text_new_from_static_string"
22448
22508
introspectable="0">
22449
<doc xml:whitespace="preserve">New an IBusText from a static string.
22509
<doc xml:space="preserve">New an IBusText from a static string.
22451
22511
Since @str is a static string which won't be freed.
22452
22512
This function will NOT duplicate @str.</doc>
22453
22513
<return-value transfer-ownership="none">
22454
<doc xml:whitespace="preserve">A newly allocated IBusText.</doc>
22514
<doc xml:space="preserve">A newly allocated IBusText.</doc>
22455
22515
<type name="Text" c:type="IBusText*"/>
22456
22516
</return-value>
22458
22518
<parameter name="str" transfer-ownership="none">
22459
<doc xml:whitespace="preserve">An text string to be set.</doc>
22519
<doc xml:space="preserve">An text string to be set.</doc>
22460
22520
<type name="utf8" c:type="const gchar*"/>
22462
22522
</parameters>
22463
22523
</constructor>
22464
22524
<constructor name="new_from_string"
22465
22525
c:identifier="ibus_text_new_from_string">
22466
<doc xml:whitespace="preserve">New an IBusText from a string.
22526
<doc xml:space="preserve">New an IBusText from a string.
22468
22528
@str will be duplicated in IBusText, so feel free to free @str after this function.</doc>
22469
22529
<return-value transfer-ownership="none">
22470
<doc xml:whitespace="preserve">A newly allocated IBusText.</doc>
22530
<doc xml:space="preserve">A newly allocated IBusText.</doc>
22471
22531
<type name="Text" c:type="IBusText*"/>
22472
22532
</return-value>
22474
22534
<parameter name="str" transfer-ownership="none">
22475
<doc xml:whitespace="preserve">An text string to be set.</doc>
22535
<doc xml:space="preserve">An text string to be set.</doc>
22476
22536
<type name="utf8" c:type="const gchar*"/>
22478
22538
</parameters>
22479
22539
</constructor>
22480
22540
<constructor name="new_from_ucs4" c:identifier="ibus_text_new_from_ucs4">
22481
<doc xml:whitespace="preserve">New an IBusText from an UCS-4 encoded string.
22541
<doc xml:space="preserve">New an IBusText from an UCS-4 encoded string.
22483
22543
@str will be duplicated in IBusText, so feel free to free @str after this function.</doc>
22484
22544
<return-value transfer-ownership="none">
22485
<doc xml:whitespace="preserve">A newly allocated IBusText.</doc>
22545
<doc xml:space="preserve">A newly allocated IBusText.</doc>
22486
22546
<type name="Text" c:type="IBusText*"/>
22487
22547
</return-value>
22489
22549
<parameter name="str" transfer-ownership="none">
22490
<doc xml:whitespace="preserve">An text string to be set.</doc>
22550
<doc xml:space="preserve">An text string to be set.</doc>
22491
22551
<type name="gunichar" c:type="const gunichar*"/>
22493
22553
</parameters>
22494
22554
</constructor>
22495
22555
<constructor name="new_from_unichar"
22496
22556
c:identifier="ibus_text_new_from_unichar">
22497
<doc xml:whitespace="preserve">New an IBusText from a single UCS4-encoded character.</doc>
22557
<doc xml:space="preserve">New an IBusText from a single UCS4-encoded character.</doc>
22498
22558
<return-value transfer-ownership="none">
22499
<doc xml:whitespace="preserve">A newly allocated IBusText.</doc>
22559
<doc xml:space="preserve">A newly allocated IBusText.</doc>
22500
22560
<type name="Text" c:type="IBusText*"/>
22501
22561
</return-value>
22503
22563
<parameter name="c" transfer-ownership="none">
22504
<doc xml:whitespace="preserve">A single UCS4-encoded character.</doc>
22564
<doc xml:space="preserve">A single UCS4-encoded character.</doc>
22505
22565
<type name="gunichar" c:type="gunichar"/>
22507
22567
</parameters>
22508
22568
</constructor>
22509
22569
<method name="append_attribute"
22510
22570
c:identifier="ibus_text_append_attribute">
22511
<doc xml:whitespace="preserve">Append an IBusAttribute for IBusText.</doc>
22571
<doc xml:space="preserve">Append an IBusAttribute for IBusText.</doc>
22512
22572
<return-value transfer-ownership="none">
22513
22573
<type name="none" c:type="void"/>
22514
22574
</return-value>
22516
22576
<instance-parameter name="text" transfer-ownership="none">
22517
<doc xml:whitespace="preserve">an IBusText</doc>
22577
<doc xml:space="preserve">an IBusText</doc>
22518
22578
<type name="Text" c:type="IBusText*"/>
22519
22579
</instance-parameter>
22520
22580
<parameter name="type" transfer-ownership="none">
22521
<doc xml:whitespace="preserve">IBusAttributeType for @text.</doc>
22581
<doc xml:space="preserve">IBusAttributeType for @text.</doc>
22522
22582
<type name="guint" c:type="guint"/>
22524
22584
<parameter name="value" transfer-ownership="none">
22525
<doc xml:whitespace="preserve">Value for the type.</doc>
22585
<doc xml:space="preserve">Value for the type.</doc>
22526
22586
<type name="guint" c:type="guint"/>
22528
22588
<parameter name="start_index" transfer-ownership="none">
22529
<doc xml:whitespace="preserve">The starting index, inclusive.</doc>
22589
<doc xml:space="preserve">The starting index, inclusive.</doc>
22530
22590
<type name="guint" c:type="guint"/>
22532
22592
<parameter name="end_index" transfer-ownership="none">
22533
<doc xml:whitespace="preserve">The ending index, exclusive.</doc>
22593
<doc xml:space="preserve">The ending index, exclusive.</doc>
22534
22594
<type name="gint" c:type="gint"/>
22536
22596
</parameters>
22538
22598
<method name="get_attributes" c:identifier="ibus_text_get_attributes">
22539
<doc xml:whitespace="preserve">Return the attributes in an IBusText. Should not be freed.</doc>
22599
<doc xml:space="preserve">Return the attributes in an IBusText. Should not be freed.</doc>
22540
22600
<return-value transfer-ownership="none">
22541
<doc xml:whitespace="preserve">the attrs in @text.</doc>
22601
<doc xml:space="preserve">the attrs in @text.</doc>
22542
22602
<type name="AttrList" c:type="IBusAttrList*"/>
22543
22603
</return-value>
22545
22605
<instance-parameter name="text" transfer-ownership="none">
22546
<doc xml:whitespace="preserve">An IBusText.</doc>
22606
<doc xml:space="preserve">An IBusText.</doc>
22547
22607
<type name="Text" c:type="IBusText*"/>
22548
22608
</instance-parameter>
22549
22609
</parameters>
25191
25251
See also: ibus_write_address().</doc>
25192
25252
<return-value transfer-ownership="none">
25193
<doc xml:whitespace="preserve">D-Bus address of IBus. %NULL for not found.</doc>
25253
<doc xml:space="preserve">D-Bus address of IBus. %NULL for not found.</doc>
25194
25254
<type name="utf8" c:type="const gchar*"/>
25195
25255
</return-value>
25197
25257
<function name="get_daemon_uid"
25198
25258
c:identifier="ibus_get_daemon_uid"
25199
25259
deprecated="This function has been deprecated and should not be used in newly written code.">
25200
<doc xml:whitespace="preserve">Get UID of ibus-daemon.</doc>
25260
<doc xml:space="preserve">Get UID of ibus-daemon.</doc>
25201
25261
<return-value transfer-ownership="none">
25202
<doc xml:whitespace="preserve">UID of ibus-daemon; or 0 if UID is not available.</doc>
25262
<doc xml:space="preserve">UID of ibus-daemon; or 0 if UID is not available.</doc>
25203
25263
<type name="glong" c:type="glong"/>
25204
25264
</return-value>
25206
25266
<function name="get_language_name" c:identifier="ibus_get_language_name">
25207
25267
<return-value transfer-ownership="none">
25208
<doc xml:whitespace="preserve">language name</doc>
25268
<doc xml:space="preserve">language name</doc>
25209
25269
<type name="utf8" c:type="const gchar*"/>
25210
25270
</return-value>
25212
25272
<parameter name="_locale" transfer-ownership="none">
25213
<doc xml:whitespace="preserve">A const locale name.</doc>
25273
<doc xml:space="preserve">A const locale name.</doc>
25214
25274
<type name="utf8" c:type="const gchar*"/>
25216
25276
</parameters>
25218
25278
<function name="get_local_machine_id"
25219
25279
c:identifier="ibus_get_local_machine_id">
25220
<doc xml:whitespace="preserve">Obtains the machine UUID of the machine this process is running on.</doc>
25280
<doc xml:space="preserve">Obtains the machine UUID of the machine this process is running on.</doc>
25221
25281
<return-value transfer-ownership="none">
25222
<doc xml:whitespace="preserve">A newly allocated string that shows the UUID of the machine.</doc>
25282
<doc xml:space="preserve">A newly allocated string that shows the UUID of the machine.</doc>
25223
25283
<type name="utf8" c:type="const gchar*"/>
25224
25284
</return-value>
25226
25286
<function name="get_socket_path" c:identifier="ibus_get_socket_path">
25227
<doc xml:whitespace="preserve">Get the path of socket file.</doc>
25287
<doc xml:space="preserve">Get the path of socket file.</doc>
25228
25288
<return-value transfer-ownership="none">
25229
<doc xml:whitespace="preserve">A newly allocated string that stores the path of socket file.</doc>
25289
<doc xml:space="preserve">A newly allocated string that stores the path of socket file.</doc>
25230
25290
<type name="utf8" c:type="const gchar*"/>
25231
25291
</return-value>
25233
25293
<function name="get_timeout" c:identifier="ibus_get_timeout">
25234
<doc xml:whitespace="preserve">Get the GDBus timeout in milliseconds. The timeout is for clients (e.g. im-ibus.so), not for ibus-daemon.
25294
<doc xml:space="preserve">Get the GDBus timeout in milliseconds. The timeout is for clients (e.g. im-ibus.so), not for ibus-daemon.
25235
25295
Note that the timeout for ibus-daemon could be set by --timeout command line option of the daemon.</doc>
25236
25296
<return-value transfer-ownership="none">
25237
<doc xml:whitespace="preserve">A GDBus timeout in milliseconds. -1 when default timeout for GDBus should be used.</doc>
25297
<doc xml:space="preserve">A GDBus timeout in milliseconds. -1 when default timeout for GDBus should be used.</doc>
25238
25298
<type name="gint" c:type="gint"/>
25239
25299
</return-value>
25241
25301
<function name="get_user_name" c:identifier="ibus_get_user_name">
25242
<doc xml:whitespace="preserve">Get the current user name.
25302
<doc xml:space="preserve">Get the current user name.
25243
25303
It is determined by:
25244
25304
<orderedlist>
25245
25305
<listitem><para>getlogin()</para></listitem>
25734
25794
<function name="key_event_from_string"
25735
25795
c:identifier="ibus_key_event_from_string">
25736
<doc xml:whitespace="preserve">Parse key event string and return key symbol and modifiers.</doc>
25796
<doc xml:space="preserve">Parse key event string and return key symbol and modifiers.</doc>
25737
25797
<return-value transfer-ownership="none">
25738
<doc xml:whitespace="preserve">TRUE for succeed; FALSE if failed.</doc>
25798
<doc xml:space="preserve">TRUE for succeed; FALSE if failed.</doc>
25739
25799
<type name="gboolean" c:type="gboolean"/>
25740
25800
</return-value>
25742
25802
<parameter name="string" transfer-ownership="none">
25743
<doc xml:whitespace="preserve">Key event string.</doc>
25803
<doc xml:space="preserve">Key event string.</doc>
25744
25804
<type name="utf8" c:type="const gchar*"/>
25746
25806
<parameter name="keyval" transfer-ownership="none">
25747
<doc xml:whitespace="preserve">Variable that hold key symbol result.</doc>
25807
<doc xml:space="preserve">Variable that hold key symbol result.</doc>
25748
25808
<type name="guint" c:type="guint*"/>
25750
25810
<parameter name="modifiers" transfer-ownership="none">
25751
<doc xml:whitespace="preserve">Variable that hold modifiers result.</doc>
25811
<doc xml:space="preserve">Variable that hold modifiers result.</doc>
25752
25812
<type name="guint" c:type="guint*"/>
25754
25814
</parameters>
25756
25816
<function name="key_event_to_string"
25757
25817
c:identifier="ibus_key_event_to_string">
25758
<doc xml:whitespace="preserve">Return the name of a key symbol and modifiers.
25818
<doc xml:space="preserve">Return the name of a key symbol and modifiers.
25760
25820
For example, if press ctrl, shift, and enter, then this function returns:
25761
25821
Shift+Control+enter.</doc>
25762
25822
<return-value transfer-ownership="none">
25763
<doc xml:whitespace="preserve">The name of a key symbol and modifier.</doc>
25823
<doc xml:space="preserve">The name of a key symbol and modifier.</doc>
25764
25824
<type name="utf8" c:type="const gchar*"/>
25765
25825
</return-value>
25767
25827
<parameter name="keyval" transfer-ownership="none">
25768
<doc xml:whitespace="preserve">Key symbol.</doc>
25828
<doc xml:space="preserve">Key symbol.</doc>
25769
25829
<type name="guint" c:type="guint"/>
25771
25831
<parameter name="modifiers" transfer-ownership="none">
25772
<doc xml:whitespace="preserve">Modifiers such as Ctrl or Shift.</doc>
25832
<doc xml:space="preserve">Modifiers such as Ctrl or Shift.</doc>
25773
25833
<type name="guint" c:type="guint"/>
25775
25835
</parameters>
25777
25837
<function name="keyval_from_name" c:identifier="ibus_keyval_from_name">
25778
<doc xml:whitespace="preserve">Return the key symbol that associate with the key name.</doc>
25838
<doc xml:space="preserve">Return the key symbol that associate with the key name.</doc>
25779
25839
<return-value transfer-ownership="none">
25780
<doc xml:whitespace="preserve">Corresponding key symbol.</doc>
25840
<doc xml:space="preserve">Corresponding key symbol.</doc>
25781
25841
<type name="guint" c:type="guint"/>
25782
25842
</return-value>
25784
25844
<parameter name="keyval_name" transfer-ownership="none">
25785
<doc xml:whitespace="preserve">Key name in #gdk_keys_by_name.</doc>
25845
<doc xml:space="preserve">Key name in #gdk_keys_by_name.</doc>
25786
25846
<type name="utf8" c:type="const gchar*"/>
25788
25848
</parameters>
25790
25850
<function name="keyval_name" c:identifier="ibus_keyval_name">
25791
<doc xml:whitespace="preserve">Return the name of a key symbol.
25851
<doc xml:space="preserve">Return the name of a key symbol.
25793
25853
Note that the returned string is used internally, so don't free it.</doc>
25794
25854
<return-value transfer-ownership="none">
25795
<doc xml:whitespace="preserve">Corresponding key name. %NULL if no such key symbol.</doc>
25855
<doc xml:space="preserve">Corresponding key name. %NULL if no such key symbol.</doc>
25796
25856
<type name="utf8" c:type="const gchar*"/>
25797
25857
</return-value>
25799
25859
<parameter name="keyval" transfer-ownership="none">
25800
<doc xml:whitespace="preserve">Key symbol.</doc>
25860
<doc xml:space="preserve">Key symbol.</doc>
25801
25861
<type name="guint" c:type="guint"/>
25803
25863
</parameters>
25805
25865
<function name="keyval_to_unicode" c:identifier="ibus_keyval_to_unicode">
25806
<doc xml:whitespace="preserve">Convert from an IBus key symbol to the corresponding ISO10646 (Unicode)
25866
<doc xml:space="preserve">Convert from an IBus key symbol to the corresponding ISO10646 (Unicode)
25807
25867
character.</doc>
25808
25868
<return-value transfer-ownership="none">
25809
<doc xml:whitespace="preserve">the corresponding unicode character, or 0 if there is no corresponding character.</doc>
25869
<doc xml:space="preserve">the corresponding unicode character, or 0 if there is no corresponding character.</doc>
25810
25870
<type name="gunichar" c:type="gunichar"/>
25811
25871
</return-value>
25813
25873
<parameter name="keyval" transfer-ownership="none">
25814
<doc xml:whitespace="preserve">an IBus key symbol</doc>
25874
<doc xml:space="preserve">an IBus key symbol</doc>
25815
25875
<type name="guint" c:type="guint"/>
25817
25877
</parameters>