/usr/share/gir-1.0/HudClient-2.gir is in libhud-client2-dev 14.10+16.04.20160415-0ubuntu1.
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 | <?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Dee" version="1.0"/>
<include name="GObject" version="2.0"/>
<package name="hud-client-2"/>
<c:include name="hud-client.h"/>
<namespace name="HudClient"
version="2"
shared-library="libhud-client.so.2"
c:identifier-prefixes="HudClient"
c:symbol-prefixes="hud_client">
<constant name="CONNECTION_SIGNAL_CONNECTION_STATUS"
value="connection-status"
c:type="HUD_CLIENT_CONNECTION_SIGNAL_CONNECTION_STATUS">
<doc xml:space="preserve">Signal to notify on a change in the connection status</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="Connection"
c:symbol-prefix="connection"
c:type="HudClientConnection"
parent="GObject.Object"
glib:type-name="HudClientConnection"
glib:get-type="hud_client_connection_get_type"
glib:type-struct="ConnectionClass">
<doc xml:space="preserve">Object to make a generic connection to a HUD service. For the most
part people should just create a #HudClientQuery and that'll use the
default HUD service. For most folks that should be enough.</doc>
<constructor name="new" c:identifier="hud_client_connection_new">
<doc xml:space="preserve">Builds a HUD Connection object that can be used to connect to a
custom HUD service. For the most part, this should only be used
in testing, though there might be other uses. It is likely if you're
using this function you'd also be interested in
hud_client_query_new_for_connection()</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #HudClientConnection</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</return-value>
<parameters>
<parameter name="dbus_address" transfer-ownership="none">
<doc xml:space="preserve">Address on DBus for the HUD service</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="dbus_path" transfer-ownership="none">
<doc xml:space="preserve">Path to the object to create stuff</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<function name="get_ref" c:identifier="hud_client_connection_get_ref">
<doc xml:space="preserve">Gets a reference to the default object that connects to the
default HUD service.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">Refence to a #HudClientConnection</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</return-value>
</function>
<method name="connected" c:identifier="hud_client_connection_connected">
<doc xml:space="preserve">Accessor to get the connected status of the connection</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">If we're connected or not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientConnection</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_address"
c:identifier="hud_client_connection_get_address">
<doc xml:space="preserve">Accessor to get the address of the HUD service.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A DBus address</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientConnection</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</instance-parameter>
</parameters>
</method>
<method name="new_query"
c:identifier="hud_client_connection_new_query"
introspectable="0">
<doc xml:space="preserve">Function to create a new query in the HUD service and pass back
the information needed to create a #HudClientQuery object.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientConnection</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">The initial query string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="cb" transfer-ownership="none" closure="2">
<doc xml:space="preserve">Callback when we've got the query</doc>
<type name="ConnectionNewQueryCallback"
c:type="HudClientConnectionNewQueryCallback"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:space="preserve">Data to pass to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</method>
<property name="address"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<property name="path"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ConnectionPrivate" c:type="HudClientConnectionPrivate*"/>
</field>
<glib:signal name="connection-status" when="last">
<doc xml:space="preserve">Called when the connection status changes in some way.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</glib:signal>
</class>
<record name="ConnectionClass"
c:type="HudClientConnectionClass"
glib:is-gtype-struct-for="Connection">
<doc xml:space="preserve">Class information for #HudClientConnection</doc>
<field name="parent_class">
<doc xml:space="preserve">#GObjectClass</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<callback name="ConnectionNewQueryCallback"
c:type="HudClientConnectionNewQueryCallback">
<doc xml:space="preserve">Callback for the async call to create a new query</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">#HudClientConnection for the request</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</parameter>
<parameter name="query_path" transfer-ownership="none">
<doc xml:space="preserve">Path to the query object on DBus</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="results_name" transfer-ownership="none">
<doc xml:space="preserve">DBus name for the results</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="appstack_name" transfer-ownership="none">
<doc xml:space="preserve">DBus name for the appstack</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="4">
<doc xml:space="preserve">Passed in user data</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<record name="ConnectionPrivate"
c:type="HudClientConnectionPrivate"
disguised="1">
<doc xml:space="preserve">Private data for #HudClientConnection.</doc>
</record>
<constant name="PARAM_SIGNAL_MODEL_READY"
value="model-ready"
c:type="HUD_CLIENT_PARAM_SIGNAL_MODEL_READY">
<doc xml:space="preserve">Signal to indicate when the model is ready</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="Param"
c:symbol-prefix="param"
c:type="HudClientParam"
parent="GObject.Object"
glib:type-name="HudClientParam"
glib:get-type="hud_client_param_get_type"
glib:type-struct="ParamClass">
<doc xml:space="preserve">An object that tracks all the of the stuff needed to handle
a parameterized dialog of actions.</doc>
<constructor name="new" c:identifier="hud_client_param_new">
<doc xml:space="preserve">Create a new #HudClientParam object for adjusting a specified
paramaterized dialog.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #HudClientParam dialog</doc>
<type name="Param" c:type="HudClientParam*"/>
</return-value>
<parameters>
<parameter name="dbus_address" transfer-ownership="none">
<doc xml:space="preserve">The address on dbus to find the actions</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="prefix" transfer-ownership="none">
<doc xml:space="preserve">The prefix the menu is using</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="base_action" transfer-ownership="none">
<doc xml:space="preserve">The action to send events for the dialog on</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="action_path" transfer-ownership="none">
<doc xml:space="preserve">DBus path to the action object</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="model_path" transfer-ownership="none">
<doc xml:space="preserve">DBus path to the menu model object</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="model_section" transfer-ownership="none">
<doc xml:space="preserve">Section of the model to use</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</constructor>
<method name="get_actions" c:identifier="hud_client_param_get_actions">
<doc xml:space="preserve">The object path to the actions</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">A #GActionGroup that has the actions in it</doc>
<type name="Gio.ActionGroup" c:type="GActionGroup*"/>
</return-value>
<parameters>
<instance-parameter name="param" transfer-ownership="none">
<doc xml:space="preserve">The #HudClientParam to query</doc>
<type name="Param" c:type="HudClientParam*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_model" c:identifier="hud_client_param_get_model">
<doc xml:space="preserve">The object path to the model</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The menu model of the pane</doc>
<type name="Gio.MenuModel" c:type="GMenuModel*"/>
</return-value>
<parameters>
<instance-parameter name="param" transfer-ownership="none">
<doc xml:space="preserve">The #HudClientParam to query</doc>
<type name="Param" c:type="HudClientParam*"/>
</instance-parameter>
</parameters>
</method>
<method name="send_cancel" c:identifier="hud_client_param_send_cancel">
<doc xml:space="preserve">Send the command to the application to cancel the values
of the actions in the panel and expect it to close soon.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="param" transfer-ownership="none">
<doc xml:space="preserve">The #HudClientParam to query</doc>
<type name="Param" c:type="HudClientParam*"/>
</instance-parameter>
</parameters>
</method>
<method name="send_commit" c:identifier="hud_client_param_send_commit">
<doc xml:space="preserve">Tell the application that the user has requested the values
be applied. This doesn't mean that there isn't a dialog
still open, when it closes "end" will be sent.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="param" transfer-ownership="none">
<doc xml:space="preserve">The #HudClientParam to query</doc>
<type name="Param" c:type="HudClientParam*"/>
</instance-parameter>
</parameters>
</method>
<method name="send_reset" c:identifier="hud_client_param_send_reset">
<doc xml:space="preserve">Send the command to the application to reset the values
of the actions in the pane.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="param" transfer-ownership="none">
<doc xml:space="preserve">The #HudClientParam to query</doc>
<type name="Param" c:type="HudClientParam*"/>
</instance-parameter>
</parameters>
</method>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="ParamPrivate" c:type="HudClientParamPrivate*"/>
</field>
<glib:signal name="model-ready" when="last">
<doc xml:space="preserve">Emitted when the model can be used. It may also be updating, but
the base item is there.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<record name="ParamClass"
c:type="HudClientParamClass"
glib:is-gtype-struct-for="Param">
<doc xml:space="preserve">Class information for #HudClientParam</doc>
<field name="parent_class">
<doc xml:space="preserve">#GObjectClass</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
<field name="model_ready">
<callback name="model_ready">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="param" transfer-ownership="none">
<type name="ParamClass" c:type="HudClientParamClass*"/>
</parameter>
<parameter name="user_data" transfer-ownership="none" closure="1">
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
</field>
</record>
<record name="ParamPrivate" c:type="HudClientParamPrivate" disguised="1">
<doc xml:space="preserve">Private data for #HudClientParam.</doc>
</record>
<constant name="QUERY_SIGNAL_MODELS_CHANGED"
value="models-changed"
c:type="HUD_CLIENT_QUERY_SIGNAL_MODELS_CHANGED">
<doc xml:space="preserve">Signal to indicate when the models have changed</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<constant name="QUERY_SIGNAL_TOOLBAR_UPDATED"
value="toolbar-updated"
c:type="HUD_CLIENT_QUERY_SIGNAL_TOOLBAR_UPDATED">
<doc xml:space="preserve">Signal to indicate when the toolbar has been updated</doc>
<type name="utf8" c:type="gchar*"/>
</constant>
<class name="Query"
c:symbol-prefix="query"
c:type="HudClientQuery"
parent="GObject.Object"
glib:type-name="HudClientQuery"
glib:get-type="hud_client_query_get_type"
glib:type-struct="QueryClass">
<doc xml:space="preserve">Object to track a query and the models for that query. Should
be unref'd when a client is done using the query so that applications
can be told that the HUD is no longer open.</doc>
<constructor name="new" c:identifier="hud_client_query_new">
<doc xml:space="preserve">Startes a query with the HUD using a specific string. This
will block until the query is created.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #HudClientQuery object</doc>
<type name="Query" c:type="HudClientQuery*"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">String to build the initial set of results from</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_for_connection"
c:identifier="hud_client_query_new_for_connection">
<doc xml:space="preserve">Very similar to hud_client_query_new() except that it uses a
custom connection. This is mostly for testing, though it is
available if you need it.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A new #HudClientQuery object</doc>
<type name="Query" c:type="HudClientQuery*"/>
</return-value>
<parameters>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">String to build the initial set of results from</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="connection" transfer-ownership="none">
<doc xml:space="preserve">A custom #HudClientConnection to a non-default HUD service</doc>
<type name="Connection" c:type="HudClientConnection*"/>
</parameter>
</parameters>
</constructor>
<method name="appstack_get_app_icon"
c:identifier="hud_client_query_appstack_get_app_icon">
<doc xml:space="preserve">Get the application icon for a given row in the appstack table.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The application icon</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the icon from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="appstack_get_app_id"
c:identifier="hud_client_query_appstack_get_app_id">
<doc xml:space="preserve">Get the application ID for a given row in the appstack table.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The application ID</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the ID from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="execute_command"
c:identifier="hud_client_query_execute_command">
<doc xml:space="preserve">Executes a particular entry from the results model. The @command_key
should be grabbed from the table and passed to this function to activate
it. This function will block until the command is activated.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="command_key" transfer-ownership="none">
<doc xml:space="preserve">The key from the results model for the entry to activate</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve">Timestamp for the user event</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="execute_param_command"
c:identifier="hud_client_query_execute_param_command">
<doc xml:space="preserve">Executes a command that results in a parameterized dialog
which is controlled using the returned #HudClientParam object.
When created this sends the "opened" event to the application.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">Object to control the parameterized dialog.</doc>
<type name="Param" c:type="HudClientParam*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="command_key" transfer-ownership="none">
<doc xml:space="preserve">The key from the results model for the entry to activate</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve">Timestamp for the user event</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="execute_toolbar_item"
c:identifier="hud_client_query_execute_toolbar_item">
<doc xml:space="preserve">Executes a particular item in the tool bar. The item should
be active before passing this.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="item" transfer-ownership="none">
<doc xml:space="preserve">Which toolbar item is being activated</doc>
<type name="QueryToolbarItems"
c:type="HudClientQueryToolbarItems"/>
</parameter>
<parameter name="timestamp" transfer-ownership="none">
<doc xml:space="preserve">Timestamp for the user event</doc>
<type name="guint" c:type="guint"/>
</parameter>
</parameters>
</method>
<method name="get_active_toolbar"
c:identifier="hud_client_query_get_active_toolbar">
<doc xml:space="preserve">Gets a list of all the active toolbar items as an array. Array should be
free'd after use.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">A
list of the active toolbar items.</doc>
<array name="GLib.Array" c:type="GArray*">
<type name="QueryToolbarItems"/>
</array>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_appstack_model"
c:identifier="hud_client_query_get_appstack_model">
<doc xml:space="preserve">Accessor for the current appstack model.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Appstack Model</doc>
<type name="Dee.Model" c:type="DeeModel*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_query" c:identifier="hud_client_query_get_query">
<doc xml:space="preserve">Accessor for the current query string.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Query string</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_results_model"
c:identifier="hud_client_query_get_results_model">
<doc xml:space="preserve">Accessor for the current results model.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Results Model</doc>
<type name="Dee.Model" c:type="DeeModel*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
</parameters>
</method>
<method name="results_get_command_highlights"
c:identifier="hud_client_query_results_get_command_highlights">
<doc xml:space="preserve">Get the command highlights for a row in the table with start and
stop characters in an array.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The command highlights as a variant of type "a(ii)"</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the highlights from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_get_command_id"
c:identifier="hud_client_query_results_get_command_id">
<doc xml:space="preserve">Get the command ID for a given row in the results table.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The command ID</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the ID from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_get_command_name"
c:identifier="hud_client_query_results_get_command_name">
<doc xml:space="preserve">Get the human readable command name for a given row in the results table.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The command name</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the name from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_get_description"
c:identifier="hud_client_query_results_get_description">
<doc xml:space="preserve">Get the human readable description for the command in the given row in the results table.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The description</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the description from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_get_description_highlights"
c:identifier="hud_client_query_results_get_description_highlights">
<doc xml:space="preserve">Get the description highlights for a row in the table with start and
stop characters in an array.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">The description highlights as a variant of type "a(ii)"</doc>
<type name="GLib.Variant" c:type="GVariant*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the highlights from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_get_shortcut"
c:identifier="hud_client_query_results_get_shortcut">
<doc xml:space="preserve">Get the human readable shortcut for the command in the given row in the results table.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The shortcut</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to grab the shortcut from</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="results_is_parameterized"
c:identifier="hud_client_query_results_is_parameterized">
<doc xml:space="preserve">Check to see if the given command is parameterized</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Whether the command in the row is parameterized</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:space="preserve">Which row in the table to check if the command is parameterized</doc>
<type name="Dee.ModelIter" c:type="DeeModelIter*"/>
</parameter>
</parameters>
</method>
<method name="set_appstack_app"
c:identifier="hud_client_query_set_appstack_app">
<doc xml:space="preserve">This revises the query application to be application_id. Updates can
be seen through the #DeeModel's.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="application_id" transfer-ownership="none">
<doc xml:space="preserve">New application to get results from</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="set_query" c:identifier="hud_client_query_set_query">
<doc xml:space="preserve">This revises the query to be the new query string. Updates can
be seen through the #DeeModel's.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="query" transfer-ownership="none">
<doc xml:space="preserve">New query string</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="toolbar_item_active"
c:identifier="hud_client_query_toolbar_item_active">
<doc xml:space="preserve">Checks to see if a particular toolbar item is implemented by the
application and should be shown to the user as available for use.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">Whether this @item is active.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
<parameter name="item" transfer-ownership="none">
<doc xml:space="preserve">Item to check for</doc>
<type name="QueryToolbarItems"
c:type="HudClientQueryToolbarItems"/>
</parameter>
</parameters>
</method>
<method name="voice_query" c:identifier="hud_client_query_voice_query">
<doc xml:space="preserve">Execute a HUD query using voice recognition.
Will cause a series of signals to be emitted indicating progress:
- voice-query-loading - the voice recognition toolkit is loading.
- voice-query-failed - the voice recognition toolkit has failed to initialize.
- voice-query-listening - the voice recognition toolkit is listening to speech.
- voice-query-heard-something - the voice recognition toolkit has heard a complete utterance.
- voice-query-finished - the voice recognition toolkit has completed, and has a (possibly empty) result.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="cquery" transfer-ownership="none">
<doc xml:space="preserve">A #HudClientQuery</doc>
<type name="Query" c:type="HudClientQuery*"/>
</instance-parameter>
</parameters>
</method>
<property name="connection"
writable="1"
construct-only="1"
transfer-ownership="none">
<type name="Connection"/>
</property>
<property name="query"
writable="1"
construct="1"
transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</property>
<field name="parent">
<type name="GObject.Object" c:type="GObject"/>
</field>
<field name="priv">
<type name="QueryPrivate" c:type="HudClientQueryPrivate*"/>
</field>
<glib:signal name="models-changed" when="last">
<doc xml:space="preserve">Something has caused the models to be changed, you should probably
figure out their state again.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="toolbar-updated" when="last">
<doc xml:space="preserve">The active items in the toolbar changed. Please requery.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="voice-query-failed" when="last">
<doc xml:space="preserve">The voice recognition toolkit has failed to connect to the audio device.
The specific cause is provided as an argument.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="voice-query-finished" when="last">
<doc xml:space="preserve">The voice recognition toolkit has completed and has a (possibly empty) result.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object" transfer-ownership="none">
<type name="utf8" c:type="gchar*"/>
</parameter>
</parameters>
</glib:signal>
<glib:signal name="voice-query-heard-something" when="last">
<doc xml:space="preserve">The voice recognition toolkit has heard an utterance.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="voice-query-listening" when="last">
<doc xml:space="preserve">The voice recognition toolkit is active and listening for speech.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
<glib:signal name="voice-query-loading" when="last">
<doc xml:space="preserve">The voice recognition toolkit is loading, and not ready for speech yet.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</glib:signal>
</class>
<record name="QueryClass"
c:type="HudClientQueryClass"
glib:is-gtype-struct-for="Query">
<doc xml:space="preserve">Class information for #HudClientQuery</doc>
<field name="parent_class">
<doc xml:space="preserve">#GObjectClass</doc>
<type name="GObject.ObjectClass" c:type="GObjectClass"/>
</field>
</record>
<record name="QueryPrivate" c:type="HudClientQueryPrivate" disguised="1">
<doc xml:space="preserve">Private data for #HudClientQuery.</doc>
</record>
<enumeration name="QueryToolbarItems"
glib:type-name="HudClientQueryToolbarItems"
glib:get-type="hud_client_query_toolbar_items_get_type"
c:type="HudClientQueryToolbarItems">
<doc xml:space="preserve">The toolbar has a set of preconfigured items in it for the
application. This enum represents them.</doc>
<member name="invalid"
value="-1"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_INVALID"
glib:nick="invalid">
</member>
<member name="fullscreen"
value="0"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_FULLSCREEN"
glib:nick="fullscreen">
<doc xml:space="preserve">Make the application fullscreen</doc>
</member>
<member name="help"
value="1"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_HELP"
glib:nick="help">
<doc xml:space="preserve">Help the user use the application</doc>
</member>
<member name="preferences"
value="2"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_PREFERENCES"
glib:nick="preferences">
<doc xml:space="preserve">Configure the application</doc>
</member>
<member name="undo"
value="3"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_UNDO"
glib:nick="undo">
<doc xml:space="preserve">Revert the last user action</doc>
</member>
<member name="quit"
value="4"
c:identifier="HUD_CLIENT_QUERY_TOOLBAR_QUIT"
glib:nick="quit">
<doc xml:space="preserve">Quit the application</doc>
</member>
<function name="get_nick"
c:identifier="hud_client_query_toolbar_items_get_nick">
<doc xml:space="preserve">Looks up in the enum table for the nick of @value.
Return value: The nick for the given value or #NULL on error</doc>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The value of HudClientQueryToolbarItems to get the nick of</doc>
<type name="QueryToolbarItems"
c:type="HudClientQueryToolbarItems"/>
</parameter>
</parameters>
</function>
<function name="get_value_from_nick"
c:identifier="hud_client_query_toolbar_items_get_value_from_nick">
<doc xml:space="preserve">Looks up in the enum table for the value of @nick.
Return value: The value for the given @nick</doc>
<return-value transfer-ownership="none">
<type name="QueryToolbarItems" c:type="HudClientQueryToolbarItems"/>
</return-value>
<parameters>
<parameter name="nick" transfer-ownership="none">
<doc xml:space="preserve">The enum nick to lookup</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
</enumeration>
<function name="query_toolbar_items_get_nick"
c:identifier="hud_client_query_toolbar_items_get_nick"
moved-to="QueryToolbarItems.get_nick">
<doc xml:space="preserve">Looks up in the enum table for the nick of @value.
Return value: The nick for the given value or #NULL on error</doc>
<return-value transfer-ownership="none">
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">The value of HudClientQueryToolbarItems to get the nick of</doc>
<type name="QueryToolbarItems" c:type="HudClientQueryToolbarItems"/>
</parameter>
</parameters>
</function>
<function name="query_toolbar_items_get_value_from_nick"
c:identifier="hud_client_query_toolbar_items_get_value_from_nick"
moved-to="QueryToolbarItems.get_value_from_nick">
<doc xml:space="preserve">Looks up in the enum table for the value of @nick.
Return value: The value for the given @nick</doc>
<return-value transfer-ownership="none">
<type name="QueryToolbarItems" c:type="HudClientQueryToolbarItems"/>
</return-value>
<parameters>
<parameter name="nick" transfer-ownership="none">
<doc xml:space="preserve">The enum nick to lookup</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</function>
</namespace>
</repository>
|