| '\" |
| '\" Copyright (c) 1992 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: tk.n,v 1.7 2002/09/02 22:00:37 hobbs Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH tk n 8.4 Tk "Tk Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| tk \- Manipulate Tk internal state |
| .SH SYNOPSIS |
| \fBtk\fR \fIoption \fR?\fIarg arg ...\fR? |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| The \fBtk\fR command provides access to miscellaneous |
| elements of Tk's internal state. |
| Most of the information manipulated by this command pertains to the |
| application as a whole, or to a screen or display, rather than to a |
| particular window. |
| The command can take any of a number of different forms |
| depending on the \fIoption\fR argument. The legal forms are: |
| .TP |
| \fBtk appname \fR?\fInewName\fR? |
| If \fInewName\fR isn't specified, this command returns the name |
| of the application (the name that may be used in \fBsend\fR |
| commands to communicate with the application). |
| If \fInewName\fR is specified, then the name of the application |
| is changed to \fInewName\fR. |
| If the given name is already in use, then a suffix of the form |
| ``\fB #2\fR'' or ``\fB #3\fR'' is appended in order to make the name unique. |
| The command's result is the name actually chosen. |
| \fInewName\fR should not start with a capital letter. |
| This will interfere with option processing, since names starting with |
| capitals are assumed to be classes; as a result, Tk may not |
| be able to find some options for the application. |
| If sends have been disabled by deleting the \fBsend\fR command, |
| this command will reenable them and recreate the \fBsend\fR |
| command. |
| .VS 8.4 |
| .TP |
| \fBtk caret window \fR?\fB\-x \fIx\fR? ?\fB\-y \fIy\fR? ?\fB\-height \fIheight\fR? |
| . |
| Sets and queries the caret location for the display of the specified |
| Tk window \fIwindow\fR. The caret is the per-display cursor location |
| used for indicating global focus (e.g. to comply with Microsoft |
| Accessibility guidelines), as well as for location of the over-the-spot |
| XIM (X Input Methods) or Windows IME windows. If no options are specified, |
| the last values used for setting the caret are return in option-value pair |
| format. \fI\-x\fR and \fI\-y\fR represent window-relative coordinates, and |
| \fI\-height\fR is the height of the current cursor location, or the height |
| of the specified \fIwindow\fR if none is given. |
| .VE |
| .TP |
| \fBtk scaling \fR?\fB\-displayof \fIwindow\fR? ?\fInumber\fR? |
| . |
| Sets and queries the current scaling factor used by Tk to convert between |
| physical units (for example, points, inches, or millimeters) and pixels. The |
| \fInumber\fR argument is a floating point number that specifies the number of |
| pixels per point on \fIwindow\fR's display. If the \fIwindow\fR argument is |
| omitted, it defaults to the main window. If the \fInumber\fR argument is |
| omitted, the current value of the scaling factor is returned. |
| .RS |
| .PP |
| A ``point'' is a unit of measurement equal to 1/72 inch. A scaling factor |
| of 1.0 corresponds to 1 pixel per point, which is equivalent to a standard |
| 72 dpi monitor. A scaling factor of 1.25 would mean 1.25 pixels per point, |
| which is the setting for a 90 dpi monitor; setting the scaling factor to |
| 1.25 on a 72 dpi monitor would cause everything in the application to be |
| displayed 1.25 times as large as normal. The initial value for the scaling |
| factor is set when the application starts, based on properties of the |
| installed monitor, but it can be changed at any time. Measurements made |
| after the scaling factor is changed will use the new scaling factor, but it |
| is undefined whether existing widgets will resize themselves dynamically to |
| accomodate the new scaling factor. |
| .RE |
| .VS 8.3 |
| .TP |
| \fBtk useinputmethods \fR?\fB\-displayof \fIwindow\fR? ?\fIboolean\fR? |
| . |
| Sets and queries the state of whether Tk should use XIM (X Input Methods) |
| for filtering events. The resulting state is returned. XIM is used in |
| some locales (ie: Japanese, Korean), to handle special input devices. This |
| feature is only significant on X. If XIM support is not available, this |
| will always return 0. If the \fIwindow\fR argument is omitted, it defaults |
| to the main window. If the \fIboolean\fR argument is omitted, the current |
| state is returned. This is turned on by default for the main display. |
| .VE |
| .VS 8.4 |
| .TP |
| \fBtk windowingsystem\fR |
| . |
| Returns the current Tk windowing system, one of |
| \fBx11\fR (X11-based), \fBwin32\fR (MS Windows), |
| \fBclassic\fR (Mac OS Classic), or \fBaqua\fR (Mac OS X Aqua). |
| .VE |
| .SH KEYWORDS |
| application name, send |