173 lines
6.7 KiB
Groff
173 lines
6.7 KiB
Groff
|
'\"
|
||
|
|
'\" Copyright (c) 1990-1993 The Regents of the University of California.
|
||
|
|
'\" All rights reserved.
|
||
|
|
'\"
|
||
|
|
'\" Permission is hereby granted, without written agreement and without
|
||
|
|
'\" license or royalty fees, to use, copy, modify, and distribute this
|
||
|
|
'\" documentation for any purpose, provided that the above copyright
|
||
|
|
'\" notice and the following two paragraphs appear in all copies.
|
||
|
|
'\"
|
||
|
|
'\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
|
||
|
|
'\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
|
||
|
|
'\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
|
||
|
|
'\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
'\"
|
||
|
|
'\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
|
||
|
|
'\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
|
||
|
|
'\" AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
|
||
|
|
'\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
|
||
|
|
'\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
|
||
|
|
'\"
|
||
|
|
'\" $Header: /user6/ouster/wish/man/RCS/ConfigWind.3,v 1.14 93/07/07 16:27:29 ouster Exp $ SPRITE (Berkeley)
|
||
|
|
'\"
|
||
|
|
.so man.macros
|
||
|
|
.HS Tk_ConfigureWindow tkc 3.3
|
||
|
|
.BS
|
||
|
|
.SH NAME
|
||
|
|
.na
|
||
|
|
Tk_ConfigureWindow, Tk_MoveWindow, Tk_ResizeWindow, Tk_MoveResizeWindow, Tk_SetWindowBorderWidth Tk_ChangeWindowAttributes, Tk_SetWindowBackground, Tk_SetWindowBackgroundPixmap, Tk_SetWindowBorder, Tk_SetWindowBorderPixmap, Tk_SetWindowColormap, Tk_DefineCursor, Tk_UndefineCursor \- change window configuration or attributes
|
||
|
|
.ad
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
\fB#include <tk.h>\fR
|
||
|
|
.sp
|
||
|
|
\fBTk_ConfigureWindow\fR(\fItkwin, valueMask, valuePtr\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_MoveWindow\fR(\fItkwin, x, y\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_ResizeWindow\fR(\fItkwin, width, height\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_MoveResizeWindow\fR(\fItkwin, x, y, width, height\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_SetWindowBorderWidth\fR(\fItkwin, borderWidth\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_ChangeWindowAttributes\fR(\fItkwin, valueMask, attsPtr\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_SetWindowBackground\fR(\fItkwin, pixel\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_SetWindowBackgroundPixmap\fR(\fItkwin, pixmap\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_SetWindowBorder\fR(\fItkwin, pixel\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_SetWindowBorderPixmap\fR(\fItkwin, pixmap\fR)
|
||
|
|
.sp
|
||
|
|
.VS
|
||
|
|
\fBTk_SetWindowColormap\fR(\fItkwin, colormap\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_DefineCursor\fR(\fItkwin, cursor\fR)
|
||
|
|
.sp
|
||
|
|
\fBTk_UndefineCursor\fR(\fItkwin\fR)
|
||
|
|
.VE
|
||
|
|
.SH ARGUMENTS
|
||
|
|
.AS XSetWindowAttributes borderWidth
|
||
|
|
.AP Tk_Window tkwin in
|
||
|
|
Token for window.
|
||
|
|
.AP "unsigned int" valueMask in
|
||
|
|
OR-ed mask of values like \fBCWX\fR or \fBCWBorderPixel\fR,
|
||
|
|
indicating which fields of \fI*valuePtr\fR or \fI*attsPtr\fR to use.
|
||
|
|
.AP XWindowChanges *valuePtr in
|
||
|
|
Points to a structure containing new values for the configuration
|
||
|
|
parameters selected by \fIvalueMask\fR. Fields not selected
|
||
|
|
by \fIvalueMask\fR are ignored.
|
||
|
|
.AP int x in
|
||
|
|
New x-coordinate for \fItkwin\fR's top left pixel (including
|
||
|
|
border, if any) within tkwin's parent.
|
||
|
|
.AP int y in
|
||
|
|
New y-coordinate for \fItkwin\fR's top left pixel (including
|
||
|
|
border, if any) within tkwin's parent.
|
||
|
|
.AP "unsigned int" width in
|
||
|
|
New width for \fItkwin\fR (interior, not including border).
|
||
|
|
.AP "unsigned int" height in
|
||
|
|
New height for \fItkwin\fR (interior, not including border).
|
||
|
|
.AP "unsigned int" borderWidth in
|
||
|
|
New width for \fItkwin\fR's border.
|
||
|
|
.AP XSetWindowAttributes *attsPtr in
|
||
|
|
Points to a structure containing new values for the attributes
|
||
|
|
given by the \fIvalueMask\fR argument. Attributes not selected
|
||
|
|
by \fIvalueMask\fR are ignored.
|
||
|
|
.AP "unsigned long" pixel in
|
||
|
|
New background or border color for window.
|
||
|
|
.AP Pixmap pixmap in
|
||
|
|
New pixmap to use for background or border of \fItkwin\fR. WARNING:
|
||
|
|
cannot necessarily be deleted immediately, as for Xlib calls. See
|
||
|
|
note below.
|
||
|
|
.AP Colormap colormap in
|
||
|
|
.VS
|
||
|
|
New colormap to use for \fItkwin\fR.
|
||
|
|
.AP Cursor cursor in
|
||
|
|
New cursor to use for \fItkwin\fR. If \fBNone\fR is specified, then
|
||
|
|
\fItkwin\fR will not have its own cursor; it will use the cursor
|
||
|
|
of its parent.
|
||
|
|
.VE
|
||
|
|
.BE
|
||
|
|
|
||
|
|
.SH DESCRIPTION
|
||
|
|
.PP
|
||
|
|
These procedures are analogous to the X library procedures
|
||
|
|
with similar names, such as \fBXConfigureWindow\fR. Each
|
||
|
|
one of the above procedures calls the corresponding X procedure
|
||
|
|
and also saves the configuration information in Tk's local
|
||
|
|
structure for the window. This allows the information to
|
||
|
|
be retrieved quickly by the application (using macros such
|
||
|
|
as \fBTk_X\fR and \fBTk_Height\fR) without having to contact
|
||
|
|
the X server. In addition, if no X window has actually been
|
||
|
|
created for \fItkwin\fR yet, these procedures do not issue
|
||
|
|
X operations or cause event handlers to be invoked; they save
|
||
|
|
the information in Tk's local
|
||
|
|
structure for the window; when the window is created later,
|
||
|
|
the saved information will be used to configure the window.
|
||
|
|
.PP
|
||
|
|
See the X library documentation for details on what these
|
||
|
|
procedures do and how they use their arguments.
|
||
|
|
.PP
|
||
|
|
In the procedures \fBTk_ConfigureWindow\fR, \fBTk_MoveWindow\fR,
|
||
|
|
\fBTk_ResizeWindow\fR, \fBTk_MoveResizeWindow\fR, and
|
||
|
|
\fBTk_SetWindowBorderWidth\fR,
|
||
|
|
if \fItkwin\fR is an internal window then event handlers interested
|
||
|
|
in configure events are invoked immediately, before the procedure
|
||
|
|
returns. If \fItkwin\fR isn't a top-level window
|
||
|
|
then the event handlers will be invoked later, after X has seen
|
||
|
|
the request and returned an event for it.
|
||
|
|
.PP
|
||
|
|
Applications using Tk should never call procedures like
|
||
|
|
\fBXConfigureWindow\fR directly; they should always use the
|
||
|
|
corresponding Tk procedures.
|
||
|
|
.PP
|
||
|
|
.VS
|
||
|
|
The size and location of a window should only be modified by the
|
||
|
|
appropriate geometry manager for that window and never by a window
|
||
|
|
itself (but see \fBTk_MoveToplevelWindow\fR for moving a top-level
|
||
|
|
window).
|
||
|
|
.VE
|
||
|
|
.PP
|
||
|
|
.VS
|
||
|
|
It is not allowable to use \fBTk_ConfigureWindow\fR to change the
|
||
|
|
stacking order of a window (\fIvalueMask\fR may not contain the
|
||
|
|
\fBCWSibling\fR or \fBCWStackMode\fR bits).
|
||
|
|
To change the stacking order, use the procedure \fBTk_RestackWindow\fR.
|
||
|
|
.VE
|
||
|
|
|
||
|
|
.SH BUGS
|
||
|
|
.PP
|
||
|
|
\fBTk_SetWindowBackgroundPixmap\fR and \fBTk_SetWindowBorderPixmap\fR
|
||
|
|
differ slightly from their Xlib counterparts in that the \fIpixmap\fR
|
||
|
|
argument may not necessarily be deleted immediately after calling
|
||
|
|
one of these procedures. This is because \fItkwin\fR's window
|
||
|
|
may not exist yet at the time of the call, in which case \fIpixmap\fR
|
||
|
|
is merely saved and used later when \fItkwin\fR's window is actually
|
||
|
|
created. If you wish to delete \fIpixmap\fR, then call
|
||
|
|
\fBTk_MakeWindowExist\fR first to be sure that \fItkwin\fR's window exists
|
||
|
|
and \fIpixmap\fR has been passed to the X server.
|
||
|
|
.PP
|
||
|
|
.VS
|
||
|
|
A similar problem occurs for the \fIcursor\fR argument passed to
|
||
|
|
\fBTk_DefineCursor\fR. The solution is the same as for pixmaps above:
|
||
|
|
call \fBTk_MakeWindowExist\fR before freeing the cursor.
|
||
|
|
.VE
|
||
|
|
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
Tk_MoveToplevelWindow, Tk_RestackWindow
|
||
|
|
|
||
|
|
.SH KEYWORDS
|
||
|
|
attributes, border, color, configure, height, pixel, pixmap, width, window, x, y
|