← Back to branch summary

~ubuntu-branches/ubuntu/lucid/at-spi/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/cspi/xml/spi_application.xml

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2010-07-02 15:50:32 UTC
  • mfrom: (1.2.1 upstream) (0.1.2 experimental)
  • Revision ID: james.westby@ubuntu.com-20100702155032-mw7vioq2owm3a809
Tags: 1.30.1-0ubuntu1
https://launchpad.net/bugs/600906
* New upstream release (LP: #600906)
  -  Fixes GNOME bugzilla #538680, collection.getMatchesTo() seems to ignore
     the count.
  - Updated translations:

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/xml/spi_application.xml
1
 
<refentry id="at-spi-cspi-AccessibleApplication-API">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="at-spi-cspi-AccessibleApplication-API.top_of_page">AccessibleApplication API</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>AT-SPI-CSPI Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>AccessibleApplication API</refname>
10
 
<refpurpose>The interface implemented by the topmost Accessible in an application's
11
 
hierarchy of Accessible objects.</refpurpose>
12
 
</refnamediv>
13
 
 
14
 
<refsynopsisdiv id="at-spi-cspi-AccessibleApplication-API.synopsis" role="synopsis">
15
 
<title role="synopsis.title">Synopsis</title>
16
 
 
17
 
<synopsis>
18
 
<link linkend="void">void</link>                <link linkend="AccessibleApplication-ref">AccessibleApplication_ref</link>           (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
19
 
<link linkend="void">void</link>                <link linkend="AccessibleApplication-unref">AccessibleApplication_unref</link>         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
20
 
<link linkend="char">char</link> *              <link linkend="AccessibleApplication-getToolkitName">AccessibleApplication_getToolkitName</link>
21
 
                                                        (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
22
 
<link linkend="char">char</link> *              <link linkend="AccessibleApplication-getVersion">AccessibleApplication_getVersion</link>    (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
23
 
<link linkend="long">long</link>                <link linkend="AccessibleApplication-getID">AccessibleApplication_getID</link>         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
24
 
<link linkend="char">char</link> *              <link linkend="AccessibleApplication-getLocale">AccessibleApplication_getLocale</link>     (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj,
25
 
                                                         <link linkend="int">int</link> lc_category);
26
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleApplication-pause">AccessibleApplication_pause</link>         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
27
 
<link linkend="SPIBoolean">SPIBoolean</link>          <link linkend="AccessibleApplication-resume">AccessibleApplication_resume</link>        (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);
28
 
</synopsis>
29
 
</refsynopsisdiv>
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
 
36
 
 
37
 
 
38
 
 
39
 
<refsect1 id="at-spi-cspi-AccessibleApplication-API.description" role="desc">
40
 
<title role="desc.title">Description</title>
41
 
<para>
42
 
This interface is implemented on the topmost object in an application's
43
 
hierarchy.  It is primarily a marker interface, though certain properties
44
 
associated with an application, such as the application's current default
45
 
locale, are also exposed.
46
 
</para>
47
 
</refsect1>
48
 
 
49
 
<refsect1 id="at-spi-cspi-AccessibleApplication-API.details" role="details">
50
 
<title role="details.title">Details</title>
51
 
<refsect2 id="AccessibleApplication-ref" role="function">
52
 
<title>AccessibleApplication_ref ()</title>
53
 
<indexterm zone="AccessibleApplication-ref"><primary sortas="AccessibleApplication_ref">AccessibleApplication_ref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleApplication_ref           (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
54
 
<para>
55
 
Increment the reference count for an <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link>.</para>
56
 
<para>
57
 
</para><variablelist role="params">
58
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
59
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> on which to operate.
60
 
</simpara></listitem></varlistentry>
61
 
</variablelist></refsect2>
62
 
<refsect2 id="AccessibleApplication-unref" role="function">
63
 
<title>AccessibleApplication_unref ()</title>
64
 
<indexterm zone="AccessibleApplication-unref"><primary sortas="AccessibleApplication_unref">AccessibleApplication_unref</primary></indexterm><programlisting><link linkend="void">void</link>                AccessibleApplication_unref         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
65
 
<para>
66
 
Decrement the reference count for an <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link>.</para>
67
 
<para>
68
 
</para><variablelist role="params">
69
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
70
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> object on which to operate.
71
 
</simpara></listitem></varlistentry>
72
 
</variablelist></refsect2>
73
 
<refsect2 id="AccessibleApplication-getToolkitName" role="function">
74
 
<title>AccessibleApplication_getToolkitName ()</title>
75
 
<indexterm zone="AccessibleApplication-getToolkitName"><primary sortas="AccessibleApplication_getToolkitName">AccessibleApplication_getToolkitName</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleApplication_getToolkitName
76
 
                                                        (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
77
 
<para>
78
 
Get the name of the UI toolkit used by an <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link>.</para>
79
 
<para>
80
 
</para><variablelist role="params">
81
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
82
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> to query.
83
 
</simpara></listitem></varlistentry>
84
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a UTF-8 string indicating which UI toolkit is
85
 
         used by an application.
86
 
</simpara></listitem></varlistentry>
87
 
</variablelist></refsect2>
88
 
<refsect2 id="AccessibleApplication-getVersion" role="function">
89
 
<title>AccessibleApplication_getVersion ()</title>
90
 
<indexterm zone="AccessibleApplication-getVersion"><primary sortas="AccessibleApplication_getVersion">AccessibleApplication_getVersion</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleApplication_getVersion    (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
91
 
<para>
92
 
Get the version of the UI toolkit used by an
93
 
     <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> instance.</para>
94
 
<para>
95
 
</para><variablelist role="params">
96
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
97
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> being queried.
98
 
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a UTF-8 string indicating the version of the UI toolkit
100
 
         which is used by an application.
101
 
</simpara></listitem></varlistentry>
102
 
</variablelist></refsect2>
103
 
<refsect2 id="AccessibleApplication-getID" role="function">
104
 
<title>AccessibleApplication_getID ()</title>
105
 
<indexterm zone="AccessibleApplication-getID"><primary sortas="AccessibleApplication_getID">AccessibleApplication_getID</primary></indexterm><programlisting><link linkend="long">long</link>                AccessibleApplication_getID         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
106
 
<para>
107
 
Get the unique ID assigned by the Registry to an
108
 
     <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> instance.
109
 
(Not Yet Implemented by the registry).</para>
110
 
<para>
111
 
</para><variablelist role="params">
112
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
113
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> being queried.
114
 
</simpara></listitem></varlistentry>
115
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a unique <link linkend="long"><type>long</type></link> integer associated with the application
116
 
         by the Registry, or 0 if the application is not registered.
117
 
</simpara></listitem></varlistentry>
118
 
</variablelist></refsect2>
119
 
<refsect2 id="AccessibleApplication-getLocale" role="function">
120
 
<title>AccessibleApplication_getLocale ()</title>
121
 
<indexterm zone="AccessibleApplication-getLocale"><primary sortas="AccessibleApplication_getLocale">AccessibleApplication_getLocale</primary></indexterm><programlisting><link linkend="char">char</link> *              AccessibleApplication_getLocale     (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj,
122
 
                                                         <link linkend="int">int</link> lc_category);</programlisting>
123
 
<para>
124
 
Get a POSIX-compliant string describing the application's current
125
 
locale setting for a particular <parameter>lctype</parameter> category.
126
 
</para>
127
 
<para>
128
 
<parameter>Since</parameter>: AT-SPI 1.4</para>
129
 
<para>
130
 
</para><variablelist role="params">
131
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
132
 
<listitem><simpara> a pointer to the <link linkend="AccessibleApplication"><type>AccessibleApplication</type></link> being queried.
133
 
</simpara></listitem></varlistentry>
134
 
<varlistentry><term><parameter>lc_category</parameter>&#160;:</term>
135
 
<listitem><simpara> one of the POSIX LC_TYPE enumeration, for instance
136
 
LC_MESSAGES.
137
 
</simpara></listitem></varlistentry>
138
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a POSIX-compliant locale string, e.g. "C", "pt_BR", "sr<parameter>latn</parameter>", etc.
139
 
</simpara></listitem></varlistentry>
140
 
</variablelist></refsect2>
141
 
<refsect2 id="AccessibleApplication-pause" role="function">
142
 
<title>AccessibleApplication_pause ()</title>
143
 
<indexterm zone="AccessibleApplication-pause"><primary sortas="AccessibleApplication_pause">AccessibleApplication_pause</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleApplication_pause         (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
144
 
<para>
145
 
Attempt to pause the application (used when client event queue is
146
 
 over-full).
147
 
Not Yet Implemented.</para>
148
 
<para>
149
 
</para><variablelist role="params">
150
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
151
 
<listitem><simpara> a pointer to the <link linkend="Accessible"><type>Accessible</type></link> object on which to operate.
152
 
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if the application was paused successfully, <link linkend="FALSE--CAPS"><type>FALSE</type></link> otherwise.
154
 
 
155
 
</simpara></listitem></varlistentry>
156
 
</variablelist></refsect2>
157
 
<refsect2 id="AccessibleApplication-resume" role="function">
158
 
<title>AccessibleApplication_resume ()</title>
159
 
<indexterm zone="AccessibleApplication-resume"><primary sortas="AccessibleApplication_resume">AccessibleApplication_resume</primary></indexterm><programlisting><link linkend="SPIBoolean">SPIBoolean</link>          AccessibleApplication_resume        (<link linkend="AccessibleApplication">AccessibleApplication</link> *obj);</programlisting>
160
 
<para>
161
 
Attempt to resume the application (used after <link linkend="AccessibleApplication-pause"><type>AccessibleApplication_pause</type></link>).
162
 
Not Yet Implemented.</para>
163
 
<para>
164
 
</para><variablelist role="params">
165
 
<varlistentry><term><parameter>obj</parameter>&#160;:</term>
166
 
<listitem><simpara> a pointer to the <link linkend="Accessible"><type>Accessible</type></link> object on which to operate.
167
 
</simpara></listitem></varlistentry>
168
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><type>TRUE</type></link> if application processing resumed successfully, <link linkend="FALSE--CAPS"><type>FALSE</type></link> otherwise.
169
 
 
170
 
</simpara></listitem></varlistentry>
171
 
</variablelist></refsect2>
172
 
 
173
 
</refsect1>
174
 
 
175
 
 
176
 
 
177
 
 
178
 
</refentry>