man/XtConfigureWidget.man

   1 .\" Copyright 1993 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be
  12 .\" included in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .ds tk X Toolkit
  28 .ds xT X Toolkit Intrinsics \- C Language Interface
  29 .ds xI Intrinsics
  30 .ds xW X Toolkit Athena Widgets \- C Language Interface
  31 .ds xL Xlib \- C Language X Interface
  32 .ds xC Inter-Client Communication Conventions Manual
  33 .ds Rn 3
  34 .ds Vn 2.2
  35 .hw XtConfigure-Widget XtMove-Widget XtResize-Widget wid-get
  36 .na
  37 .de Ds
  38 .nf
  39 .\\$1D \\$2 \\$1
  40 .ft CW
  41 .ps \\n(PS
  42 .\".if \\n(VS>=40 .vs \\n(VSu
  43 .\".if \\n(VS<=39 .vs \\n(VSp
  44 ..
  45 .de De
  46 .ce 0
  47 .if \\n(BD .DF
  48 .nr BD 0
  49 .in \\n(OIu
  50 .if \\n(TM .ls 2
  51 .sp \\n(DDu
  52 .fi
  53 ..
  54 .de IN          \" send an index entry to the stderr
  55 ..
  56 .de Pn
  57 .ie t \\$1\fB\^\\$2\^\fR\\$3
  58 .el \\$1\fI\^\\$2\^\fP\\$3
  59 ..
  60 .de ZN
  61 .ie t \fB\^\\$1\^\fR\\$2
  62 .el \fI\^\\$1\^\fP\\$2
  63 ..
  64 .ny0
  65 .TH XtConfigureWidget __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  66 .SH NAME
  67 XtConfigureWidget, XtMoveWidget, XtResizeWidget \- move and resize widgets
  68 .SH SYNTAX
  69 .HP
  70 void XtConfigureWidget(Widget \fIw\fP, Position \fIx\fP, Position \fIy\fP,
  71 Dimension \fIwidth\fP, Dimension \fIheight\fP, Dimension \fIborder_width\fP);
  72 .HP
  73 void XtMoveWidget(Widget \fIw\fP, Position \fIx\fP, Position \fIy\fP);
  74 .HP
  75 void XtResizeWidget(Widget \fIw\fP, Dimension \fIwidth\fP, Dimension
  76 \fIheight\fP, Dimension \fIborder_width\fP);
  77 .HP
  78 void XtResizeWindow(Widget \fIw\fP);
  79 .SH ARGUMENTS
  80 .IP \fIwidth\fP 1i
  81 .br
  82 .ns
  83 .IP \fIheight\fP 1i
  84 .br
  85 .ns
  86 .IP \fIborder_width\fP 1i
  87 Specify the new widget size.
  88 .IP \fIw\fP 1i
  89 Specifies the widget.
  90 .ds Nu new widget
  91 .IP \fIx\fP 1i
  92 .br
  93 .ns
  94 .IP \fIy\fP 1i
  95 Specify the \*(Nu x and y coordinates.
  96 .SH DESCRIPTION
  97 The
  98 .ZN XtConfigureWidget
  99 function returns immediately if the specified geometry fields
 100 are the same as the old values.
 101 Otherwise,
 102 .ZN XtConfigureWidget
 103 writes the new x, y, width, height, and border_width values
 104 into the widget and, if the widget is realized, makes an Xlib
 105 .ZN XConfigureWindow
 106 call on the widget's window.
 107 .LP
 108 If either the new width or height is different from its old value,
 109 .ZN XtConfigureWidget
 110 calls the widget's resize procedure to notify it of the size change;
 111 otherwise, it simply returns.
 112 .LP
 113 The
 114 .ZN XtMoveWidget
 115 function returns immediately if the specified geometry fields
 116 are the same as the old values.
 117 Otherwise,
 118 .ZN XtMoveWidget
 119 writes the new x and y values into the widget
 120 and, if the widget is realized, issues an Xlib
 121 .ZN XMoveWindow
 122 call on the widget's window.
 123 .LP
 124 The
 125 .ZN XtResizeWidget
 126 function returns immediately if the specified geometry fields
 127 are the same as the old values.
 128 Otherwise,
 129 .ZN XtResizeWidget
 130 writes the new width, height, and border_width values into
 131 the widget and, if the widget is realized, issues an
 132 .ZN XConfigureWindow
 133 call on the widget's window.
 134 .LP
 135 If the new width or height are different from the old values,
 136 .ZN XtResizeWidget
 137 calls the widget's resize procedure to notify it of the size change.
 138 .LP
 139 The
 140 .ZN XtResizeWindow
 141 function calls the
 142 .ZN XConfigureWindow
 143 Xlib function to make the window of the specified widget match its width,
 144 height, and border width.
 145 This request is done unconditionally because there is no way to tell if these
 146 values match the current values.
 147 Note that the widget's resize procedure is not called.
 148 .LP
 149 There are very few times to use
 150 .ZN XtResizeWindow ;
 151 instead, you should use
 152 .ZN XtResizeWidget .
 153 .SH "SEE ALSO"
 154 XtMakeGeometryRequest(__libmansuffix__),
 155 XtQueryGeometry(__libmansuffix__)
 156 .br
 157 \fI\*(xT\fP
 158 .br
 159 \fI\*(xL\fP