Tk_ConfigureWindow (3)
Tk_ConfigureWindow, Tk_MoveWindow, Tk_ResizeWindow, Tk_MoveResizeWindow, Tk_SetWindowBorderWidth, Tk_ChangeWindowAttributes, Tk_SetWindowBackground, Tk_SetWindowBackgroundPixmap, Tk_SetWindowBorder, Tk_SetWindowBorderPixmap, Tk_Set
Tk_DefineCursor, Tk_UndefineCursor - change window configuration or attributes
SYNOPSIS
#include <tk.h>
Tk_ConfigureWindow(tkwin, valueMask, valuePtr)
Tk_MoveWindow(tkwin, x, y)
Tk_ResizeWindow(tkwin, width, height)
Tk_MoveResizeWindow(tkwin, x, y, width, height)
Tk_SetWindowBorderWidth(tkwin, borderWidth)
Tk_ChangeWindowAttributes(tkwin, valueMask, attsPtr)
Tk_SetWindowBackground(tkwin, pixel)
Tk_SetWindowBackgroundPixmap(tkwin, pixmap)
Tk_SetWindowBorder(tkwin, pixel)
Tk_SetWindowBorderPixmap(tkwin, pixmap)
Tk_SetWindowColormap(tkwin, colormap)
Tk_DefineCursor(tkwin, cursor)
Tk_UndefineCursor(tkwin)
ARGUMENTS
XSetWindowAttributes borderWidth
Tk_Window tkwin in
Token for window.
"unsigned int" valueMask in
OR-ed mask of values like CWX or CWBorderPixel,
indicating which fields of *valuePtr or *attsPtr to use.
XWindowChanges *valuePtr in
Points to a structure containing new values for the configuration
parameters selected by valueMask. Fields not selected
by valueMask are ignored.
int x in
New x-coordinate for tkwin's top left pixel (including
border, if any) within tkwin's parent.
int y in
New y-coordinate for tkwin's top left pixel (including
border, if any) within tkwin's parent.
"int" width in
New width for tkwin (interior, not including border).
"int" height in
New height for tkwin (interior, not including border).
"int" borderWidth in
New width for tkwin's border.
XSetWindowAttributes *attsPtr in
Points to a structure containing new values for the attributes
given by the valueMask argument. Attributes not selected
by valueMask are ignored.
"unsigned long" pixel in
New background or border color for window.
Pixmap pixmap in
New pixmap to use for background or border of tkwin. WARNING:
cannot necessarily be deleted immediately, as for Xlib calls. See
note below.
Colormap colormap in
New colormap to use for tkwin.
Tk_Cursor cursor in
New cursor to use for tkwin. If None is specified, then
tkwin will not have its own cursor; it will use the cursor
of its parent.
DESCRIPTION
These procedures are analogous to the X library procedures
with similar names, such as XConfigureWindow. 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 Tk_X and Tk_Height) without having to contact
the X server. In addition, if no X window has actually been
created for tkwin 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.
See the X library documentation for details on what these
procedures do and how they use their arguments.
In the procedures Tk_ConfigureWindow, Tk_MoveWindow,
Tk_ResizeWindow, Tk_MoveResizeWindow, and
Tk_SetWindowBorderWidth,
if tkwin is an internal window then event handlers interested
in configure events are invoked immediately, before the procedure
returns. If tkwin is a top-level window
then the event handlers will be invoked later, after X has seen
the request and returned an event for it.
Applications using Tk should never call procedures like
XConfigureWindow directly; they should always use the
corresponding Tk procedures.
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 Tk_MoveToplevelWindow for moving a top-level
window).
You may not use Tk_ConfigureWindow to change the
stacking order of a window (valueMask may not contain the
CWSibling or CWStackMode bits).
To change the stacking order, use the procedure Tk_RestackWindow.
The procedure Tk_SetWindowColormap will automatically add
tkwin to the TK_COLORMAP_WINDOWS property of its
nearest top-level ancestor if the new colormap is different from
that of tkwin's parent and tkwin isn't already in
the TK_COLORMAP_WINDOWS property.
BUGS
Tk_SetWindowBackgroundPixmap and Tk_SetWindowBorderPixmap
differ slightly from their Xlib counterparts in that the pixmap
argument may not necessarily be deleted immediately after calling
one of these procedures. This is because tkwin's window
may not exist yet at the time of the call, in which case pixmap
is merely saved and used later when tkwin's window is actually
created. If you wish to delete pixmap, then call
Tk_MakeWindowExist first to be sure that tkwin's window exists
and pixmap has been passed to the X server.
A similar problem occurs for the cursor argument passed to
Tk_DefineCursor. The solution is the same as for pixmaps above:
call Tk_MakeWindowExist before freeing the cursor.
SEE ALSO
Tk_MoveToplevelWindow Tk_RestackWindow
KEYWORDS
attributes, border, color, configure, height, pixel, pixmap, width, window, x, y
'\"
'\" Copyright (c) 1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: MeasureChar.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|