| 1 |
578 |
markom |
'\"
|
| 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 |
|
|
'\" RCS: @(#) $Id: SetGrid.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
| 9 |
|
|
'\"
|
| 10 |
|
|
.so man.macros
|
| 11 |
|
|
.TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures"
|
| 12 |
|
|
.BS
|
| 13 |
|
|
.SH NAME
|
| 14 |
|
|
Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing
|
| 15 |
|
|
.SH SYNOPSIS
|
| 16 |
|
|
.nf
|
| 17 |
|
|
\fB#include \fR
|
| 18 |
|
|
.sp
|
| 19 |
|
|
\fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR)
|
| 20 |
|
|
.sp
|
| 21 |
|
|
\fBTk_UnsetGrid\fR(\fItkwin\fR)
|
| 22 |
|
|
.SH ARGUMENTS
|
| 23 |
|
|
.AS Tk_Window heightInc
|
| 24 |
|
|
.AP Tk_Window tkwin in
|
| 25 |
|
|
Token for window.
|
| 26 |
|
|
.AP int reqWidth in
|
| 27 |
|
|
Width in grid units that corresponds to the pixel dimension \fItkwin\fR
|
| 28 |
|
|
has requested via \fBTk_GeometryRequest\fR.
|
| 29 |
|
|
.AP int reqHeight in
|
| 30 |
|
|
Height in grid units that corresponds to the pixel dimension \fItkwin\fR
|
| 31 |
|
|
has requested via \fBTk_GeometryRequest\fR.
|
| 32 |
|
|
.AP int widthInc in
|
| 33 |
|
|
Width of one grid unit, in pixels.
|
| 34 |
|
|
.AP int heightInc in
|
| 35 |
|
|
Height of one grid unit, in pixels.
|
| 36 |
|
|
.BE
|
| 37 |
|
|
|
| 38 |
|
|
.SH DESCRIPTION
|
| 39 |
|
|
.PP
|
| 40 |
|
|
\fBTk_SetGrid\fR turns on gridded geometry management for \fItkwin\fR's
|
| 41 |
|
|
toplevel window and specifies the geometry of the grid.
|
| 42 |
|
|
\fBTk_SetGrid\fR is typically invoked by a widget when its \fBsetGrid\fR
|
| 43 |
|
|
option is true.
|
| 44 |
|
|
It restricts interactive resizing of \fItkwin\fR's toplevel window so
|
| 45 |
|
|
that the space allocated to the toplevel is equal to its requested
|
| 46 |
|
|
size plus or minus even multiples of \fIwidthInc\fR and \fIheightInc\fR.
|
| 47 |
|
|
Furthermore, the \fIreqWidth\fR and \fIreqHeight\fR values are
|
| 48 |
|
|
passed to the window manager so that it can report the window's
|
| 49 |
|
|
size in grid units during interactive resizes.
|
| 50 |
|
|
If \fItkwin\fR's configuration changes (e.g., the size of a grid unit
|
| 51 |
|
|
changes) then the widget should invoke \fBTk_SetGrid\fR again with the new
|
| 52 |
|
|
information.
|
| 53 |
|
|
.PP
|
| 54 |
|
|
\fBTk_UnsetGrid\fR cancels gridded geometry management for
|
| 55 |
|
|
\fItkwin\fR's toplevel window.
|
| 56 |
|
|
.PP
|
| 57 |
|
|
For each toplevel window there can be at most one internal window
|
| 58 |
|
|
with gridding enabled.
|
| 59 |
|
|
If \fBTk_SetGrid\fR or \fBTk_UnsetGrid\fR is invoked when some
|
| 60 |
|
|
other window is already controlling gridding for \fItkwin\fR's
|
| 61 |
|
|
toplevel, the calls for the new window have no effect.
|
| 62 |
|
|
.PP
|
| 63 |
|
|
See the \fBwm\fR manual entry for additional information on gridded geometry
|
| 64 |
|
|
management.
|
| 65 |
|
|
|
| 66 |
|
|
.SH KEYWORDS
|
| 67 |
|
|
grid, window, window manager
|
