1
.\" $Xorg: XtRealize.man,v 1.3 2000/08/17 19:42:02 cpqbld Exp $
3
.\" Copyright 1993 X Consortium
5
.\" Permission is hereby granted, free of charge, to any person obtaining
6
.\" a copy of this software and associated documentation files (the
7
.\" "Software"), to deal in the Software without restriction, including
8
.\" without limitation the rights to use, copy, modify, merge, publish,
9
.\" distribute, sublicense, and/or sell copies of the Software, and to
10
.\" permit persons to whom the Software is furnished to do so, subject to
11
.\" the following conditions:
13
.\" The above copyright notice and this permission notice shall be
14
.\" included in all copies or substantial portions of the Software.
16
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
20
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
.\" OTHER DEALINGS IN THE SOFTWARE.
24
.\" Except as contained in this notice, the name of the X Consortium shall
25
.\" not be used in advertising or otherwise to promote the sale, use or
26
.\" other dealings in this Software without prior written authorization
27
.\" from the X Consortium.
29
.\" $XFree86: xc/doc/man/Xt/XtRealize.man,v 1.2 2001/01/27 18:20:29 dawes Exp $
32
.ds xT X Toolkit Intrinsics \- C Language Interface
34
.ds xW X Toolkit Athena Widgets \- C Language Interface
35
.ds xL Xlib \- C Language X Interface
36
.ds xC Inter-Client Communication Conventions Manual
39
.hw XtRealize-Widget XtIs-Realized XtUnrealize-Widget wid-get
46
.\".if \\n(VS>=40 .vs \\n(VSu
47
.\".if \\n(VS<=39 .vs \\n(VSp
70
.de IN \" send an index entry to the stderr
77
.\" choose appropriate monospace font
78
.\" the imagen conditional, 480,
79
.\" may be changed to L if LB is too
80
.\" heavy for your eyes...
82
.ie "\\*(.T"480" .ft L
83
.el .ie "\\*(.T"300" .ft L
84
.el .ie "\\*(.T"202" .ft PO
85
.el .ie "\\*(.T"aps" .ft CW
88
.ie \\n(VS>40 .vs \\n(VSu
96
.ie t \\$1\fB\^\\$2\^\fR\\$3
97
.el \\$1\fI\^\\$2\^\fP\\$3
100
.ie t \fB\^\\$1\^\fR\\$2
101
.el \fI\^\\$1\^\fP\\$2
106
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
107
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
121
. \" Note End -- doug kraft 3/85
130
.TH XtRealizeWidget 3Xt __xorgversion__ "XT FUNCTIONS"
132
XtRealizeWidget, XtIsRealized, XtUnrealizeWidget \- realize and unrealize widgets
134
void XtRealizeWidget(\fIw\fP)
138
Boolean XtIsRealized(\fIw\fP)
142
void XtUnrealizeWidget(\fIw\fP)
147
Specifies the widget.
149
If the widget is already realized,
152
Otherwise, it performs the following:
154
Binds all action names in the widget's
155
translation table to procedures (see Section 10.1.2).
157
Makes a post-order traversal of the widget tree rooted
158
at the specified widget and calls the change_managed procedure
159
of each composite widget that has one or more managed children.
162
.ZN XSetWindowAttributes
163
structure filled in with information derived from the
165
widget fields and calls the realize procedure for the widget,
166
which adds any widget-specific attributes and creates the X window.
170
.ZN compositeWidgetClass ,
172
returns; otherwise, it continues and performs the following:
175
Descends recursively to each of the widget's
176
managed children and calls the realize procedures.
177
Primitive widgets that instantiate children are responsible for realizing
178
those children themselves.
180
Maps all of the managed children windows that have mapped_when_managed
182
(If a widget is managed but mapped_when_managed is
184
the widget is allocated visual space but is not displayed.
185
Some people seem to like this to indicate certain states.)
188
If the widget is a top-level shell widget (that is, it has no parent), and
189
mapped_when_managed is
192
maps the widget window.
198
if the widget has been realized,
199
that is, if the widget has a nonzero X window ID.
201
Some widget procedures (for example, set_values) might wish to
203
after the widget has been realized.
206
.ZN XtUnrealizeWidget
207
function destroys the windows of an existing widget and all of its
208
children (recursively down the widget tree).
209
To recreate the windows at a later time,
213
If the widget was managed,
214
it will be unmanaged automatically before its window is freed.
216
XtManageChildren(3Xt)