summaryrefslogtreecommitdiffstats
path: root/doc/Tcl_Main.3
diff options
context:
space:
mode:
authorhobbs <hobbs@noemail.net>2000-11-03 20:20:55 (GMT)
committerhobbs <hobbs@noemail.net>2000-11-03 20:20:55 (GMT)
commita9876c8995a74f2ba4d8f9f23532287856bb2a73 (patch)
treee15322f3d2789b0b61b42e36c35abd56a8ad574a /doc/Tcl_Main.3
parent631399293c15fde54158cd7d48a07cf8025908dc (diff)
downloadtcl-a9876c8995a74f2ba4d8f9f23532287856bb2a73.zip
tcl-a9876c8995a74f2ba4d8f9f23532287856bb2a73.tar.gz
tcl-a9876c8995a74f2ba4d8f9f23532287856bb2a73.tar.bz2
doc/Tcl_Main.3: added docs for Tcl_SetMainLoop
FossilOrigin-Name: 96b3bbccbcff647ad8a94269aa60d2124809286b
Diffstat (limited to 'doc/Tcl_Main.3')
-rw-r--r--doc/Tcl_Main.332
1 files changed, 26 insertions, 6 deletions
diff --git a/doc/Tcl_Main.3 b/doc/Tcl_Main.3
index 0979994..fb266d9 100644
--- a/doc/Tcl_Main.3
+++ b/doc/Tcl_Main.3
@@ -1,22 +1,25 @@
'\"
'\" Copyright (c) 1994 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
+'\" Copyright (c) 2000 Ajuba Solutions.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: Tcl_Main.3,v 1.2 1998/09/14 18:39:50 stanton Exp $
+'\" RCS: @(#) $Id: Tcl_Main.3,v 1.3 2000/11/03 20:20:55 hobbs Exp $
'\"
.so man.macros
-.TH Tcl_Main 3 7.4 Tcl "Tcl Library Procedures"
+.TH Tcl_Main 3 8.4 Tcl "Tcl Library Procedures"
.BS
.SH NAME
-Tcl_Main \- main program for Tcl-based applications
+Tcl_Main, Tcl_SetMainLoop \- main program and event loop definition for Tcl-based applications
.SH SYNOPSIS
.nf
\fB#include <tcl.h>\fR
.sp
\fBTcl_Main\fR(\fIargc, argv, appInitProc\fR)
+.sp
+\fBTcl_SetMainLoop\fR(\fImainLoopProc\fR)
.SH ARGUMENTS
.AS Tcl_AppInitProc *appInitProc
.AP int argc in
@@ -26,6 +29,8 @@ Array of strings containing command-line arguments.
.AP Tcl_AppInitProc *appInitProc in
Address of an application-specific initialization procedure.
The value for this argument is usually \fBTcl_AppInit\fR.
+.AP Tcl_MainLoopProc *mainLoopProc in
+Address of an application-specific event loop procedure.
.BE
.SH DESCRIPTION
@@ -53,9 +58,24 @@ that matches the type \fBTcl_AppInitProc\fR:
.CS
typedef int Tcl_AppInitProc(Tcl_Interp *\fIinterp\fR);
.CE
-\fIAppInitProc\fR is almost always a pointer to \fBTcl_AppInit\fR;
-for more details on this procedure, see the documentation
-for \fBTcl_AppInit\fR.
+
+\fIAppInitProc\fR is almost always a pointer to \fBTcl_AppInit\fR; for more
+details on this procedure, see the documentation for \fBTcl_AppInit\fR.
+When the \fIappInitProc\fR is finished, the startup script will be
+evaluated. If none exists, then an interactive prompt is provided.
+.PP
+.VS 8.4
+\fBTcl_SetMainLoop\fR allows setting an event loop procedure to be run.
+This allows, for example, Tk to be dynamically loaded and set its event
+loop. The event loop will run following the startup script. If you
+are in interactive mode, setting the main loop procedure will cause the
+prompt to become fileevent based and then the loop procedure is called.
+The main loop procedure must have an interface that matches the type
+\fBTcl_MainLoopProc\fR:
+.CS
+typedef void Tcl_MainLoopProc(void);
+.CE
+.VE 8.4
.SH KEYWORDS
application-specific initialization, command-line arguments, main program