summaryrefslogtreecommitdiffstats
path: root/doc/MapWindow.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/MapWindow.3')
-rw-r--r--doc/MapWindow.353
1 files changed, 53 insertions, 0 deletions
diff --git a/doc/MapWindow.3 b/doc/MapWindow.3
new file mode 100644
index 0000000..802ef7b
--- /dev/null
+++ b/doc/MapWindow.3
@@ -0,0 +1,53 @@
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" SCCS: @(#) MapWindow.3 1.12 97/01/29 08:50:08
+'\"
+.so man.macros
+.TH Tk_MapWindow 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_MapWindow, Tk_UnmapWindow \- map or unmap a window
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Tk_Window
+\fBTk_MapWindow\fR(\fItkwin\fR)
+.sp
+\fBTk_UnmapWindow\fR(\fItkwin\fR)
+.SH ARGUMENTS
+.AS Tk_Window parent
+.AP Tk_Window tkwin in
+Token for window.
+.BE
+
+.SH DESCRIPTION
+.PP
+These procedures may be used to map and unmap windows
+managed by Tk. \fBTk_MapWindow\fR maps the window given
+by \fItkwin\fR, and also creates an X window corresponding
+to \fItkwin\fR if it doesn't already exist. See the
+\fBTk_CreateWindow\fR manual entry for information on
+deferred window creation.
+\fBTk_UnmapWindow\fR unmaps \fItkwin\fR's window
+from the screen.
+.PP
+If \fItkwin\fR is a child window (i.e. \fBTk_CreateChildWindow\fR was
+used to create it), then event handlers interested in map and unmap events
+are invoked immediately. If \fItkwin\fR isn't an internal window,
+then the event handlers will be invoked later, after X has seen
+the request and returned an event for it.
+.PP
+These procedures should be used in place of the X procedures
+\fBXMapWindow\fR and \fBXUnmapWindow\fR, since they update
+Tk's local data structure for \fItkwin\fR. Applications
+using Tk should not invoke \fBXMapWindow\fR and \fBXUnmapWindow\fR
+directly.
+
+.SH KEYWORDS
+map, unmap, window