/usr/share/doc/ibus/html/IBusProperty.html is in ibus-doc 1.5.11-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IBusProperty: IBus Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="IBus Reference Manual">
<link rel="up" href="ch02.html" title="Panel (User Interfaces)">
<link rel="prev" href="IBusPanelService.html" title="IBusPanelService">
<link rel="next" href="IBusPropList.html" title="IBusPropList">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#IBusProperty.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#IBusProperty.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#IBusProperty.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="IBusPanelService.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="IBusPropList.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="IBusProperty"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IBusProperty.top_of_page"></a>IBusProperty</span></h2>
<p>IBusProperty — UI component for input method engine property.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="IBusProperty.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="IBusProperty.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="IBusProperty.html" title="IBusProperty"><span class="returnvalue">IBusProperty</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-new" title="ibus_property_new ()">ibus_property_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusProperty.html" title="IBusProperty"><span class="returnvalue">IBusProperty</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-new-varargs" title="ibus_property_new_varargs ()">ibus_property_new_varargs</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-key" title="ibus_property_get_key ()">ibus_property_get_key</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-label" title="ibus_property_get_label ()">ibus_property_get_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-label" title="ibus_property_set_label ()">ibus_property_set_label</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-symbol" title="ibus_property_get_symbol ()">ibus_property_get_symbol</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-symbol" title="ibus_property_set_symbol ()">ibus_property_set_symbol</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-icon" title="ibus_property_get_icon ()">ibus_property_get_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-icon" title="ibus_property_set_icon ()">ibus_property_set_icon</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-tooltip" title="ibus_property_get_tooltip ()">ibus_property_get_tooltip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-tooltip" title="ibus_property_set_tooltip ()">ibus_property_set_tooltip</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-sensitive" title="ibus_property_get_sensitive ()">ibus_property_get_sensitive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-sensitive" title="ibus_property_set_sensitive ()">ibus_property_set_sensitive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-visible" title="ibus_property_get_visible ()">ibus_property_get_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-visible" title="ibus_property_set_visible ()">ibus_property_set_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="returnvalue">IBusPropType</span></a>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-prop-type" title="ibus_property_get_prop_type ()">ibus_property_get_prop_type</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="returnvalue">IBusPropState</span></a>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-state" title="ibus_property_get_state ()">ibus_property_get_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-state" title="ibus_property_set_state ()">ibus_property_set_state</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="IBusProperty.html#IBusPropList"><span class="returnvalue">IBusPropList</span></a> *
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-get-sub-props" title="ibus_property_get_sub_props ()">ibus_property_get_sub_props</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-set-sub-props" title="ibus_property_set_sub_props ()">ibus_property_set_sub_props</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="IBusProperty.html#ibus-property-update" title="ibus_property_update ()">ibus_property_update</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusProperty.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--icon" title="The “icon” property">icon</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--key" title="The “key” property">key</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--label" title="The “label” property">label</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="type">IBusPropType</span></a></td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--prop-type" title="The “prop-type” property">prop-type</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--sensitive" title="The “sensitive” property">sensitive</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="type">IBusPropState</span></a></td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--state" title="The “state” property">state</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--sub-props" title="The “sub-props” property">sub-props</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--symbol" title="The “symbol” property">symbol</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--tooltip" title="The “tooltip” property">tooltip</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="IBusProperty.html#IBusProperty--visible" title="The “visible” property">visible</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="IBusPropList"></a><div class="refsect1">
<a name="IBusProperty.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType">IBusPropType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState">IBusPropState</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="IBusProperty.html#IBusProperty-struct" title="struct IBusProperty">IBusProperty</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="IBusProperty.html#IBusPropList-struct" title="IBusPropList">IBusPropList</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="IBusProperty.html#IBusPropListClass" title="IBusPropListClass">IBusPropListClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="IBusProperty.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GEnum
<span class="lineart">├──</span> IBusPropState
<span class="lineart">╰──</span> IBusPropType
GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="IBusObject.html" title="IBusObject">IBusObject</a>
<span class="lineart">╰──</span> <a class="link" href="IBusSerializable.html" title="IBusSerializable">IBusSerializable</a>
<span class="lineart">├──</span> IBusPropList
<span class="lineart">╰──</span> IBusProperty
</pre>
</div>
<div class="refsect1">
<a name="IBusProperty.description"></a><h2>Description</h2>
<p>An IBusProperty is an UI component like a button or a menu item
which shows the status of corresponding input method engine property.
End user can operate and see the current status of IME through these components.
For example, ibus-chewing users change the English/Chinese input mode by
pressing ctrl-space or click on the Eng/Chi switch button.
And the IBusProperty shows the change correspondingly.</p>
<p>see_also: <a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a>, <a class="link" href="IBusEngine.html" title="IBusEngine"><span class="type">IBusEngine</span></a></p>
</div>
<div class="refsect1">
<a name="IBusProperty.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ibus-property-new"></a><h3>ibus_property_new ()</h3>
<pre class="programlisting"><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="returnvalue">IBusProperty</span></a> *
ibus_property_new (<em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="type">IBusPropType</span></a> type</code></em>,
<em class="parameter"><code><a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *label</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>,
<em class="parameter"><code><a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *tooltip</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sensitive</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> visible</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="type">IBusPropState</span></a> state</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> *prop_list</code></em>);</pre>
<p>Creates a new <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>Unique Identity for the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>type</p></td>
<td class="parameter_description"><p><a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="type">IBusPropType</span></a> of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>Text shown in UI.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon</p></td>
<td class="parameter_description"><p> Icon file for the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>Message shown if mouse hovered the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sensitive</p></td>
<td class="parameter_description"><p>Whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is sensitive to keyboard and mouse event.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>visible</p></td>
<td class="parameter_description"><p>Whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is visible.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>IBusPropState of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop_list</p></td>
<td class="parameter_description"><p> <a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> that contains sub IBusProperties. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.2.6"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-new-varargs"></a><h3>ibus_property_new_varargs ()</h3>
<pre class="programlisting"><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="returnvalue">IBusProperty</span></a> *
ibus_property_new_varargs (<em class="parameter"><code>const <span class="type">gchar</span> *first_property_name</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>Creates a new <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.
<a class="link" href="IBusProperty.html#ibus-property-new-varargs" title="ibus_property_new_varargs ()"><code class="function">ibus_property_new_varargs()</code></a> supports the va_list format.
name property is required. e.g.
ibus_property_new_varargs("key", "TypingMode", "type", PROP_TYPE_MENU, NULL)</p>
<div class="refsect3">
<a name="id-1.3.8.10.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>first_property_name</p></td>
<td class="parameter_description"><p>Name of the first property.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>the NULL-terminated arguments of the properties and values.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.3.6"></a><h4>Returns</h4>
<p> A newly allocated <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-key"></a><h3>ibus_property_get_key ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ibus_property_get_key (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the key of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.4.6"></a><h4>Returns</h4>
<p> the key of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. Should not be freed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-label"></a><h3>ibus_property_get_label ()</h3>
<pre class="programlisting"><a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
ibus_property_get_label (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the label of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.5.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.5.6"></a><h4>Returns</h4>
<p> the label of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. Should not be freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-label"></a><h3>ibus_property_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_label (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *label</code></em>);</pre>
<p>Set the label of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>label</p></td>
<td class="parameter_description"><p>Text shown in UI.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-symbol"></a><h3>ibus_property_get_symbol ()</h3>
<pre class="programlisting"><a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
ibus_property_get_symbol (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the symbol of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.7.6"></a><h4>Returns</h4>
<p> the symbol of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. Should not be freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-symbol"></a><h3>ibus_property_set_symbol ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_symbol (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *symbol</code></em>);</pre>
<p>Set the symbol of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>symbol</p></td>
<td class="parameter_description"><p>Text shown in UI.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-icon"></a><h3>ibus_property_get_icon ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ibus_property_get_icon (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the icon of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.9.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.9.6"></a><h4>Returns</h4>
<p> the icon of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. Should not be freed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-icon"></a><h3>ibus_property_set_icon ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_icon (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *icon</code></em>);</pre>
<p>Set the icon of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.10.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon</p></td>
<td class="parameter_description"><p>Icon shown in UI. It could be a full path of an icon file or an icon name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-tooltip"></a><h3>ibus_property_get_tooltip ()</h3>
<pre class="programlisting"><a class="link" href="IBusText.html" title="IBusText"><span class="returnvalue">IBusText</span></a> *
ibus_property_get_tooltip (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the tooltip of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.11.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.11.6"></a><h4>Returns</h4>
<p> the tooltip of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. Should not be freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-tooltip"></a><h3>ibus_property_set_tooltip ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_tooltip (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *tooltip</code></em>);</pre>
<p>Set the tooltip of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.12.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tooltip</p></td>
<td class="parameter_description"><p>Text of the tooltip.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-sensitive"></a><h3>ibus_property_get_sensitive ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_property_get_sensitive (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the sensitive of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.13.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.13.6"></a><h4>Returns</h4>
<p> the sensitive of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-sensitive"></a><h3>ibus_property_set_sensitive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_sensitive (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> sensitive</code></em>);</pre>
<p>Set whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is sensitive.</p>
<div class="refsect3">
<a name="id-1.3.8.10.14.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>sensitive</p></td>
<td class="parameter_description"><p>Whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is sensitive.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-visible"></a><h3>ibus_property_get_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_property_get_visible (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the visible of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.15.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.15.6"></a><h4>Returns</h4>
<p> the visible of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-visible"></a><h3>ibus_property_set_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_visible (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> visible</code></em>);</pre>
<p>Set whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is visible.</p>
<div class="refsect3">
<a name="id-1.3.8.10.16.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>visible</p></td>
<td class="parameter_description"><p>Whether the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> is visible.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-prop-type"></a><h3>ibus_property_get_prop_type ()</h3>
<pre class="programlisting"><a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="returnvalue">IBusPropType</span></a>
ibus_property_get_prop_type (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-state"></a><h3>ibus_property_get_state ()</h3>
<pre class="programlisting"><a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="returnvalue">IBusPropState</span></a>
ibus_property_get_state (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the state of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.18.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.18.6"></a><h4>Returns</h4>
<p> the state of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-state"></a><h3>ibus_property_set_state ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_state (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="type">IBusPropState</span></a> state</code></em>);</pre>
<p>Set the state of the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.19.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>state</p></td>
<td class="parameter_description"><p>The state of the <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-get-sub-props"></a><h3>ibus_property_get_sub_props ()</h3>
<pre class="programlisting"><a class="link" href="IBusProperty.html#IBusPropList"><span class="returnvalue">IBusPropList</span></a> *
ibus_property_get_sub_props (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>);</pre>
<p>Get the IBusPropList of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.10.20.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.20.6"></a><h4>Returns</h4>
<p> the IBusPropList of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.
Should not be freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-set-sub-props"></a><h3>ibus_property_set_sub_props ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ibus_property_set_sub_props (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> *prop_list</code></em>);</pre>
<p>Set the sub IBusProperties.</p>
<div class="refsect3">
<a name="id-1.3.8.10.21.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop_list</p></td>
<td class="parameter_description"><p><a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> that contains sub IBusProperties.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ibus-property-update"></a><h3>ibus_property_update ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ibus_property_update (<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop</code></em>,
<em class="parameter"><code><a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> *prop_update</code></em>);</pre>
<p>Update the content of an <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.
<a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a> <em class="parameter"><code>prop_update</code></em>
can either be sub-property of <em class="parameter"><code>prop</code></em>
,
or holds new values for <em class="parameter"><code>prop</code></em>
.</p>
<div class="refsect3">
<a name="id-1.3.8.10.22.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>prop</p></td>
<td class="parameter_description"><p>An <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prop_update</p></td>
<td class="parameter_description"><p><a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> that contains sub IBusProperties.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.3.8.10.22.6"></a><h4>Returns</h4>
<p> TRUE for update suceeded; FALSE otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="IBusProperty.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="IBusPropType"></a><h3>enum IBusPropType</h3>
<p>Type enumeration of IBusProperty.</p>
<div class="refsect3">
<a name="id-1.3.8.11.2.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="PROP-TYPE-NORMAL:CAPS"></a>PROP_TYPE_NORMAL</p></td>
<td class="enum_member_description">
<p>Property is shown as normal text.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-TYPE-TOGGLE:CAPS"></a>PROP_TYPE_TOGGLE</p></td>
<td class="enum_member_description">
<p>Property is shown as a toggle button.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-TYPE-RADIO:CAPS"></a>PROP_TYPE_RADIO</p></td>
<td class="enum_member_description">
<p>Property is shown as a radio selection option.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-TYPE-MENU:CAPS"></a>PROP_TYPE_MENU</p></td>
<td class="enum_member_description">
<p>Property is shown as a menu, usually imply it has sub menu
items.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-TYPE-SEPARATOR:CAPS"></a>PROP_TYPE_SEPARATOR</p></td>
<td class="enum_member_description">
<p>A separator for menu.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="IBusPropState"></a><h3>enum IBusPropState</h3>
<p>State of <a class="link" href="IBusProperty.html" title="IBusProperty"><span class="type">IBusProperty</span></a>. The actual effect depends on <a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="type">IBusPropType</span></a> of the
IBusProperty.</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">PROP_TYPE_TOGGLE</span></p></td>
<td><p>Emphasized if PROP_STATE_CHECKED, normal otherwise.</p></td>
</tr>
<tr>
<td><p><span class="term">PROP_TYPE_RADIO</span></p></td>
<td><p>Option checked if PROP_STATE_CHECKED, unchecked otherwise.</p></td>
</tr>
</tbody>
</table></div>
<p>No effect on other types.</p>
<div class="refsect3">
<a name="id-1.3.8.11.3.6"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="PROP-STATE-UNCHECKED:CAPS"></a>PROP_STATE_UNCHECKED</p></td>
<td class="enum_member_description">
<p>Property option is unchecked.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-STATE-CHECKED:CAPS"></a>PROP_STATE_CHECKED</p></td>
<td class="enum_member_description">
<p>Property option is checked.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="PROP-STATE-INCONSISTENT:CAPS"></a>PROP_STATE_INCONSISTENT</p></td>
<td class="enum_member_description">
<p>The state is inconsistent with the associated IME
property.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty-struct"></a><h3>struct IBusProperty</h3>
<pre class="programlisting">struct IBusProperty;</pre>
</div>
<hr>
<div class="refsect2">
<a name="IBusPropList-struct"></a><h3>IBusPropList</h3>
<pre class="programlisting">typedef struct {
GArray *properties;
} IBusPropList;
</pre>
<p>An array of IBusProperties.</p>
<div class="refsect3">
<a name="id-1.3.8.11.5.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">GArray</span> *<em class="structfield"><code><a name="IBusPropList-struct.properties"></a>properties</code></em>;</p></td>
<td class="struct_member_description"><p>GArray that holds IBusProperties.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="IBusPropListClass"></a><h3>IBusPropListClass</h3>
<pre class="programlisting">typedef struct {
IBusSerializableClass parent;
} IBusPropListClass;
</pre>
<p>Class structure for <a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a>.</p>
<div class="refsect3">
<a name="id-1.3.8.11.6.5"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody><tr>
<td class="struct_member_name"><p><span class="type">IBusSerializableClass</span> <em class="structfield"><code><a name="IBusPropListClass.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>The parent class.</p></td>
<td class="struct_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="IBusProperty.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="IBusProperty--icon"></a><h3>The <code class="literal">“icon”</code> property</h3>
<pre class="programlisting"> “icon” <span class="type">gchar</span> *</pre>
<p>The icon of property.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--key"></a><h3>The <code class="literal">“key”</code> property</h3>
<pre class="programlisting"> “key” <span class="type">gchar</span> *</pre>
<p>The key of property.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: ""</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--label"></a><h3>The <code class="literal">“label”</code> property</h3>
<pre class="programlisting"> “label” <a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</pre>
<p>The label of property.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--prop-type"></a><h3>The <code class="literal">“prop-type”</code> property</h3>
<pre class="programlisting"> “prop-type” <a class="link" href="IBusProperty.html#IBusPropType" title="enum IBusPropType"><span class="type">IBusPropType</span></a></pre>
<p>The type of property.</p>
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: PROP_TYPE_NORMAL</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--sensitive"></a><h3>The <code class="literal">“sensitive”</code> property</h3>
<pre class="programlisting"> “sensitive” <span class="type">gboolean</span></pre>
<p>The sensitive of property.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--state"></a><h3>The <code class="literal">“state”</code> property</h3>
<pre class="programlisting"> “state” <a class="link" href="IBusProperty.html#IBusPropState" title="enum IBusPropState"><span class="type">IBusPropState</span></a></pre>
<p>The state of property.</p>
<p>Flags: Read / Write</p>
<p>Default value: PROP_STATE_UNCHECKED</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--sub-props"></a><h3>The <code class="literal">“sub-props”</code> property</h3>
<pre class="programlisting"> “sub-props” <a class="link" href="IBusProperty.html#IBusPropList"><span class="type">IBusPropList</span></a> *</pre>
<p>The sub properties of property.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--symbol"></a><h3>The <code class="literal">“symbol”</code> property</h3>
<pre class="programlisting"> “symbol” <a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</pre>
<p>The symbol of property.</p>
<p>Flags: Read / Write / Construct</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--tooltip"></a><h3>The <code class="literal">“tooltip”</code> property</h3>
<pre class="programlisting"> “tooltip” <a class="link" href="IBusText.html" title="IBusText"><span class="type">IBusText</span></a> *</pre>
<p>The tooltip of property.</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="IBusProperty--visible"></a><h3>The <code class="literal">“visible”</code> property</h3>
<pre class="programlisting"> “visible” <span class="type">gboolean</span></pre>
<p>The visible of property.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|