aboutsummaryrefslogtreecommitdiff
path: root/libXt/man/XtMakeGeometryRequest.man
diff options
context:
space:
mode:
Diffstat (limited to 'libXt/man/XtMakeGeometryRequest.man')
-rw-r--r--libXt/man/XtMakeGeometryRequest.man478
1 files changed, 237 insertions, 241 deletions
diff --git a/libXt/man/XtMakeGeometryRequest.man b/libXt/man/XtMakeGeometryRequest.man
index 4bb0343d4..daf10d8d0 100644
--- a/libXt/man/XtMakeGeometryRequest.man
+++ b/libXt/man/XtMakeGeometryRequest.man
@@ -1,241 +1,237 @@
-.\" $Xorg: XtMakGReq.man,v 1.3 2000/08/17 19:42:01 cpqbld Exp $
-.\"
-.\" 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.
-.\"
-.\" $XFree86: xc/doc/man/Xt/XtMakGReq.man,v 1.3 2001/02/09 03:47:51 tsi Exp $
-.\"
-.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 XtMake-Geometry-Request XtMake-Resize-Request 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 XtMakeGeometryRequest __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
-.SH NAME
-XtMakeGeometryRequest, XtMakeResizeRequest \- make geometry manager request
-.SH SYNTAX
-.HP
-XtGeometryResult XtMakeGeometryRequest(Widget \fIw\fP, XtWidgetGeometry
-*\fIrequest\fP, XtWidgetGeometry *\fIreply_return\fP);
-.HP
-XtGeometryResult XtMakeResizeRequest(Widget \fIw\fP, Dimension \fIwidth\fP,
-\fIheight\fP, Dimension *\fIwidth_return\fP, Dimension *\fIheight_return\fP);
-.SH ARGUMENTS
-.IP \fIreply_return\fP 1i
-Returns the allowed widget size or may be NULL
-if the requesting widget is not interested in handling
-.ZN XtGeometryAlmost .
-.IP \fIrequest\fP 1i
-Specifies the desired widget geometry (size, position, border width,
-and stacking order).
-.ds Wi that is making the request
-.IP \fIw\fP 1i
-Specifies the widget \*(Wi.
-.IP \fIwidth_return\fP 1i
-.br
-.ns
-.IP \fIheight_return\fP 1i
-Return the allowed widget width and height.
-.SH DESCRIPTION
-Depending on the condition,
-.ZN XtMakeGeometryRequest
-performs the following:
-.IP \(bu 5
-If the widget is unmanaged or the widget's parent is not realized,
-it makes the changes and returns
-.ZN XtGeometryYes .
-.IP \(bu 5
-If the parent is not a subclass of
-.ZN compositeWidgetClass
-or the parent's geometry_manager is NULL,
-it issues an error.
-.IP \(bu 5
-If the widget's being_destroyed field is
-.ZN True ,
-it returns
-.ZN XtGeometryNo .
-.IP \(bu 5
-If the widget x, y, width, height and border_width fields are
-all equal to the requested values,
-it returns
-.ZN XtGeometryYes ;
-otherwise, it calls the parent's geometry_manager procedure
-with the given parameters.
-.IP \(bu 5
-If the parent's geometry manager returns
-.ZN XtGeometryYes
-and if
-.ZN XtCWQueryOnly
-is not set in the request_mode
-and if the widget is realized,
-.ZN XtMakeGeometryRequest
-calls the
-.ZN XConfigureWindow
-Xlib function to reconfigure the widget's window (set its size, location,
-and stacking order as appropriate).
-.IP \(bu 5
-If the geometry manager returns
-.ZN XtGeometryDone ,
-the change has been approved and actually has been done.
-In this case,
-.ZN XtMakeGeometryRequest
-does no configuring and returns
-.ZN XtGeometryYes .
-.ZN XtMakeGeometryRequest
-never returns
-.ZN XtGeometryDone .
-.LP
-Otherwise,
-.ZN XtMakeGeometryRequest
-returns the resulting value from the parent's geometry manager.
-.LP
-Children of primitive widgets are always unmanaged; thus,
-.ZN XtMakeGeometryRequest
-always returns
-.ZN XtGeometryYes
-when called by a child of a primitive widget.
-.LP
-The
-.ZN XtMakeResizeRequest
-function, a simple interface to
-.ZN XtMakeGeometryRequest ,
-creates a
-.ZN XtWidgetGeometry
-structure and specifies that width and height should change.
-The geometry manager is free to modify any of the other window attributes
-(position or stacking order) to satisfy the resize request.
-If the return value is
-.ZN XtGeometryAlmost ,
-width_return and height_return contain a compromise width and height.
-If these are acceptable,
-the widget should immediately make an
-.ZN XtMakeResizeRequest
-and request that the compromise width and height be applied.
-If the widget is not interested in
-.ZN XtGeometryAlmost
-replies,
-it can pass NULL for width_return and height_return.
-.SH "SEE ALSO"
-XtConfigureWidget(3Xt),
-XtQueryGeometery(3Xt)
-.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 XtMake-Geometry-Request XtMake-Resize-Request 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 XtMakeGeometryRequest __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
+.SH NAME
+XtMakeGeometryRequest, XtMakeResizeRequest \- make geometry manager request
+.SH SYNTAX
+.HP
+XtGeometryResult XtMakeGeometryRequest(Widget \fIw\fP, XtWidgetGeometry
+*\fIrequest\fP, XtWidgetGeometry *\fIreply_return\fP);
+.HP
+XtGeometryResult XtMakeResizeRequest(Widget \fIw\fP, Dimension \fIwidth\fP,
+\fIheight\fP, Dimension *\fIwidth_return\fP, Dimension *\fIheight_return\fP);
+.SH ARGUMENTS
+.IP \fIreply_return\fP 1i
+Returns the allowed widget size or may be NULL
+if the requesting widget is not interested in handling
+.ZN XtGeometryAlmost .
+.IP \fIrequest\fP 1i
+Specifies the desired widget geometry (size, position, border width,
+and stacking order).
+.ds Wi that is making the request
+.IP \fIw\fP 1i
+Specifies the widget \*(Wi.
+.IP \fIwidth_return\fP 1i
+.br
+.ns
+.IP \fIheight_return\fP 1i
+Return the allowed widget width and height.
+.SH DESCRIPTION
+Depending on the condition,
+.ZN XtMakeGeometryRequest
+performs the following:
+.IP \(bu 5
+If the widget is unmanaged or the widget's parent is not realized,
+it makes the changes and returns
+.ZN XtGeometryYes .
+.IP \(bu 5
+If the parent is not a subclass of
+.ZN compositeWidgetClass
+or the parent's geometry_manager is NULL,
+it issues an error.
+.IP \(bu 5
+If the widget's being_destroyed field is
+.ZN True ,
+it returns
+.ZN XtGeometryNo .
+.IP \(bu 5
+If the widget x, y, width, height and border_width fields are
+all equal to the requested values,
+it returns
+.ZN XtGeometryYes ;
+otherwise, it calls the parent's geometry_manager procedure
+with the given parameters.
+.IP \(bu 5
+If the parent's geometry manager returns
+.ZN XtGeometryYes
+and if
+.ZN XtCWQueryOnly
+is not set in the request_mode
+and if the widget is realized,
+.ZN XtMakeGeometryRequest
+calls the
+.ZN XConfigureWindow
+Xlib function to reconfigure the widget's window (set its size, location,
+and stacking order as appropriate).
+.IP \(bu 5
+If the geometry manager returns
+.ZN XtGeometryDone ,
+the change has been approved and actually has been done.
+In this case,
+.ZN XtMakeGeometryRequest
+does no configuring and returns
+.ZN XtGeometryYes .
+.ZN XtMakeGeometryRequest
+never returns
+.ZN XtGeometryDone .
+.LP
+Otherwise,
+.ZN XtMakeGeometryRequest
+returns the resulting value from the parent's geometry manager.
+.LP
+Children of primitive widgets are always unmanaged; thus,
+.ZN XtMakeGeometryRequest
+always returns
+.ZN XtGeometryYes
+when called by a child of a primitive widget.
+.LP
+The
+.ZN XtMakeResizeRequest
+function, a simple interface to
+.ZN XtMakeGeometryRequest ,
+creates a
+.ZN XtWidgetGeometry
+structure and specifies that width and height should change.
+The geometry manager is free to modify any of the other window attributes
+(position or stacking order) to satisfy the resize request.
+If the return value is
+.ZN XtGeometryAlmost ,
+width_return and height_return contain a compromise width and height.
+If these are acceptable,
+the widget should immediately make an
+.ZN XtMakeResizeRequest
+and request that the compromise width and height be applied.
+If the widget is not interested in
+.ZN XtGeometryAlmost
+replies,
+it can pass NULL for width_return and height_return.
+.SH "SEE ALSO"
+XtConfigureWidget(__libmansuffix__),
+XtQueryGeometery(__libmansuffix__)
+.br
+\fI\*(xT\fP
+.br
+\fI\*(xL\fP