summaryrefslogtreecommitdiffstats
path: root/doc/MainWin.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/MainWin.3')
-rw-r--r--doc/MainWin.322
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/MainWin.3 b/doc/MainWin.3
index c913b29..b878cb0 100644
--- a/doc/MainWin.3
+++ b/doc/MainWin.3
@@ -5,19 +5,24 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: MainWin.3,v 1.2 1998/09/14 18:22:52 stanton Exp $
+'\" RCS: @(#) $Id: MainWin.3,v 1.3 2000/04/25 01:42:18 ericm Exp $
'\"
.so man.macros
.TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures"
.BS
.SH NAME
-Tk_MainWindow \- find the main window for an application
+Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main
+window information
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
Tk_Window
\fBTk_MainWindow\fR(\fIinterp\fR)
+.sp
+int
+\fBTk_GetNumMainWindows\fR()
+
.SH ARGUMENTS
.AS Tcl_Interp *pathName
.AP Tcl_Interp *interp in/out
@@ -26,11 +31,16 @@ Interpreter associated with the application.
.SH DESCRIPTION
.PP
+A main window is a special kind of toplevel window used as the
+outermost window in an application.
+.PP
If \fIinterp\fR is associated with a Tk application then \fBTk_MainWindow\fR
-returns the application's main window.
-If there is no Tk application associated with \fIinterp\fR then
-\fBTk_MainWindow\fR returns NULL and leaves an error message
-in \fIinterp->result\fR.
+returns the application's main window. If there is no Tk application
+associated with \fIinterp\fR then \fBTk_MainWindow\fR returns NULL and
+leaves an error message in \fIinterp->result\fR.
+.PP
+\fBTk_GetNumMainWindows\fR returns a count of the number of main
+windows currently open in the process.
.SH KEYWORDS
application, main window