summaryrefslogtreecommitdiffstats
path: root/doc/SetAppName.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/SetAppName.3')
-rw-r--r--doc/SetAppName.365
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/SetAppName.3 b/doc/SetAppName.3
new file mode 100644
index 0000000..df2ad30
--- /dev/null
+++ b/doc/SetAppName.3
@@ -0,0 +1,65 @@
+'\"
+'\" Copyright (c) 1994 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: @(#) SetAppName.3 1.13 97/06/10 17:33:48
+'\"
+.so man.macros
+.TH Tk_SetAppName 3 4.0 Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_SetAppName \- Set the name of an application for ``send'' commands
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+char *
+\fBTk_SetAppName\fR(\fItkwin, name\fR)
+.SH ARGUMENTS
+.AS Tk_Window parent
+.AP Tk_Window tkwin in
+Token for window in application. Used only to select a particular
+application.
+.AP char *name in
+Name under which to register the application.
+.BE
+
+.SH DESCRIPTION
+.PP
+\fBTk_SetAppName\fR associates a name with a given application and
+records that association on the display containing with the application's
+main window.
+After this procedure has been invoked, other applications on the
+display will be able to use the \fBsend\fR command to invoke operations
+in the application.
+If \fIname\fR is already in use by some other application on the
+display, then a new name will be generated by appending
+``\fB #2\fR'' to \fIname\fR; if this name is also in use,
+the number will be incremented until an unused name is found.
+The return value from the procedure is a pointer to the name actually
+used.
+.PP
+If the application already has a name when \fBTk_SetAppName\fR is
+called, then the new name replaces the old name.
+.PP
+\fBTk_SetAppName\fR also adds a \fBsend\fR command to the application's
+interpreter, which can be used to send commands from this application
+to others on any of the displays where the application has windows.
+.PP
+The application's name registration persists until the interpreter is
+deleted or the \fBsend\fR command is deleted from \fIinterp\fR, at which
+point the name is automatically unregistered and the application
+becomes inaccessible via \fBsend\fR.
+The application can be made accessible again by calling \fBTk_SetAppName\fR.
+.PP
+\fBTk_SetAppName\fR is called automatically by \fBTk_Init\fR,
+so applications don't normally need to call it explicitly.
+.PP
+The command \fBtk appname\fR provides Tcl-level access to the
+functionality of \fBTk_SetAppName\fR.
+
+.SH KEYWORDS
+application, name, register, send command