Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Tk_SetMinimumRequestSize.3
CommitLineData
920dae64
AT
1'\"
2'\" Copyright (c) 1990-1994 The Regents of the University of California.
3'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
4'\"
5'\" See the file "license.terms" for information on usage and redistribution
6'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7'\"
8'\"
9'\" RCS: @(#) $Id: GeomReq.3,v 1.3 2001/09/26 20:25:17 pspjuth Exp $
10'\"
11'\" The definitions below are for supplemental macros used in Tcl/Tk
12'\" manual entries.
13'\"
14'\" .AP type name in/out ?indent?
15'\" Start paragraph describing an argument to a library procedure.
16'\" type is type of argument (int, etc.), in/out is either "in", "out",
17'\" or "in/out" to describe whether procedure reads or modifies arg,
18'\" and indent is equivalent to second arg of .IP (shouldn't ever be
19'\" needed; use .AS below instead)
20'\"
21'\" .AS ?type? ?name?
22'\" Give maximum sizes of arguments for setting tab stops. Type and
23'\" name are examples of largest possible arguments that will be passed
24'\" to .AP later. If args are omitted, default tab stops are used.
25'\"
26'\" .BS
27'\" Start box enclosure. From here until next .BE, everything will be
28'\" enclosed in one large box.
29'\"
30'\" .BE
31'\" End of box enclosure.
32'\"
33'\" .CS
34'\" Begin code excerpt.
35'\"
36'\" .CE
37'\" End code excerpt.
38'\"
39'\" .VS ?version? ?br?
40'\" Begin vertical sidebar, for use in marking newly-changed parts
41'\" of man pages. The first argument is ignored and used for recording
42'\" the version when the .VS was added, so that the sidebars can be
43'\" found and removed when they reach a certain age. If another argument
44'\" is present, then a line break is forced before starting the sidebar.
45'\"
46'\" .VE
47'\" End of vertical sidebar.
48'\"
49'\" .DS
50'\" Begin an indented unfilled display.
51'\"
52'\" .DE
53'\" End of indented unfilled display.
54'\"
55'\" .SO
56'\" Start of list of standard options for a Tk widget. The
57'\" options follow on successive lines, in four columns separated
58'\" by tabs.
59'\"
60'\" .SE
61'\" End of list of standard options for a Tk widget.
62'\"
63'\" .OP cmdName dbName dbClass
64'\" Start of description of a specific option. cmdName gives the
65'\" option's name as specified in the class command, dbName gives
66'\" the option's name in the option database, and dbClass gives
67'\" the option's class in the option database.
68'\"
69'\" .UL arg1 arg2
70'\" Print arg1 underlined, then print arg2 normally.
71'\"
72'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73'\"
74'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
75.if t .wh -1.3i ^B
76.nr ^l \n(.l
77.ad b
78'\" # Start an argument description
79.de AP
80.ie !"\\$4"" .TP \\$4
81.el \{\
82. ie !"\\$2"" .TP \\n()Cu
83. el .TP 15
84.\}
85.ta \\n()Au \\n()Bu
86.ie !"\\$3"" \{\
87\&\\$1 \\fI\\$2\\fP (\\$3)
88.\".b
89.\}
90.el \{\
91.br
92.ie !"\\$2"" \{\
93\&\\$1 \\fI\\$2\\fP
94.\}
95.el \{\
96\&\\fI\\$1\\fP
97.\}
98.\}
99..
100'\" # define tabbing values for .AP
101.de AS
102.nr )A 10n
103.if !"\\$1"" .nr )A \\w'\\$1'u+3n
104.nr )B \\n()Au+15n
105.\"
106.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
107.nr )C \\n()Bu+\\w'(in/out)'u+2n
108..
109.AS Tcl_Interp Tcl_CreateInterp in/out
110'\" # BS - start boxed text
111'\" # ^y = starting y location
112'\" # ^b = 1
113.de BS
114.br
115.mk ^y
116.nr ^b 1u
117.if n .nf
118.if n .ti 0
119.if n \l'\\n(.lu\(ul'
120.if n .fi
121..
122'\" # BE - end boxed text (draw box now)
123.de BE
124.nf
125.ti 0
126.mk ^t
127.ie n \l'\\n(^lu\(ul'
128.el \{\
129.\" Draw four-sided box normally, but don't draw top of
130.\" box if the box started on an earlier page.
131.ie !\\n(^b-1 \{\
132\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133.\}
134.el \}\
135\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
136.\}
137.\}
138.fi
139.br
140.nr ^b 0
141..
142'\" # VS - start vertical sidebar
143'\" # ^Y = starting y location
144'\" # ^v = 1 (for troff; for nroff this doesn't matter)
145.de VS
146.if !"\\$2"" .br
147.mk ^Y
148.ie n 'mc \s12\(br\s0
149.el .nr ^v 1u
150..
151'\" # VE - end of vertical sidebar
152.de VE
153.ie n 'mc
154.el \{\
155.ev 2
156.nf
157.ti 0
158.mk ^t
159\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
160.sp -1
161.fi
162.ev
163.\}
164.nr ^v 0
165..
166'\" # Special macro to handle page bottom: finish off current
167'\" # box/sidebar if in box/sidebar mode, then invoked standard
168'\" # page bottom macro.
169.de ^B
170.ev 2
171'ti 0
172'nf
173.mk ^t
174.if \\n(^b \{\
175.\" Draw three-sided box if this is the box's first page,
176.\" draw two sides but no top otherwise.
177.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
178.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179.\}
180.if \\n(^v \{\
181.nr ^x \\n(^tu+1v-\\n(^Yu
182\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
183.\}
184.bp
185'fi
186.ev
187.if \\n(^b \{\
188.mk ^y
189.nr ^b 2
190.\}
191.if \\n(^v \{\
192.mk ^Y
193.\}
194..
195'\" # DS - begin display
196.de DS
197.RS
198.nf
199.sp
200..
201'\" # DE - end display
202.de DE
203.fi
204.RE
205.sp
206..
207'\" # SO - start of list of standard options
208.de SO
209.SH "STANDARD OPTIONS"
210.LP
211.nf
212.ta 5.5c 11c
213.ft B
214..
215'\" # SE - end of list of standard options
216.de SE
217.fi
218.ft R
219.LP
220See the \\fBoptions\\fR manual entry for details on the standard options.
221..
222'\" # OP - start of full description for a single option
223.de OP
224.LP
225.nf
226.ta 4c
227Command-Line Name: \\fB\\$1\\fR
228Database Name: \\fB\\$2\\fR
229Database Class: \\fB\\$3\\fR
230.fi
231.IP
232..
233'\" # CS - begin code excerpt
234.de CS
235.RS
236.nf
237.ta .25i .5i .75i 1i
238..
239'\" # CE - end code excerpt
240.de CE
241.fi
242.RE
243..
244.de UL
245\\$1\l'|0\(ul'\\$2
246..
247.TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures"
248.BS
249.SH NAME
250Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetInternalBorderEx \- specify desired geometry or internal border for a window
251.SH SYNOPSIS
252.nf
253\fB#include <tk.h>\fR
254.sp
255\fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR)
256.sp
257\fBTk_SetMinimumRequestSize\fR(\fItkwin, minWidth, minHeight\fR)
258.sp
259\fBTk_SetInternalBorder\fR(\fItkwin, width\fR)
260.sp
261\fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR)
262.SH ARGUMENTS
263.AS baseHeight clientData
264.AP Tk_Window tkwin in
265Window for which geometry is being requested.
266.AP int reqWidth in
267Desired width for \fItkwin\fR, in pixel units.
268.AP int reqHeight in
269Desired height for \fItkwin\fR, in pixel units.
270.AP int minWidth in
271Desired minimum requested width for \fItkwin\fR, in pixel units.
272.AP int minHeight in
273Desired minimum requested height for \fItkwin\fR, in pixel units.
274.AP int width in
275Space to leave for internal border for \fItkwin\fR, in pixel units.
276.AP int left in
277Space to leave for left side of internal border for \fItkwin\fR, in pixel units.
278.AP int right in
279Space to leave for right side of internal border for \fItkwin\fR, in pixel units.
280.AP int top in
281Space to leave for top side of internal border for \fItkwin\fR, in pixel units.
282.AP int bottom in
283Space to leave for bottom side of internal border for \fItkwin\fR, in pixel units.
284.BE
285
286.SH DESCRIPTION
287.PP
288\fBTk_GeometryRequest\fR is called by widget code to indicate its
289preference for the dimensions of a particular window. The arguments
290to \fBTk_GeometryRequest\fR are made available to the geometry
291manager for the window, which then decides on the actual geometry
292for the window. Although geometry managers generally try to satisfy
293requests made to \fBTk_GeometryRequest\fR, there is no guarantee that
294this will always be possible. Widget code should not assume that
295a geometry request will be satisfied until it receives a
296\fBConfigureNotify\fR event indicating that the geometry change has
297occurred. Widget code should never call procedures like
298\fBTk_ResizeWindow\fR directly. Instead, it should invoke
299\fBTk_GeometryRequest\fR and leave the final geometry decisions to
300the geometry manager.
301.PP
302If \fItkwin\fR is a top-level window, then the geometry information
303will be passed to the window manager using the standard ICCCM protocol.
304.PP
305\fBTk_SetInternalBorder\fR is called by widget code to indicate that
306the widget has an internal border. This means that the widget draws
307a decorative border inside the window instead of using the standard
308X borders, which are external to the window's area. For example,
309internal borders are used to draw 3-D effects. \fIWidth\fR
310specifies the width of the border in pixels. Geometry managers will
311use this information to avoid placing any children of \fItkwin\fR
312overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area.
313.PP
314\fBTk_SetInternalBorderEx\fR works like \fBTk_SetInternalBorder\fR
315but lets you specify different widths for different sides of the window.
316.PP
317\fBTk_SetMinimumRequestSize\fR is called by widget code to indicate
318that a geometry manager should request at least this size for the
319widget. This allows a widget to have some control over its size when
320a propagating geometry manager is used inside it.
321.PP
322The information specified in calls to \fBTk_GeometryRequest\fR,
323\fBTk_SetMinimumRequestSize\fR, \fBTk_SetInternalBorder\fR and
324\fBTk_SetInternalBorderEx\fR can be retrieved using the macros
325\fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, \fBTk_MinReqWidth\fR,
326\fBTk_MinReqHeight\fR, \fBTk_MinReqWidth\fR, \fBTk_InternalBorderLeft\fR,
327\fBTk_InternalBorderRight\fR, \fBTk_InternalBorderTop\fR and
328\fBTk_InternalBorderBottom\fR.
329See the \fBTk_WindowId\fR manual entry for details.
330
331.SH KEYWORDS
332geometry, request