← Back to branch summary

~ubuntu-branches/ubuntu/maverick/at-spi/maverick

« back to all changes in this revision

Viewing changes to docs/reference/cspi/html/at-spi-cspi-SPI-main-loop-and-initialization.html

  • Committer: Bazaar Package Importer
  • Author(s): Luke Yelavich
  • Date: 2009-09-23 08:38:27 UTC
  • mfrom: (1.1.45 upstream)
  • Revision ID: james.westby@ubuntu.com-20090923083827-lgmk1ulka14gji51
Tags: 1.28.0-0ubuntu1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/cspi/html/at-spi-cspi-SPI-main-loop-and-initialization.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>SPI main loop and initialization</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
7
 
<link rel="home" href="index.html" title="AT-SPI C Bindings Reference Manual">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
 
7
<link rel="start" href="index.html" title="AT-SPI C Bindings Reference Manual">
8
8
<link rel="up" href="spi-main.html" title="SPI Main Event Loop and Registry">
9
9
<link rel="prev" href="spi-main.html" title="SPI Main Event Loop and Registry">
10
10
<link rel="next" href="at-spi-cspi-Event-Listener-Support.html" title="Event Listener Support">
31
31
                <a href="#at-spi-cspi-SPI-main-loop-and-initialization.description" class="shortcut">Description</a>
32
32
</td></tr>
33
33
</table>
34
 
<div class="refentry" title="SPI main loop and initialization">
 
34
<div class="refentry" lang="en">
35
35
<a name="at-spi-cspi-SPI-main-loop-and-initialization"></a><div class="titlepage"></div>
36
36
<div class="refnamediv"><table width="100%"><tr>
37
37
<td valign="top">
38
38
<h2><span class="refentrytitle"><a name="at-spi-cspi-SPI-main-loop-and-initialization.top_of_page"></a>SPI main loop and initialization</span></h2>
39
 
<p>SPI main loop and initialization</p>
 
39
<p>SPI main loop and initialization — </p>
40
40
</td>
41
41
<td valign="top" align="right"></td>
42
42
</tr></table></div>
43
 
<div class="refsynopsisdiv" title="Synopsis">
 
43
<div class="refsynopsisdiv">
44
44
<a name="at-spi-cspi-SPI-main-loop-and-initialization.synopsis"></a><h2>Synopsis</h2>
45
45
<pre class="synopsis">
46
 
int                 <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-init" title="SPI_init ()">SPI_init</a>                            (void);
47
 
void                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()">SPI_event_main</a>                      (void);
48
 
void                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-quit" title="SPI_event_quit ()">SPI_event_quit</a>                      (void);
49
 
SPIBoolean          <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-eventIsReady" title="SPI_eventIsReady ()">SPI_eventIsReady</a>                    (void);
50
 
<a class="link" href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent">AccessibleEvent</a> *   <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-nextEvent" title="SPI_nextEvent ()">SPI_nextEvent</a>                       (SPIBoolean waitForEvent);
51
 
int                 <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exit" title="SPI_exit ()">SPI_exit</a>                            (void);
 
46
int                 <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-init" title="SPI_init ()">SPI_init</a>                            (void);
 
47
void                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()">SPI_event_main</a>                      (void);
 
48
void                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-quit" title="SPI_event_quit ()">SPI_event_quit</a>                      (void);
 
49
SPIBoolean          <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-eventIsReady" title="SPI_eventIsReady ()">SPI_eventIsReady</a>                    (void);
 
50
<a href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent">AccessibleEvent</a> *   <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-nextEvent" title="SPI_nextEvent ()">SPI_nextEvent</a>                       (SPIBoolean waitForEvent);
 
51
int                 <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exit" title="SPI_exit ()">SPI_exit</a>                            (void);
52
52
 
53
 
void                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-freeString" title="SPI_freeString ()">SPI_freeString</a>                      (char *s);
54
 
<a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIAccessibleException-getSource" title="SPIAccessibleException_getSource ()">SPIAccessibleException_getSource</a>    (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
55
 
char*               <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getDescription" title="SPIException_getDescription ()">SPIException_getDescription</a>         (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
56
 
<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>    <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getExceptionCode" title="SPIException_getExceptionCode ()">SPIException_getExceptionCode</a>       (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
57
 
<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>    <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getSourceType" title="SPIException_getSourceType ()">SPIException_getSourceType</a>          (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
58
 
                    <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a>;
59
 
enum                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>;
60
 
enum                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>;
61
 
SPIBoolean          (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">*SPIExceptionHandler</a>)              (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err,
 
53
void                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-freeString" title="SPI_freeString ()">SPI_freeString</a>                      (char *s);
 
54
<a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIAccessibleException-getSource" title="SPIAccessibleException_getSource ()">SPIAccessibleException_getSource</a>    (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
 
55
char*               <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getDescription" title="SPIException_getDescription ()">SPIException_getDescription</a>         (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
 
56
<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>    <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getExceptionCode" title="SPIException_getExceptionCode ()">SPIException_getExceptionCode</a>       (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
 
57
<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>    <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException-getSourceType" title="SPIException_getSourceType ()">SPIException_getSourceType</a>          (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);
 
58
                    <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a>;
 
59
enum                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>;
 
60
enum                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>;
 
61
SPIBoolean          (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">*SPIExceptionHandler</a>)              (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err,
62
62
                                                         SPIBoolean is_fatal);
63
 
                    <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a>;
64
 
void                <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-freeRect" title="SPI_freeRect ()">SPI_freeRect</a>                        (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a> *r);
65
 
char*               <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-dupString" title="SPI_dupString ()">SPI_dupString</a>                       (char *s);
66
 
SPIBoolean          <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exceptionHandlerPush" title="SPI_exceptionHandlerPush ()">SPI_exceptionHandlerPush</a>            (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a> *handler);
67
 
<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a>* <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exceptionHandlerPop" title="SPI_exceptionHandlerPop ()">SPI_exceptionHandlerPop</a>            (void);
 
63
                    <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a>;
 
64
void                <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-freeRect" title="SPI_freeRect ()">SPI_freeRect</a>                        (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a> *r);
 
65
char*               <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-dupString" title="SPI_dupString ()">SPI_dupString</a>                       (char *s);
 
66
SPIBoolean          <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exceptionHandlerPush" title="SPI_exceptionHandlerPush ()">SPI_exceptionHandlerPush</a>            (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a> *handler);
 
67
<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a>* <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-exceptionHandlerPop" title="SPI_exceptionHandlerPop ()">SPI_exceptionHandlerPop</a>            (void);
68
68
</pre>
69
69
</div>
70
 
<div class="refsect1" title="Description">
 
70
<div class="refsect1" lang="en">
71
71
<a name="at-spi-cspi-SPI-main-loop-and-initialization.description"></a><h2>Description</h2>
72
72
<p>
73
73
</p>
74
74
</div>
75
 
<div class="refsect1" title="Details">
 
75
<div class="refsect1" lang="en">
76
76
<a name="at-spi-cspi-SPI-main-loop-and-initialization.details"></a><h2>Details</h2>
77
 
<div class="refsect2" title="SPI_init ()">
 
77
<div class="refsect2" lang="en">
78
78
<a name="SPI-init"></a><h3>SPI_init ()</h3>
79
79
<pre class="programlisting">int                 SPI_init                            (void);</pre>
80
80
<p>
84
84
<div class="variablelist"><table border="0">
85
85
<col align="left" valign="top">
86
86
<tbody><tr>
87
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
87
<td>
 
88
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
88
89
<td> 0 on success, otherwise an integer error code.  
89
90
</td>
90
91
</tr></tbody>
91
92
</table></div>
92
93
</div>
93
94
<hr>
94
 
<div class="refsect2" title="SPI_event_main ()">
 
95
<div class="refsect2" lang="en">
95
96
<a name="SPI-event-main"></a><h3>SPI_event_main ()</h3>
96
97
<pre class="programlisting">void                SPI_event_main                      (void);</pre>
97
98
<p>
99
100
</p>
100
101
<p>
101
102
(NOTE: This method does not return control, it is exited via a call to
102
 
 <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-quit" title="SPI_event_quit ()"><code class="function">SPI_event_quit()</code></a> from within an event handler).</p>
 
103
 <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-quit" title="SPI_event_quit ()"><code class="function">SPI_event_quit()</code></a> from within an event handler).</p>
103
104
<p>
104
105
</p>
105
106
</div>
106
107
<hr>
107
 
<div class="refsect2" title="SPI_event_quit ()">
 
108
<div class="refsect2" lang="en">
108
109
<a name="SPI-event-quit"></a><h3>SPI_event_quit ()</h3>
109
110
<pre class="programlisting">void                SPI_event_quit                      (void);</pre>
110
111
<p>
114
115
</p>
115
116
</div>
116
117
<hr>
117
 
<div class="refsect2" title="SPI_eventIsReady ()">
 
118
<div class="refsect2" lang="en">
118
119
<a name="SPI-eventIsReady"></a><h3>SPI_eventIsReady ()</h3>
119
120
<pre class="programlisting">SPIBoolean          SPI_eventIsReady                    (void);</pre>
120
121
<p>
121
122
Checks to see if an SPI event is waiting in the event queue.
122
 
Used by clients that don't wish to use <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()"><code class="function">SPI_event_main()</code></a>.
 
123
Used by clients that don't wish to use <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()"><code class="function">SPI_event_main()</code></a>.
123
124
</p>
124
125
<p>
125
126
Not Yet Implemented.</p>
128
129
<div class="variablelist"><table border="0">
129
130
<col align="left" valign="top">
130
131
<tbody><tr>
131
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
132
<td>
 
133
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
132
134
<td> <a
133
135
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
134
136
><span class="type">TRUE</span></a> if an event is waiting, otherwise <a
140
142
</table></div>
141
143
</div>
142
144
<hr>
143
 
<div class="refsect2" title="SPI_nextEvent ()">
 
145
<div class="refsect2" lang="en">
144
146
<a name="SPI-nextEvent"></a><h3>SPI_nextEvent ()</h3>
145
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent">AccessibleEvent</a> *   SPI_nextEvent                       (SPIBoolean waitForEvent);</pre>
 
147
<pre class="programlisting"><a href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent">AccessibleEvent</a> *   SPI_nextEvent                       (SPIBoolean waitForEvent);</pre>
146
148
<p>
147
149
Gets the next event in the SPI event queue; blocks if no event
148
150
is pending and <em class="parameter"><code>waitForEvent</code></em> is <a
149
151
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE--CAPS"
150
152
><span class="type">TRUE</span></a>.
151
 
Used by clients that don't wish to use <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()"><code class="function">SPI_event_main()</code></a>.
 
153
Used by clients that don't wish to use <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPI-event-main" title="SPI_event_main ()"><code class="function">SPI_event_main()</code></a>.
152
154
</p>
153
155
<p>
154
156
Not Yet Implemented.</p>
158
160
<col align="left" valign="top">
159
161
<tbody>
160
162
<tr>
161
 
<td><p><span class="term"><em class="parameter"><code>waitForEvent</code></em> :</span></p></td>
 
163
<td>
 
164
<span class="term"><em class="parameter"><code>waitForEvent</code></em> :</span></td>
162
165
<td> a <span class="type">SPIBoolean</span> indicating whether to block or not.
163
166
</td>
164
167
</tr>
165
168
<tr>
166
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
167
 
<td> the next <a class="link" href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent"><span class="type">AccessibleEvent</span></a> in the SPI event queue.
 
169
<td>
 
170
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
171
<td> the next <a href="at-spi-cspi-Event-Listener-Support.html#AccessibleEvent" title="AccessibleEvent"><span class="type">AccessibleEvent</span></a> in the SPI event queue.
168
172
</td>
169
173
</tr>
170
174
</tbody>
171
175
</table></div>
172
176
</div>
173
177
<hr>
174
 
<div class="refsect2" title="SPI_exit ()">
 
178
<div class="refsect2" lang="en">
175
179
<a name="SPI-exit"></a><h3>SPI_exit ()</h3>
176
180
<pre class="programlisting">int                 SPI_exit                            (void);</pre>
177
181
<p>
182
186
<div class="variablelist"><table border="0">
183
187
<col align="left" valign="top">
184
188
<tbody><tr>
185
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
189
<td>
 
190
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
186
191
<td> 0 if there were no leaks, otherwise non zero.
187
192
</td>
188
193
</tr></tbody>
189
194
</table></div>
190
195
</div>
191
196
<hr>
192
 
<div class="refsect2" title="SPI_freeString ()">
 
197
<div class="refsect2" lang="en">
193
198
<a name="SPI-freeString"></a><h3>SPI_freeString ()</h3>
194
199
<pre class="programlisting">void                SPI_freeString                      (char *s);</pre>
195
200
<p>
205
210
<div class="variablelist"><table border="0">
206
211
<col align="left" valign="top">
207
212
<tbody><tr>
208
 
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
 
213
<td>
 
214
<span class="term"><em class="parameter"><code>s</code></em> :</span></td>
209
215
<td> a character string returned from another at-spi call.
210
216
</td>
211
217
</tr></tbody>
212
218
</table></div>
213
219
</div>
214
220
<hr>
215
 
<div class="refsect2" title="SPIAccessibleException_getSource ()">
 
221
<div class="refsect2" lang="en">
216
222
<a name="SPIAccessibleException-getSource"></a><h3>SPIAccessibleException_getSource ()</h3>
217
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         SPIAccessibleException_getSource    (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
 
223
<pre class="programlisting"><a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible">Accessible</a>*         SPIAccessibleException_getSource    (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
218
224
<p>
219
225
Get the identity of the object which threw an exception.
220
226
</p>
226
232
<col align="left" valign="top">
227
233
<tbody>
228
234
<tr>
229
 
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
230
 
<td> the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
 
235
<td>
 
236
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
 
237
<td> the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
231
238
</td>
232
239
</tr>
233
240
<tr>
234
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
235
 
<td> a pointer to the <a class="link" href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object which threw the exception.
 
241
<td>
 
242
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
243
<td> a pointer to the <a href="at-spi-cspi-Accessible-Objects.html#Accessible" title="struct Accessible"><span class="type">Accessible</span></a> object which threw the exception.
236
244
</td>
237
245
</tr>
238
246
</tbody>
239
247
</table></div>
240
248
</div>
241
249
<hr>
242
 
<div class="refsect2" title="SPIException_getDescription ()">
 
250
<div class="refsect2" lang="en">
243
251
<a name="SPIException-getDescription"></a><h3>SPIException_getDescription ()</h3>
244
 
<pre class="programlisting">char*               SPIException_getDescription         (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
 
252
<pre class="programlisting">char*               SPIException_getDescription         (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
245
253
<p>
246
254
Get a text description of the exception that has been thrown.
247
255
Unfortunately these descriptions tend to be terse and limited in
252
260
<col align="left" valign="top">
253
261
<tbody>
254
262
<tr>
255
 
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
256
 
<td> the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
 
263
<td>
 
264
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
 
265
<td> the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
257
266
</td>
258
267
</tr>
259
268
<tr>
260
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
269
<td>
 
270
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
261
271
<td> a brief character string describing the exception.
262
272
</td>
263
273
</tr>
265
275
</table></div>
266
276
</div>
267
277
<hr>
268
 
<div class="refsect2" title="SPIException_getExceptionCode ()">
 
278
<div class="refsect2" lang="en">
269
279
<a name="SPIException-getExceptionCode"></a><h3>SPIException_getExceptionCode ()</h3>
270
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>    SPIException_getExceptionCode       (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
 
280
<pre class="programlisting"><a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a>    SPIException_getExceptionCode       (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
271
281
<p>
272
 
Get the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode"><span class="type">SPIExceptionCode</span></a> telling what type of exception condition has occurred.
 
282
Get the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode"><span class="type">SPIExceptionCode</span></a> telling what type of exception condition has occurred.
273
283
</p>
274
284
<p>
275
285
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4</p>
279
289
<col align="left" valign="top">
280
290
<tbody>
281
291
<tr>
282
 
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
283
 
<td> the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
 
292
<td>
 
293
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
 
294
<td> the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> being queried.
284
295
</td>
285
296
</tr>
286
297
<tr>
287
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
288
 
<td> the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode"><span class="type">SPIExceptionCode</span></a> corresponding to exception <em class="parameter"><code>err</code></em>.
 
298
<td>
 
299
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
300
<td> the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode"><span class="type">SPIExceptionCode</span></a> corresponding to exception <em class="parameter"><code>err</code></em>.
289
301
</td>
290
302
</tr>
291
303
</tbody>
292
304
</table></div>
293
305
</div>
294
306
<hr>
295
 
<div class="refsect2" title="SPIException_getSourceType ()">
 
307
<div class="refsect2" lang="en">
296
308
<a name="SPIException-getSourceType"></a><h3>SPIException_getSourceType ()</h3>
297
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>    SPIException_getSourceType          (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
 
309
<pre class="programlisting"><a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a>    SPIException_getSourceType          (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err);</pre>
298
310
<p>
299
 
Get the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType"><span class="type">SPIExceptionType</span></a> of an exception which has been thrown.
 
311
Get the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType"><span class="type">SPIExceptionType</span></a> of an exception which has been thrown.
300
312
</p>
301
313
<p>
302
314
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4</p>
306
318
<col align="left" valign="top">
307
319
<tbody>
308
320
<tr>
309
 
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 
321
<td>
 
322
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
310
323
<td> the exception being queried
311
324
</td>
312
325
</tr>
313
326
<tr>
314
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
315
 
<td> the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType"><span class="type">SPIExceptionType</span></a> corresponding to exception <em class="parameter"><code>err</code></em>.
 
327
<td>
 
328
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
329
<td> the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType"><span class="type">SPIExceptionType</span></a> corresponding to exception <em class="parameter"><code>err</code></em>.
316
330
</td>
317
331
</tr>
318
332
</tbody>
319
333
</table></div>
320
334
</div>
321
335
<hr>
322
 
<div class="refsect2" title="SPIException">
 
336
<div class="refsect2" lang="en">
323
337
<a name="SPIException"></a><h3>SPIException</h3>
324
338
<pre class="programlisting">typedef struct {
325
339
  SPIExceptionType type;
337
351
<col align="left" valign="top">
338
352
<tbody>
339
353
<tr>
340
 
<td><p><span class="term"><a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a> <em class="structfield"><code>type</code></em>;</span></p></td>
341
 
<td> private
342
 
</td>
343
 
</tr>
344
 
<tr>
345
 
<td><p><span class="term">CORBA_Object <em class="structfield"><code>source</code></em>;</span></p></td>
346
 
<td> private
347
 
</td>
348
 
</tr>
349
 
<tr>
350
 
<td><p><span class="term">CORBA_Environment *<em class="structfield"><code>ev</code></em>;</span></p></td>
351
 
<td> private
352
 
</td>
353
 
</tr>
354
 
<tr>
355
 
<td><p><span class="term"><a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a> <em class="structfield"><code>code</code></em>;</span></p></td>
356
 
<td> private
357
 
</td>
358
 
</tr>
359
 
<tr>
360
 
<td><p><span class="term">char *<em class="structfield"><code>desc</code></em>;</span></p></td>
 
354
<td>
 
355
<span class="term"><a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionType" title="enum SPIExceptionType">SPIExceptionType</a> <em class="structfield"><code>type</code></em>;</span></td>
 
356
<td> private
 
357
</td>
 
358
</tr>
 
359
<tr>
 
360
<td>
 
361
<span class="term">CORBA_Object <em class="structfield"><code>source</code></em>;</span></td>
 
362
<td> private
 
363
</td>
 
364
</tr>
 
365
<tr>
 
366
<td>
 
367
<span class="term">CORBA_Environment *<em class="structfield"><code>ev</code></em>;</span></td>
 
368
<td> private
 
369
</td>
 
370
</tr>
 
371
<tr>
 
372
<td>
 
373
<span class="term"><a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionCode" title="enum SPIExceptionCode">SPIExceptionCode</a> <em class="structfield"><code>code</code></em>;</span></td>
 
374
<td> private
 
375
</td>
 
376
</tr>
 
377
<tr>
 
378
<td>
 
379
<span class="term">char *<em class="structfield"><code>desc</code></em>;</span></td>
361
380
<td> private
362
381
</td>
363
382
</tr>
365
384
</table></div>
366
385
</div>
367
386
<hr>
368
 
<div class="refsect2" title="enum SPIExceptionCode">
 
387
<div class="refsect2" lang="en">
369
388
<a name="SPIExceptionCode"></a><h3>enum SPIExceptionCode</h3>
370
389
<pre class="programlisting">typedef enum {
371
390
        SPI_EXCEPTION_UNSPECIFIED,
383
402
<col align="left" valign="top">
384
403
<tbody>
385
404
<tr>
386
 
<td><p><a name="SPI-EXCEPTION-UNSPECIFIED--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_UNSPECIFIED</code></span></p></td>
 
405
<td>
 
406
<a name="SPI-EXCEPTION-UNSPECIFIED--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_UNSPECIFIED</code></span></td>
387
407
<td> An exception of unknown type, or which doesn't fit the other types.
388
408
</td>
389
409
</tr>
390
410
<tr>
391
 
<td><p><a name="SPI-EXCEPTION-DISCONNECT--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_DISCONNECT</code></span></p></td>
 
411
<td>
 
412
<a name="SPI-EXCEPTION-DISCONNECT--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_DISCONNECT</code></span></td>
392
413
<td> Communication with the object or service has been disconnected;
393
414
this usually means that the object or service has died or exited.
394
415
</td>
395
416
</tr>
396
417
<tr>
397
 
<td><p><a name="SPI-EXCEPTION-NO-IMPL--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_NO_IMPL</code></span></p></td>
 
418
<td>
 
419
<a name="SPI-EXCEPTION-NO-IMPL--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_NO_IMPL</code></span></td>
398
420
<td> The object or service is missing the implementation for a request.
399
421
</td>
400
422
</tr>
401
423
<tr>
402
 
<td><p><a name="SPI-EXCEPTION-IO--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_IO</code></span></p></td>
 
424
<td>
 
425
<a name="SPI-EXCEPTION-IO--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_IO</code></span></td>
403
426
<td> The communications channel has become corrupted, blocked, or is otherwise in a bad state.
404
427
</td>
405
428
</tr>
406
429
<tr>
407
 
<td><p><a name="SPI-EXCEPTION-BAD-DATA--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_BAD_DATA</code></span></p></td>
 
430
<td>
 
431
<a name="SPI-EXCEPTION-BAD-DATA--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_BAD_DATA</code></span></td>
408
432
<td> The data received or sent over the interface has been identified as 
409
433
improperly formatted or otherwise fails to match the expectations.
410
434
</td>
413
437
</table></div>
414
438
</div>
415
439
<hr>
416
 
<div class="refsect2" title="enum SPIExceptionType">
 
440
<div class="refsect2" lang="en">
417
441
<a name="SPIExceptionType"></a><h3>enum SPIExceptionType</h3>
418
442
<pre class="programlisting">typedef enum {
419
443
        SPI_EXCEPTION_SOURCE_UNSPECIFIED,
430
454
<col align="left" valign="top">
431
455
<tbody>
432
456
<tr>
433
 
<td><p><a name="SPI-EXCEPTION-SOURCE-UNSPECIFIED--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_UNSPECIFIED</code></span></p></td>
 
457
<td>
 
458
<a name="SPI-EXCEPTION-SOURCE-UNSPECIFIED--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_UNSPECIFIED</code></span></td>
434
459
<td> Don't know or can't tell where the problem is
435
460
</td>
436
461
</tr>
437
462
<tr>
438
 
<td><p><a name="SPI-EXCEPTION-SOURCE-ACCESSIBLE--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_ACCESSIBLE</code></span></p></td>
 
463
<td>
 
464
<a name="SPI-EXCEPTION-SOURCE-ACCESSIBLE--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_ACCESSIBLE</code></span></td>
439
465
<td> The source of an event or query (i.e. an app) has thrown the exception.
440
466
</td>
441
467
</tr>
442
468
<tr>
443
 
<td><p><a name="SPI-EXCEPTION-SOURCE-REGISTRY--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_REGISTRY</code></span></p></td>
 
469
<td>
 
470
<a name="SPI-EXCEPTION-SOURCE-REGISTRY--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_REGISTRY</code></span></td>
444
471
<td> The AT-SPI registry has thrown the exception or cannot be reached.
445
472
</td>
446
473
</tr>
447
474
<tr>
448
 
<td><p><a name="SPI-EXCEPTION-SOURCE-DEVICE--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_DEVICE</code></span></p></td>
 
475
<td>
 
476
<a name="SPI-EXCEPTION-SOURCE-DEVICE--CAPS"></a><span class="term"><code class="literal">SPI_EXCEPTION_SOURCE_DEVICE</code></span></td>
449
477
<td> The device event subsystem has encountered an error condition.
450
478
</td>
451
479
</tr>
453
481
</table></div>
454
482
</div>
455
483
<hr>
456
 
<div class="refsect2" title="SPIExceptionHandler ()">
 
484
<div class="refsect2" lang="en">
457
485
<a name="SPIExceptionHandler"></a><h3>SPIExceptionHandler ()</h3>
458
 
<pre class="programlisting">SPIBoolean          (*SPIExceptionHandler)              (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err,
 
486
<pre class="programlisting">SPIBoolean          (*SPIExceptionHandler)              (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException">SPIException</a> *err,
459
487
                                                         SPIBoolean is_fatal);</pre>
460
488
<p>
461
489
A function type for functions to be called when exceptions occur.</p>
465
493
<col align="left" valign="top">
466
494
<tbody>
467
495
<tr>
468
 
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
 
496
<td>
 
497
<span class="term"><em class="parameter"><code>err</code></em> :</span></td>
469
498
<td> points to the SPIException opaque object.
470
499
</td>
471
500
</tr>
472
501
<tr>
473
 
<td><p><span class="term"><em class="parameter"><code>is_fatal</code></em> :</span></p></td>
 
502
<td>
 
503
<span class="term"><em class="parameter"><code>is_fatal</code></em> :</span></td>
474
504
<td> indicates whether the exception is a fatal error or not.
475
505
</td>
476
506
</tr>
477
507
<tr>
478
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
508
<td>
 
509
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
479
510
<td>
480
511
</td>
481
512
</tr>
483
514
</table></div>
484
515
</div>
485
516
<hr>
486
 
<div class="refsect2" title="SPIRect">
 
517
<div class="refsect2" lang="en">
487
518
<a name="SPIRect"></a><h3>SPIRect</h3>
488
519
<pre class="programlisting">typedef struct {
489
520
        long x;
502
533
</table></div>
503
534
</div>
504
535
<hr>
505
 
<div class="refsect2" title="SPI_freeRect ()">
 
536
<div class="refsect2" lang="en">
506
537
<a name="SPI-freeRect"></a><h3>SPI_freeRect ()</h3>
507
 
<pre class="programlisting">void                SPI_freeRect                        (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a> *r);</pre>
 
538
<pre class="programlisting">void                SPI_freeRect                        (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIRect" title="SPIRect">SPIRect</a> *r);</pre>
508
539
<p>
509
540
Free a SPIRect structure returned from an at-spi call.  Clients of
510
541
at-spi should use this function instead of <code class="function">free()</code> or <a
521
552
<div class="variablelist"><table border="0">
522
553
<col align="left" valign="top">
523
554
<tbody><tr>
524
 
<td><p><span class="term"><em class="parameter"><code>r</code></em> :</span></p></td>
 
555
<td>
 
556
<span class="term"><em class="parameter"><code>r</code></em> :</span></td>
525
557
<td> a pointer to an SPIRect returned from another at-spi call.
526
558
</td>
527
559
</tr></tbody>
528
560
</table></div>
529
561
</div>
530
562
<hr>
531
 
<div class="refsect2" title="SPI_dupString ()">
 
563
<div class="refsect2" lang="en">
532
564
<a name="SPI-dupString"></a><h3>SPI_dupString ()</h3>
533
565
<pre class="programlisting">char*               SPI_dupString                       (char *s);</pre>
534
566
<p>
539
571
<col align="left" valign="top">
540
572
<tbody>
541
573
<tr>
542
 
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
 
574
<td>
 
575
<span class="term"><em class="parameter"><code>s</code></em> :</span></td>
543
576
<td> a UTF-8 string to be duplicated
544
577
</td>
545
578
</tr>
546
579
<tr>
547
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
580
<td>
 
581
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
548
582
<td> a duplicate of the string passed as a parameter, which should
549
583
be freed via SPI_freeString after use.
550
584
</td>
553
587
</table></div>
554
588
</div>
555
589
<hr>
556
 
<div class="refsect2" title="SPI_exceptionHandlerPush ()">
 
590
<div class="refsect2" lang="en">
557
591
<a name="SPI-exceptionHandlerPush"></a><h3>SPI_exceptionHandlerPush ()</h3>
558
 
<pre class="programlisting">SPIBoolean          SPI_exceptionHandlerPush            (<a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a> *handler);</pre>
 
592
<pre class="programlisting">SPIBoolean          SPI_exceptionHandlerPush            (<a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a> *handler);</pre>
559
593
<p>
560
 
Install a client-side handler for <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> instances, which can see and handle any
 
594
Install a client-side handler for <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIException" title="SPIException"><span class="type">SPIException</span></a> instances, which can see and handle any
561
595
exceptions before chaining them to the next exception handler in the stack.
562
596
</p>
563
597
<p>
568
602
<col align="left" valign="top">
569
603
<tbody>
570
604
<tr>
571
 
<td><p><span class="term"><em class="parameter"><code>handler</code></em> :</span></p></td>
572
 
<td> an <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> to install as the first code to deal with exceptions.
 
605
<td>
 
606
<span class="term"><em class="parameter"><code>handler</code></em> :</span></td>
 
607
<td> an <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> to install as the first code to deal with exceptions.
573
608
</td>
574
609
</tr>
575
610
<tr>
576
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
611
<td>
 
612
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
577
613
<td>%TRUE if the result succeeded, <a
578
614
href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE--CAPS"
579
615
><code class="literal">FALSE</code></a> if <em class="parameter"><code>hander</code></em> could not be registered.
583
619
</table></div>
584
620
</div>
585
621
<hr>
586
 
<div class="refsect2" title="SPI_exceptionHandlerPop ()">
 
622
<div class="refsect2" lang="en">
587
623
<a name="SPI-exceptionHandlerPop"></a><h3>SPI_exceptionHandlerPop ()</h3>
588
 
<pre class="programlisting"><a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a>* SPI_exceptionHandlerPop            (void);</pre>
 
624
<pre class="programlisting"><a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()">SPIExceptionHandler</a>* SPI_exceptionHandlerPop            (void);</pre>
589
625
<p>
590
 
Remove/pop an <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> off the error handler stack and return the new handler.
 
626
Remove/pop an <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> off the error handler stack and return the new handler.
591
627
</p>
592
628
<p>
593
629
<em class="parameter"><code>Since</code></em>: AT-SPI 1.4</p>
596
632
<div class="variablelist"><table border="0">
597
633
<col align="left" valign="top">
598
634
<tbody><tr>
599
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
600
 
<td>the <a class="link" href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> which is now at the top of the error handler stack after the call.
 
635
<td>
 
636
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
 
637
<td>the <a href="at-spi-cspi-SPI-main-loop-and-initialization.html#SPIExceptionHandler" title="SPIExceptionHandler ()"><span class="type">SPIExceptionHandler</span></a> which is now at the top of the error handler stack after the call.
601
638
</td>
602
639
</tr></tbody>
603
640
</table></div>