summaryrefslogtreecommitdiff
path: root/tk/doc/MainWin.3
diff options
context:
space:
mode:
Diffstat (limited to 'tk/doc/MainWin.3')
-rw-r--r--tk/doc/MainWin.336
1 files changed, 36 insertions, 0 deletions
diff --git a/tk/doc/MainWin.3 b/tk/doc/MainWin.3
new file mode 100644
index 00000000000..914a13a8f2c
--- /dev/null
+++ b/tk/doc/MainWin.3
@@ -0,0 +1,36 @@
+'\"
+'\" Copyright (c) 1990 The Regents of the University of California.
+'\" Copyright (c) 1994-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$
+'\"
+.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
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+Tk_Window
+\fBTk_MainWindow\fR(\fIinterp\fR)
+.SH ARGUMENTS
+.AS Tcl_Interp *pathName
+.AP Tcl_Interp *interp in/out
+Interpreter associated with the application.
+.BE
+
+.SH DESCRIPTION
+.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.
+
+.SH KEYWORDS
+application, main window