~ubuntu-branches/debian/sid/libxt/sid

« back to all changes in this revision

Viewing changes to man/XtAppAddSignal.man

  • Committer: Package Import Robot
  • Author(s): Julien Cristau
  • Date: 2012-04-22 11:13:54 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20120422111354-bgq2l0n9x262ez70
Tags: 1:1.1.3-1
* New upstream release.
* Bump xutils-dev build-dep for newer macros.
* Enable unit tests.
* Drop -D_REENTRANT from CFLAGS, unneeded.
* No need to override dh_auto_install.
* Add a libxt-doc package for the specs.
* Remove David Nusinow from Uploaders.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" Copyright (c) 1993, 1994  X Consortium
2
 
.\" 
 
2
.\"
3
3
.\" Permission is hereby granted, free of charge, to any person obtaining a
4
 
.\" copy of this software and associated documentation files (the "Software"), 
5
 
.\" to deal in the Software without restriction, including without limitation 
6
 
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense, 
7
 
.\" and/or sell copies of the Software, and to permit persons to whom the 
 
4
.\" copy of this software and associated documentation files (the "Software"),
 
5
.\" to deal in the Software without restriction, including without limitation
 
6
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
 
7
.\" and/or sell copies of the Software, and to permit persons to whom the
8
8
.\" Software furnished to do so, subject to the following conditions:
9
 
.\" 
 
9
.\"
10
10
.\" The above copyright notice and this permission notice shall be included in
11
11
.\" all copies or substantial portions of the Software.
12
 
.\" 
 
12
.\"
13
13
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
14
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15
 
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL 
16
 
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
17
 
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF 
18
 
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
 
15
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 
16
.\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 
17
.\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
 
18
.\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19
19
.\" SOFTWARE.
20
 
.\" 
21
 
.\" Except as contained in this notice, the name of the X Consortium shall not 
22
 
.\" be used in advertising or otherwise to promote the sale, use or other 
23
 
.\" dealing in this Software without prior written authorization from the 
 
20
.\"
 
21
.\" Except as contained in this notice, the name of the X Consortium shall not
 
22
.\" be used in advertising or otherwise to promote the sale, use or other
 
23
.\" dealing in this Software without prior written authorization from the
24
24
.\" X Consortium.
25
25
.\"
26
26
.ds tk X Toolkit
128
128
.SH SYNTAX
129
129
.HP
130
130
XtSignalId XtAppAddSignal(XtAppContext \fIapp_context\fP, XtSignalCallbackProc
131
 
\fIproc\fP, XtPointer \fIclient_data\fP); 
132
 
.HP
133
 
void XtRemoveSignal(XtSignalId \fIid\fP); 
134
 
.HP
135
 
void XtNoticeSignal(XtSignalId \fIid\fP); 
 
131
\fIproc\fP, XtPointer \fIclient_data\fP);
 
132
.HP
 
133
void XtRemoveSignal(XtSignalId \fIid\fP);
 
134
.HP
 
135
void XtNoticeSignal(XtSignalId \fIid\fP);
136
136
.SH ARGUMENTS
137
137
.IP \fIapp_context\fP 1i
138
138
Specifies the application context.
144
144
.ZN XtAppAddSignal
145
145
call.
146
146
.IP \fIproc\fP 1i
147
 
Specifies the procedure that is to be called when the signal has been 
 
147
Specifies the procedure that is to be called when the signal has been
148
148
raised.
149
149
.SH DESCRIPTION
150
150
The
151
151
.ZN XtAppAddSignal
152
152
function initiates a mechanism for handling signals within the context
153
 
of the Intrinsics. Prior to establishing an operating system dependent 
 
153
of the Intrinsics. Prior to establishing an operating system dependent
154
154
signal handler the application may call
155
155
.ZN XtAppAddSignal
156
 
and store the returned \fIid\fP in a place accessible to the signal 
 
156
and store the returned \fIid\fP in a place accessible to the signal
157
157
handler.
158
158
.LP
159
 
Upon receipt of a signal from the operating system, the application may 
160
 
call 
 
159
Upon receipt of a signal from the operating system, the application may
 
160
call
161
161
.ZN XtNoticeSignal
162
162
passing the \fIid\fP returned by the call to
163
163
.ZN XtAppAddSignal .
172
172
flag is initially
173
173
.ZN False
174
174
and is set to
175
 
.ZN True 
 
175
.ZN True
176
176
by
177
177
.ZN XtNoticeSignal ;
178
178
the Intrinsics invoke the callback whenever the flag is
183
183
.LP
184
184
The
185
185
.ZN XtRemoveSignal
186
 
function is called to remove the specified Intrinsics signal handler. The 
 
186
function is called to remove the specified Intrinsics signal handler. The
187
187
client should disable the source of the signal before calling
188
188
.ZN XtRemoveSignal .
189
189
.SH "SEE ALSO"