diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/AddOption.3 | 6 | ||||
| -rw-r--r-- | doc/CanvTkwin.3 | 4 | ||||
| -rw-r--r-- | doc/GetPixels.3 | 4 | ||||
| -rw-r--r-- | doc/Name.3 | 4 | ||||
| -rw-r--r-- | doc/ParseArgv.3 | 4 | ||||
| -rw-r--r-- | doc/getOpenFile.n | 8 | ||||
| -rw-r--r-- | doc/menu.n | 4 | ||||
| -rw-r--r-- | doc/photo.n | 27 | ||||
| -rw-r--r-- | doc/spinbox.n | 6 | ||||
| -rw-r--r-- | doc/text.n | 125 | ||||
| -rw-r--r-- | doc/winfo.n | 10 | ||||
| -rw-r--r-- | doc/wm.n | 15 |
12 files changed, 178 insertions, 39 deletions
diff --git a/doc/AddOption.3 b/doc/AddOption.3 index d6c7ca5..bb36b47 100644 --- a/doc/AddOption.3 +++ b/doc/AddOption.3 @@ -2,7 +2,7 @@ '\" Copyright (c) 1998-2000 by Scriptics Corporation. '\" All rights reserved. '\" -'\" RCS: @(#) $Id: AddOption.3,v 1.1 2000/04/24 19:00:14 ericm Exp $ +'\" RCS: @(#) $Id: AddOption.3,v 1.1.8.1 2002/02/05 02:25:13 wolfsuit Exp $ '\" '\" .so man.macros @@ -19,9 +19,9 @@ void .SH ARGUMENTS .AP Tk_Window tkwin in Token for window. -.AP char *name in +.AP "CONST char" *name in Multi-element name of option. -.AP char *value in +.AP "CONST char" *value in Value of option. .AP int priority in Overall priority level to use for option. diff --git a/doc/CanvTkwin.3 b/doc/CanvTkwin.3 index bc9490c..6d44e07 100644 --- a/doc/CanvTkwin.3 +++ b/doc/CanvTkwin.3 @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: CanvTkwin.3,v 1.2 1998/09/14 18:22:45 stanton Exp $ +'\" RCS: @(#) $Id: CanvTkwin.3,v 1.2.24.1 2002/02/05 02:25:13 wolfsuit Exp $ '\" .so man.macros .TH Tk_CanvasTkwin 3 4.1 Tk "Tk Library Procedures" @@ -38,7 +38,7 @@ Tk_OptionPrintProc *\fBTk_CanvasTagsPrintProc\fR; A token that identifies a canvas widget. .AP Tcl_Interp *interp in/out Interpreter to use for error reporting. -.AP char *string in +.AP "CONST char" *string in Textual description of a canvas coordinate. .AP double *doublePtr out Points to place to store a converted coordinate. diff --git a/doc/GetPixels.3 b/doc/GetPixels.3 index 3df2985..5ac106d 100644 --- a/doc/GetPixels.3 +++ b/doc/GetPixels.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: GetPixels.3,v 1.3 1999/04/16 01:51:08 stanton Exp $ +'\" RCS: @(#) $Id: GetPixels.3,v 1.3.18.1 2002/02/05 02:25:13 wolfsuit Exp $ '\" .so man.macros .TH Tk_GetPixelsFromObj 3 8.1 Tk "Tk Library Procedures" @@ -42,7 +42,7 @@ units and pixels. .AP Tcl_Obj *objPtr in/out String value specifies a distance on the screen; internal rep will be modified to cache converted distance. -.AP char *string in +.AP "CONST char" *string in Same as \fIobjPtr\fR except specification of distance is passed as a string. .VE @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Name.3,v 1.2 1998/09/14 18:22:52 stanton Exp $ +'\" RCS: @(#) $Id: Name.3,v 1.2.24.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH Tk_Name 3 "" Tk "Tk Library Procedures" @@ -30,7 +30,7 @@ Tk_Window Token for window. .AP Tcl_Interp *interp out Interpreter to use for error reporting. -.AP char *pathName in +.AP "CONST char" *pathName in Character string containing path name of window. .BE diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3 index 2ed9034..0d86958 100644 --- a/doc/ParseArgv.3 +++ b/doc/ParseArgv.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: ParseArgv.3,v 1.2 1998/09/14 18:22:53 stanton Exp $ +'\" RCS: @(#) $Id: ParseArgv.3,v 1.2.24.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures" @@ -28,7 +28,7 @@ no Tk options will be processed. .AP int argcPtr in/out Pointer to number of arguments in argv; gets modified to hold number of unprocessed arguments that remain after the call. -.AP char **argv in/out +.AP "CONST char" **argv in/out Command line arguments passed to main program. Modified to hold unprocessed arguments that remain after the call. .AP Tk_ArgvInfo *argTable in diff --git a/doc/getOpenFile.n b/doc/getOpenFile.n index 26625d2..ba14e1c 100644 --- a/doc/getOpenFile.n +++ b/doc/getOpenFile.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: getOpenFile.n,v 1.8 2000/07/25 21:14:35 jenglish Exp $ +'\" RCS: @(#) $Id: getOpenFile.n,v 1.8.6.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH tk_getOpenFile n 4.2 Tk "Tk Built-In Commands" @@ -42,7 +42,11 @@ Specifies a string that will be appended to the filename if the user enters a filename without an extension. The defaut value is the empty string, which means no extension will be appended to the filename in any case. This option is ignored on the Macintosh platform, which -does not require extensions to filenames. +does not require extensions to filenames, +.VS 8.4 +and the UNIX implementation guesses reasonable values for this from +the \fB\-filetypes\fR option when this is not supplied. +.VE 8.4 .TP \fB\-filetypes\fR \fIfilePatternList\fR If a \fBFile types\fR listbox exists in the file dialog on the particular @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: menu.n,v 1.6 2001/10/12 13:30:31 tmh Exp $ +'\" RCS: @(#) $Id: menu.n,v 1.6.2.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH menu n 4.1 Tk "Tk Built-In Commands" @@ -428,7 +428,7 @@ Specifies a Tcl command to execute when the menu entry is invoked. Not available for separator or tear-off entries. .TP .VS 8.4 -.fB\-compound \fIvalue\fR +\fB\-compound \fIvalue\fR Specifies whether the menu entry should display both an image and text, and if so, where the image should be placed relative to the text. Valid values for this option are \fBbottom\fR, \fBcenter\fR, diff --git a/doc/photo.n b/doc/photo.n index 5840473..c33a413 100644 --- a/doc/photo.n +++ b/doc/photo.n @@ -9,7 +9,7 @@ '\" Department of Computer Science, '\" Australian National University. '\" -'\" RCS: @(#) $Id: photo.n,v 1.7 2001/02/13 21:52:45 ericm Exp $ +'\" RCS: @(#) $Id: photo.n,v 1.7.4.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH photo n 4.0 Tk "Tk Built-In Commands" @@ -31,7 +31,11 @@ can be supplied from C code through a procedural interface. At present, only GIF and PPM/PGM formats are supported, but an interface exists to allow additional image file formats to be added easily. A photo image is transparent -in regions where no image data has been supplied. +in regions where no image data has been supplied +.VS 8.4 +or where it has been set transparent by the \fBtransparency set\fB +subcommand. +.VE 8.4 .SH "CREATING PHOTOS" .PP @@ -308,6 +312,21 @@ not noticeable, but if it is a problem, this command can be used to recalculate the dithered image in each window where the image is displayed. .TP +\fIimageName \fBtransparency \fIsubcommand ?arg arg ...?\fR +.VS 8.4 +Allows examination and manipulation of the transparency information in +the photo image. Several subcommands are available: +.RS +.TP +\fIimageName \fBtransparency get \fIx y\fR +Returns a boolean indicating if the pixel at (\fIx\fR,\fIy\fR) is +transparent. +\fIimageName \fBtransparency get \fIx y boolean\fR +Makes the pixel at (\fIx\fR,\fIy\fR) transparent if \fIboolean\fR is +true, and makes that pixel opaque otherwise. +.RE +.VE 8.4 +.TP \fIimageName \fBwrite \fIfilename\fR ?\fIoption value(s) ...\fR? Writes image data from \fIimageName\fR to a file named \fIfilename\fR. The following options may be specified: @@ -367,6 +386,10 @@ for the \fB\-format\fR option must begin with the complete name of the requested handler, and may contain additional information following that, which the handler can use, for example, to specify which variant to use of the formats supported by the handler. +.VS 8.4 +Note that not all image handlers may support writing transparency data +to a file, even where the target image format does. +.VE 8.4 .SH "COLOR ALLOCATION" .PP diff --git a/doc/spinbox.n b/doc/spinbox.n index 97d2325..b15d7d8 100644 --- a/doc/spinbox.n +++ b/doc/spinbox.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: spinbox.n,v 1.2 2000/08/25 06:58:33 ericm Exp $ +'\" RCS: @(#) $Id: spinbox.n,v 1.2.6.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH spinbox n 8.4 Tk "Tk Built-In Commands" @@ -323,7 +323,7 @@ given by \fIindex\fR. Returns an empty string. \fIpathName \fBidentify\fI x y\fR Returns the name of the window element corresponding to coordinates \fIx\fR and \fIy\fR in the spinbox. Return value is one of: -\fBnone\fR, \fBspindown\fR, \fBspinup\fR, \fBentry\fR. +\fBnone\fR, \fBbuttondown\fR, \fBbuttonup\fR, \fBentry\fR. .TP \fIpathName \fBindex\fI index\fR Returns the numerical index corresponding to \fIindex\fR. @@ -333,7 +333,7 @@ Insert the characters of \fIstring\fR just before the character indicated by \fIindex\fR. Returns an empty string. .TP \fIpathName \fBinvoke\fI element\fR -Causes the specified element, either \fBspindown\fR or \fBspinup\fR, +Causes the specified element, either \fBbuttondown\fR or \fBbuttonup\fR, to be invoked, triggering the action associated with it. .TP \fIpathName \fBscan\fR \fIoption args\fR @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: text.n,v 1.9 2001/08/01 16:21:11 dgp Exp $ +'\" RCS: @(#) $Id: text.n,v 1.9.2.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH text n 4.0 Tk "Tk Built-In Commands" @@ -20,7 +20,7 @@ text, tk_textCopy, tk_textCut, tk_textPaste \- Create and manipulate text widget \fBtk_textCopy\fR \fIpathName\fR \fBtk_textCut\fR \fIpathName\fR \fBtk_textPaste\fR \fIpathName\fR -.VE +.VE 8.4 .SO \-background \-highlightthickness \-relief \-borderwidth \-insertbackground \-selectbackground @@ -32,6 +32,12 @@ text, tk_textCopy, tk_textCut, tk_textPaste \- Create and manipulate text widget \-highlightcolor \-pady \-yscrollcommand .SE .SH "WIDGET-SPECIFIC OPTIONS" +.OP \-autoseparators autoSseparators AutoSeparators +.VS 8.4 +Specifies a boolean that says whether separators are automatically +inserted in the undo stack. Only meaningful when the \fB\-undo\fR +option is true. +.VE 8.4 .OP \-height height Height Specifies the desired height for the window, in units of characters in the font given by the \fB\-font\fR option. @@ -89,6 +95,11 @@ options in tags. If no \fB\-tabs\fR option is specified, or if it is specified as an empty list, then Tk uses default tabs spaced every eight (average size) characters. +.OP \-undo undo Undo +.VS 8.4 +Specifies a boolean that says whether the undo mechanism is active or +not. +.VE 8.4 .OP \-width width Width Specifies the desired width for the window in units of characters in the font given by the \fB\-font\fR option. @@ -121,10 +132,8 @@ path name of the new window. .PP A text widget displays one or more lines of text and allows that text to be edited. -.VS Text widgets support four different kinds of annotations on the text, called tags, marks, embedded windows or embedded images. -.VE Tags allow different portions of the text to be displayed with different fonts and colors. In addition, Tcl commands can be associated with tags so @@ -142,11 +151,14 @@ The third form of annotation allows arbitrary windows to be embedded in a text widget. See EMBEDDED WINDOWS below for more details. .PP -.VS The fourth form of annotation allows Tk images to be embedded in a text widget. See EMBEDDED IMAGES below for more details. -.VE +.PP +.VS 8.4 +The text widget also has a built-in undo/redo mechanism. +See UNDO MECHANISM below for more details. +.VE 8.4 .SH INDICES .PP @@ -203,13 +215,11 @@ Indicates the position of the embedded window whose name is This form generates an error if there is no embedded window by the given name. .TP 12 -.VS \fIimageName\fR Indicates the position of the embedded image whose name is \fIimageName\fR. This form generates an error if there is no embedded image by the given name. -.VE .PP If the \fIbase\fP could match more than one of the above forms, such as a \fImark\fP and \fIimageName\fP both having the same value, then @@ -602,7 +612,6 @@ stretched. \fB\-window \fIpathName\fR Specifies the name of a window to display in the annotation. -.VS .SH "EMBEDDED IMAGES" .PP The final form of annotation in text widgets is an embedded image. @@ -670,7 +679,6 @@ It may have any of the usual forms defined for a screen distance. \fIPixels\fR specifies the amount of extra space to leave on the top and on the bottom of the embedded image. It may have any of the usual forms defined for a screen distance. -.VE .SH "THE SELECTION" .PP @@ -688,6 +696,9 @@ characters with the \fBsel\fR tag. If the selection is claimed away by another application or by another window within this application, then the \fBsel\fR tag will be removed from all characters in the text. +.IP [4] +Whenever the \fBsel\fR tag range changes a virtual event +\fB<<Selection>>\fR is generated. .PP The \fBsel\fR tag is automatically defined when a text widget is created, and it may not be deleted with the ``\fIpathName \fBtag delete\fR'' @@ -708,6 +719,47 @@ The \fBinsert\fR mark represents the position of the insertion cursor, and the insertion cursor will automatically be drawn at this point whenever the text widget has the input focus. +.SH "THE MODIFIED FLAG" +The text widget can keep track of changes to the content of the widget +by means of the modified flag. Inserting or deleting text will set +this flag. The flag can be queried, set and cleared programatically +as well. Whenever the flag changes state a \fB<<Modified>>\fR virtual +event is generated. See the \fBedit modified\fR widget command for +more details. + +.SH "THE UNDO MECHANISM" +.PP +.VS 8.4 +The text widget has an unlimited undo and redo mechanism (when the +\fB-undo\fR widget option is true) which records every insert and +delete action is recorded on a stack. +.PP +Boundaries (called "separators") are inserted between edit actions. +The purpose of these separators is to group inserts and deletes into +one compound edit action. When undoing a change everything between +two separators will be undone. The undone changes are then moved to +the redo stack, so that an undone edit can be redone again. The redo +stack is cleared whenever new edit actions are recorded on the undo +stack. The undo and redo stacks can be cleared to keep their depth +under control. +.PP +Separators are inserted automatically when the \fB-autoseparators\fR +widget option is true. You can insert separators programatically as +well. If a separator is already present at the top of the undo stack +no other will inserted. That means that two separators on the undo +stack are always separated by at least one insert or delete action. +.PP +The undo mechanism is also linked to the modified flag. This means +that undoing or redoing changes can take a modified text widget back +to the unmodified state or vice versa. The modified flag will be set +to automatically to the appropriate state. This automatic coupling +does not work when the modified flag has been set by the user, until +the flag has been reset again. +.PP +See below for the \fBedit\fR widget command that controls the undo +mechanism. +.VE 8.4 + .SH "WIDGET COMMAND" .PP The \fBtext\fR command creates a new Tcl command whose @@ -784,7 +836,7 @@ When debugging is turned on, the drawing routines of the text widget set the global variables \fBtk_textRedraw\fR and \fBtk_textRelayout\fR to the lists of indices that are redrawn. The values of these variables are tested by Tk's test suite. -.VE +.VE 8.4 .TP \fIpathName \fBdelete \fIindex1 \fR?\fIindex2\fR? Delete a range of characters from the text. @@ -876,6 +928,42 @@ In this case an empty string is returned, and you must query the window by its index position to get more information. .RE .TP +\fIpathName \fBedit \fIoption \fR?\fIarg arg ...\fR? +.VS 8.4 +This command controls the undo mechanism and the modified flag. The +exact behavior of the command depends on the \fIoption\fR argument +that follows the \fBedit\fR argument. The following forms of the +command are currently supported: +.RS +.TP +\fIpathName \fBedit modified ?\fIboolean\fR? +If \fIboolean\fR is not specified, returns the modified flag of the +widget. The insert, delete, edit undo and edit redo commands or the +user can set or clear the modified flag. If \fIboolean\fR is +specified, sets the modified flag of the widget to \fIboolean\fR. +.TP +\fIpathName \fBedit redo\fR +When the \fB-undo\fR option is true, reapplies the last undone edits +provided no other edits were done since then. Generates an error when +the redo stack is empty. Does nothing when the \fB-undo\fR option is +false. +.TP +\fIpathName \fBedit reset\fR +Clears the undo and redo stacks. +.TP +\fIpathName \fBedit separator\fR +Inserts a separator (boundary) on the undo stack. Does nothing when +the \fB-undo\fR option is false. +.TP +\fIpathName \fBedit undo\fR +Undoes the last edit action when the \fB-undo\fR option is true. An +edit action is defined as all the insert and delete commands that are +recorded on the undo stack in between two separators. Generates an +error when the undo stack is empty. Does nothing when the \fB-undo\fR +option is false. +.RE +.VE 8.4 +.TP \fIpathName \fBget \fIindex1 \fR?\fIindex2\fR? Return a range of characters from the text. The return value will be all the characters in the text starting @@ -1569,14 +1657,14 @@ The F16 key (labelled Copy on many Sun workstations) or Meta-w copies the selection in the widget to the clipboard, if there is a selection. .VS 8.4 This action is carried out by the command \fBtk_textCopy\fR. -.VE +.VE 8.4 .IP [21] The F20 key (labelled Cut on many Sun workstations) or Control-w copies the selection in the widget to the clipboard and deletes the selection. .VS 8.4 This action is carried out by the command \fBtk_textCut\fR. -.VE +.VE 8.4 If there is no selection in the widget then these keys have no effect. .IP [22] The F18 key (labelled Paste on many Sun workstations) or Control-y @@ -1584,7 +1672,7 @@ inserts the contents of the clipboard at the position of the insertion cursor. .VS 8.4 This action is carried out by the command \fBtk_textPaste\fR. -.VE +.VE 8.4 .IP [23] The Delete key deletes the selection, if there is one in the widget. If there is no selection, it deletes the character to the right of @@ -1613,6 +1701,15 @@ Control-x deletes whatever is selected in the text widget. .IP [31] Control-t reverses the order of the two characters to the right of the insertion cursor. +.IP [32] +.VS 8.4 +Control-z (and Control-underscore on UNIX when \fBtk_strictMotif\fR is +true) undoes the last edit action if the \fB-undo\fR option is true. +Does nothing otherwise. +.IP [33] +Control-Z (or Control-y on Windows) reapplies the last undone edit +action if the \fB-undo\fR option is true. Does nothing otherwise. +.VE 8.4 .PP If the widget is disabled using the \fB\-state\fR option, then its view can still be adjusted and text can still be selected, diff --git a/doc/winfo.n b/doc/winfo.n index f9e4de1..6774882 100644 --- a/doc/winfo.n +++ b/doc/winfo.n @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: winfo.n,v 1.2 1998/09/14 18:23:00 stanton Exp $ +'\" RCS: @(#) $Id: winfo.n,v 1.2.24.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH winfo n 4.3 Tk "Tk Built-In Commands" @@ -46,9 +46,11 @@ color map for \fIwindow\fR. .TP \fBwinfo children \fIwindow\fR Returns a list containing the path names of all the children -of \fIwindow\fR. The list is in stacking order, with the lowest -window first. Top-level windows are returned as children -of their logical parents. +of \fIwindow\fR. Top-level windows are returned as children +of their logical parents. The list is in stacking order, with +the lowest window first, except for Top-level windows which +are not returned in stacking order. Use the \fBwm stackorder\fR +command to query the stacking order of Top-level windows. .TP \fBwinfo class \fIwindow\fR Returns the class name for \fIwindow\fR. @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: wm.n,v 1.6 2001/01/02 19:13:02 andreas_kupries Exp $ +'\" RCS: @(#) $Id: wm.n,v 1.6.4.1 2002/02/05 02:25:14 wolfsuit Exp $ '\" .so man.macros .TH wm n 4.3 Tk "Tk Built-In Commands" @@ -400,6 +400,19 @@ source of the window's current size, or an empty string if no source has been specified yet. Most window managers interpret ``no source'' as equivalent to \fBprogram\fR. .TP +\fBwm stackorder \fIwindow\fR ?\fIisabove|isbelow\fR? \fI?window?\fR +The stackorder command returns a list of toplevel windows +in stacking order, from lowest to highest. When a single toplevel +window is passed, the returned list recursively includes all of the +window's children that are toplevels. Only those toplevels +that are currently mapped to the screen are returned. +The stackorder command can also be used to determine if one +toplevel is positioned above or below a second toplevel. +When two window arguments separated by either \fIisabove\fR or +\fIisbelow\fR are passed, a boolean result indicates whether +or not the first window is currently above or below the second +window in the stacking order. +.TP \fBwm state \fIwindow\fR ?newstate? If \fInewstate\fR is specified, the window will be set to the new state, otherwise it returns the current state of \fIwindow\fR: either |