diff options
Diffstat (limited to 'libXt/man/XtRealizeWidget.man')
-rw-r--r-- | libXt/man/XtRealizeWidget.man | 422 |
1 files changed, 211 insertions, 211 deletions
diff --git a/libXt/man/XtRealizeWidget.man b/libXt/man/XtRealizeWidget.man index ef6f39973..5846de7ba 100644 --- a/libXt/man/XtRealizeWidget.man +++ b/libXt/man/XtRealizeWidget.man @@ -1,211 +1,211 @@ -.\" Copyright 1993 X Consortium
-.\"
-.\" Permission is hereby granted, free of charge, to any person obtaining
-.\" a copy of this software and associated documentation files (the
-.\" "Software"), to deal in the Software without restriction, including
-.\" without limitation the rights to use, copy, modify, merge, publish,
-.\" distribute, sublicense, and/or sell copies of the Software, and to
-.\" permit persons to whom the Software is furnished to do so, subject to
-.\" the following conditions:
-.\"
-.\" The above copyright notice and this permission notice shall be
-.\" included in all copies or substantial portions of the Software.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
-.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-.\" OTHER DEALINGS IN THE SOFTWARE.
-.\"
-.\" Except as contained in this notice, the name of the X Consortium shall
-.\" not be used in advertising or otherwise to promote the sale, use or
-.\" other dealings in this Software without prior written authorization
-.\" from the X Consortium.
-.\"
-.ds tk X Toolkit
-.ds xT X Toolkit Intrinsics \- C Language Interface
-.ds xI Intrinsics
-.ds xW X Toolkit Athena Widgets \- C Language Interface
-.ds xL Xlib \- C Language X Interface
-.ds xC Inter-Client Communication Conventions Manual
-.ds Rn 3
-.ds Vn 2.2
-.hw XtRealize-Widget XtIs-Realized XtUnrealize-Widget wid-get
-.na
-.de Ds
-.nf
-.\\$1D \\$2 \\$1
-.ft 1
-.ps \\n(PS
-.\".if \\n(VS>=40 .vs \\n(VSu
-.\".if \\n(VS<=39 .vs \\n(VSp
-..
-.de De
-.ce 0
-.if \\n(BD .DF
-.nr BD 0
-.in \\n(OIu
-.if \\n(TM .ls 2
-.sp \\n(DDu
-.fi
-..
-.de FD
-.LP
-.KS
-.TA .5i 3i
-.ta .5i 3i
-.nf
-..
-.de FN
-.fi
-.KE
-.LP
-..
-.de IN \" send an index entry to the stderr
-..
-.de C{
-.KS
-.nf
-.D
-.\"
-.\" choose appropriate monospace font
-.\" the imagen conditional, 480,
-.\" may be changed to L if LB is too
-.\" heavy for your eyes...
-.\"
-.ie "\\*(.T"480" .ft L
-.el .ie "\\*(.T"300" .ft L
-.el .ie "\\*(.T"202" .ft PO
-.el .ie "\\*(.T"aps" .ft CW
-.el .ft R
-.ps \\n(PS
-.ie \\n(VS>40 .vs \\n(VSu
-.el .vs \\n(VSp
-..
-.de C}
-.DE
-.R
-..
-.de Pn
-.ie t \\$1\fB\^\\$2\^\fR\\$3
-.el \\$1\fI\^\\$2\^\fP\\$3
-..
-.de ZN
-.ie t \fB\^\\$1\^\fR\\$2
-.el \fI\^\\$1\^\fP\\$2
-..
-.de NT
-.ne 7
-.ds NO Note
-.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
-.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
-.ie n .sp
-.el .sp 10p
-.TB
-.ce
-\\*(NO
-.ie n .sp
-.el .sp 5p
-.if '\\$1'C' .ce 99
-.if '\\$2'C' .ce 99
-.in +5n
-.ll -5n
-.R
-..
-. \" Note End -- doug kraft 3/85
-.de NE
-.ce 0
-.in -5n
-.ll +5n
-.ie n .sp
-.el .sp 10p
-..
-.ny0
-.TH XtRealizeWidget __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
-.SH NAME
-XtRealizeWidget, XtIsRealized, XtUnrealizeWidget \- realize and unrealize widgets
-.SH SYNTAX
-.HP
-void XtRealizeWidget(Widget \fIw\fP);
-.HP
-Boolean XtIsRealized(Widget \fIw\fP);
-.HP
-void XtUnrealizeWidget(Widget \fIw\fP);
-.SH ARGUMENTS
-.IP \fIw\fP 1i
-Specifies the widget.
-.SH DESCRIPTION
-If the widget is already realized,
-.ZN XtRealizeWidget
-simply returns.
-Otherwise, it performs the following:
-.IP \(bu 5
-Binds all action names in the widget's
-translation table to procedures (see Section 10.1.2).
-.IP \(bu 5
-Makes a post-order traversal of the widget tree rooted
-at the specified widget and calls the change_managed procedure
-of each composite widget that has one or more managed children.
-.IP \(bu 5
-Constructs an
-.ZN XSetWindowAttributes
-structure filled in with information derived from the
-.ZN Core
-widget fields and calls the realize procedure for the widget,
-which adds any widget-specific attributes and creates the X window.
-.IP \(bu 5
-If the widget is
-not a subclass of
-.ZN compositeWidgetClass ,
-.ZN XtRealizeWidget
-returns; otherwise, it continues and performs the following:
-.RS
-.IP \- 5
-Descends recursively to each of the widget's
-managed children and calls the realize procedures.
-Primitive widgets that instantiate children are responsible for realizing
-those children themselves.
-.IP \- 5
-Maps all of the managed children windows that have mapped_when_managed
-.ZN True .
-(If a widget is managed but mapped_when_managed is
-.ZN False ,
-the widget is allocated visual space but is not displayed.
-Some people seem to like this to indicate certain states.)
-.RE
-.LP
-If the widget is a top-level shell widget (that is, it has no parent), and
-mapped_when_managed is
-.ZN True ,
-.ZN XtRealizeWidget
-maps the widget window.
-.LP
-The
-.ZN XtIsRealized
-function returns
-.ZN True
-if the widget has been realized,
-that is, if the widget has a nonzero X window ID.
-.LP
-Some widget procedures (for example, set_values) might wish to
-operate differently
-after the widget has been realized.
-.LP
-The
-.ZN XtUnrealizeWidget
-function destroys the windows of an existing widget and all of its
-children (recursively down the widget tree).
-To recreate the windows at a later time,
-call
-.ZN XtRealizeWidget
-again.
-If the widget was managed,
-it will be unmanaged automatically before its window is freed.
-.SH "SEE ALSO"
-XtManageChildren(__libmansuffix__)
-.br
-\fI\*(xT\fP
-.br
-\fI\*(xL\fP
+.\" Copyright 1993 X Consortium +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining +.\" a copy of this software and associated documentation files (the +.\" "Software"), to deal in the Software without restriction, including +.\" without limitation the rights to use, copy, modify, merge, publish, +.\" distribute, sublicense, and/or sell copies of the Software, and to +.\" permit persons to whom the Software is furnished to do so, subject to +.\" the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be +.\" included in all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +.\" OTHER DEALINGS IN THE SOFTWARE. +.\" +.\" Except as contained in this notice, the name of the X Consortium shall +.\" not be used in advertising or otherwise to promote the sale, use or +.\" other dealings in this Software without prior written authorization +.\" from the X Consortium. +.\" +.ds tk X Toolkit +.ds xT X Toolkit Intrinsics \- C Language Interface +.ds xI Intrinsics +.ds xW X Toolkit Athena Widgets \- C Language Interface +.ds xL Xlib \- C Language X Interface +.ds xC Inter-Client Communication Conventions Manual +.ds Rn 3 +.ds Vn 2.2 +.hw XtRealize-Widget XtIs-Realized XtUnrealize-Widget wid-get +.na +.de Ds +.nf +.\\$1D \\$2 \\$1 +.ft 1 +.ps \\n(PS +.\".if \\n(VS>=40 .vs \\n(VSu +.\".if \\n(VS<=39 .vs \\n(VSp +.. +.de De +.ce 0 +.if \\n(BD .DF +.nr BD 0 +.in \\n(OIu +.if \\n(TM .ls 2 +.sp \\n(DDu +.fi +.. +.de FD +.LP +.KS +.TA .5i 3i +.ta .5i 3i +.nf +.. +.de FN +.fi +.KE +.LP +.. +.de IN \" send an index entry to the stderr +.. +.de C{ +.KS +.nf +.D +.\" +.\" choose appropriate monospace font +.\" the imagen conditional, 480, +.\" may be changed to L if LB is too +.\" heavy for your eyes... +.\" +.ie "\\*(.T"480" .ft L +.el .ie "\\*(.T"300" .ft L +.el .ie "\\*(.T"202" .ft PO +.el .ie "\\*(.T"aps" .ft CW +.el .ft R +.ps \\n(PS +.ie \\n(VS>40 .vs \\n(VSu +.el .vs \\n(VSp +.. +.de C} +.DE +.R +.. +.de Pn +.ie t \\$1\fB\^\\$2\^\fR\\$3 +.el \\$1\fI\^\\$2\^\fP\\$3 +.. +.de ZN +.ie t \fB\^\\$1\^\fR\\$2 +.el \fI\^\\$1\^\fP\\$2 +.. +.de NT +.ne 7 +.ds NO Note +.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 +.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 +.ie n .sp +.el .sp 10p +.TB +.ce +\\*(NO +.ie n .sp +.el .sp 5p +.if '\\$1'C' .ce 99 +.if '\\$2'C' .ce 99 +.in +5n +.ll -5n +.R +.. +. \" Note End -- doug kraft 3/85 +.de NE +.ce 0 +.in -5n +.ll +5n +.ie n .sp +.el .sp 10p +.. +.ny0 +.TH XtRealizeWidget __libmansuffix__ __xorgversion__ "XT FUNCTIONS" +.SH NAME +XtRealizeWidget, XtIsRealized, XtUnrealizeWidget \- realize and unrealize widgets +.SH SYNTAX +.HP +void XtRealizeWidget(Widget \fIw\fP); +.HP +Boolean XtIsRealized(Widget \fIw\fP); +.HP +void XtUnrealizeWidget(Widget \fIw\fP); +.SH ARGUMENTS +.IP \fIw\fP 1i +Specifies the widget. +.SH DESCRIPTION +If the widget is already realized, +.ZN XtRealizeWidget +simply returns. +Otherwise, it performs the following: +.IP \(bu 5 +Binds all action names in the widget's +translation table to procedures (see Section 10.1.2). +.IP \(bu 5 +Makes a post-order traversal of the widget tree rooted +at the specified widget and calls the change_managed procedure +of each composite widget that has one or more managed children. +.IP \(bu 5 +Constructs an +.ZN XSetWindowAttributes +structure filled in with information derived from the +.ZN Core +widget fields and calls the realize procedure for the widget, +which adds any widget-specific attributes and creates the X window. +.IP \(bu 5 +If the widget is +not a subclass of +.ZN compositeWidgetClass , +.ZN XtRealizeWidget +returns; otherwise, it continues and performs the following: +.RS +.IP \- 5 +Descends recursively to each of the widget's +managed children and calls the realize procedures. +Primitive widgets that instantiate children are responsible for realizing +those children themselves. +.IP \- 5 +Maps all of the managed children windows that have mapped_when_managed +.ZN True . +(If a widget is managed but mapped_when_managed is +.ZN False , +the widget is allocated visual space but is not displayed. +Some people seem to like this to indicate certain states.) +.RE +.LP +If the widget is a top-level shell widget (that is, it has no parent), and +mapped_when_managed is +.ZN True , +.ZN XtRealizeWidget +maps the widget window. +.LP +The +.ZN XtIsRealized +function returns +.ZN True +if the widget has been realized, +that is, if the widget has a nonzero X window ID. +.LP +Some widget procedures (for example, set_values) might wish to +operate differently +after the widget has been realized. +.LP +The +.ZN XtUnrealizeWidget +function destroys the windows of an existing widget and all of its +children (recursively down the widget tree). +To recreate the windows at a later time, +call +.ZN XtRealizeWidget +again. +If the widget was managed, +it will be unmanaged automatically before its window is freed. +.SH "SEE ALSO" +XtManageChildren(__libmansuffix__) +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP |