Merge branch 'devel/upgrade' into tizen
[platform/upstream/libXt.git] / man / XtAppAddActionHook.man
1 .\" Copyright (c) 1993, 1994  X Consortium
2 .\"
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
8 .\" Software furnished to do so, subject to the following conditions:
9 .\"
10 .\" The above copyright notice and this permission notice shall be included in
11 .\" all copies or substantial portions of the Software.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
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
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
24 .\" X Consortium.
25 .\"
26 .ds tk X Toolkit
27 .ds xT X Toolkit Intrinsics \- C Language Interface
28 .ds xI Intrinsics
29 .ds xW X Toolkit Athena Widgets \- C Language Interface
30 .ds xL Xlib \- C Language X Interface
31 .ds xC Inter-Client Communication Conventions Manual
32 .ds Rn 3
33 .ds Vn 2.2
34 .hw XtApp-Add-Action-Hook XtRemove-Action-Hook wid-get
35 .na
36 .de Ds
37 .nf
38 .\\$1D \\$2 \\$1
39 .ft CW
40 .ps \\n(PS
41 .\".if \\n(VS>=40 .vs \\n(VSu
42 .\".if \\n(VS<=39 .vs \\n(VSp
43 ..
44 .de De
45 .ce 0
46 .if \\n(BD .DF
47 .nr BD 0
48 .in \\n(OIu
49 .if \\n(TM .ls 2
50 .sp \\n(DDu
51 .fi
52 ..
53 .de IN          \" send an index entry to the stderr
54 ..
55 .de Pn
56 .ie t \\$1\fB\^\\$2\^\fR\\$3
57 .el \\$1\fI\^\\$2\^\fP\\$3
58 ..
59 .de ZN
60 .ie t \fB\^\\$1\^\fR\\$2
61 .el \fI\^\\$1\^\fP\\$2
62 ..
63 .ny0
64 .TH XtAppAddActionHook __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
65 .SH NAME
66 XtAppAddActionHook, XtRemoveActionHook \- register an action hook procedure
67 .SH SYNTAX
68 .HP
69 XtActionHookId XtAppAddActionHook(XtAppContext \fIapp_context\fP,
70 XtActionHookProc \fIproc\fP, XtPointer \fIclient_data\fP);
71 .HP
72 void XtRemoveActionHook(XtActionHookId \fIid\fP);
73 .SH ARGUMENTS
74 .IP \fIapp_context\fP 1i
75 Specifies the application context.
76 .IP \fIproc\fP 1i
77 Specifies the action hook procedure.
78 .IP \fInum_args\fP 1i
79 Specifies the application-specific data to be passed to the action hook.
80 .SH DESCRIPTION
81 .ZN XtAppAddActionHook
82 adds the specified procedure to the front of a list maintained in the
83 application context. In the future, when an action routine is about to
84 be invoked for any widget in this application context, either through
85 the translation manager or via
86 .ZN XtCallActionProc ,
87 the action hohok procedures will be called in reverse order of registration
88 jut prior to invoking the action routine.
89 .LP
90 Action hook procedures are removed automatically and the
91 .ZN XtActionHookId
92 s destroyed when the application context in which they were added is
93 destroyed.
94 .LP
95 .ZN XtRemoveActionHook
96 removes the specified action hook procedure from the list in which it
97 was registered.
98 .SH "SEE ALSO"
99 .br
100 \fI\*(xT\fP
101 .br
102 \fI\*(xL\fP