diff options
| -rw-r--r-- | ChangeLog | 9 | ||||
| -rw-r--r-- | doc/3DBorder.3 | 5 | ||||
| -rw-r--r-- | doc/BindTable.3 | 14 | ||||
| -rw-r--r-- | doc/CanvPsY.3 | 31 | ||||
| -rw-r--r-- | doc/Clipboard.3 | 9 | ||||
| -rw-r--r-- | doc/ConfigWidg.3 | 18 | ||||
| -rw-r--r-- | doc/CrtWindow.3 | 6 | ||||
| -rw-r--r-- | doc/GetBitmap.3 | 4 | ||||
| -rw-r--r-- | doc/GetCapStyl.3 | 4 | ||||
| -rw-r--r-- | doc/GetImage.3 | 4 | ||||
| -rw-r--r-- | doc/GetJoinStl.3 | 4 | ||||
| -rw-r--r-- | doc/GetScroll.3 | 5 | ||||
| -rw-r--r-- | doc/GetSelect.3 | 13 | ||||
| -rw-r--r-- | doc/GetVisual.3 | 4 | ||||
| -rw-r--r-- | doc/MainWin.3 | 4 | ||||
| -rw-r--r-- | doc/Name.3 | 8 | ||||
| -rw-r--r-- | doc/ParseArgv.3 | 14 | ||||
| -rw-r--r-- | doc/TextLayout.3 | 6 | ||||
| -rw-r--r-- | doc/Tk_Init.3 | 4 |
19 files changed, 93 insertions, 73 deletions
@@ -1,3 +1,12 @@ +2009-05-04 Donal K. Fellows <dkf@users.sf.net> + + * doc/3DBorder.3, doc/BindTable.3, doc/CanvPsY.3, doc/Clipboard.3: + * doc/ConfigWidg.3, doc/CrtWindow.3, doc/GetBitmap.3: + * doc/GetCapStyl.3, doc/GetImage.3, doc/GetJoinStl.3, doc/GetScroll.3: + * doc/GetSelect.3, doc/GetVisual.3, doc/MainWin.3, doc/Name.3: + * doc/ParseArgv.3, doc/TextLayout.3, doc/Tk_Init.3: [Bug 2431507]: + Purge all mention of the now-obsolete 'interp->result'. + 2009-05-03 Donal K. Fellows <dkf@users.sf.net> * win/tkWinWm.c (UpdateWrapper): [Bug 2785744]: Manipulate flag bit diff --git a/doc/3DBorder.3 b/doc/3DBorder.3 index 204f908..f693b5d 100644 --- a/doc/3DBorder.3 +++ b/doc/3DBorder.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: 3DBorder.3,v 1.12 2008/06/30 22:57:00 dkf Exp $ +'\" RCS: @(#) $Id: 3DBorder.3,v 1.13 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_Alloc3DBorderFromObj 3 8.1 Tk "Tk Library Procedures" @@ -154,7 +154,8 @@ darker than \fIobjPtr\fR. \fBTk_Alloc3DBorderFromObj\fR returns a token that may be used in later calls to \fBTk_Draw3DRectangle\fR. If an error occurs in allocating information for the border (e.g. a bogus color name was given) -then NULL is returned and an error message is left in \fIinterp->result\fR. +then NULL is returned and an error message is left as the result of +interpreter \fIinterp\fR. If it returns successfully, \fBTk_Alloc3DBorderFromObj\fR caches information about the return value in \fIobjPtr\fR, which speeds up future calls to \fBTk_Alloc3DBorderFromObj\fR with the same \fIobjPtr\fR diff --git a/doc/BindTable.3 b/doc/BindTable.3 index 32d6184..f95bd82 100644 --- a/doc/BindTable.3 +++ b/doc/BindTable.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: BindTable.3,v 1.6 2008/06/30 22:57:00 dkf Exp $ +'\" RCS: @(#) $Id: BindTable.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_CreateBindingTable 3 4.0 Tk "Tk Library Procedures" @@ -113,25 +113,25 @@ select relevant events, or to disallow the use of certain events in bindings. If an error occurred while creating the binding (e.g., \fIeventString\fR refers to a non-existent event), then 0 is returned and an error -message is left in \fIinterp->result\fR. +message is left as the result of interpreter \fIinterp\fR. .PP \fBTk_DeleteBinding\fR removes from \fIbindingTable\fR the binding given by \fIobject\fR and \fIeventString\fR, if such a binding exists. \fBTk_DeleteBinding\fR always returns \fBTCL_OK\fR. -In some cases it may reset \fIinterp->result\fR to the default +In some cases it may reset the interpreter result to the default empty value. .PP \fBTk_GetBinding\fR returns a pointer to the script associated with \fIeventString\fR and \fIobject\fR in \fIbindingTable\fR. If no such binding exists then NULL is returned and an error -message is left in \fIinterp->result\fR. +message is left as the result of interpreter \fIinterp\fR. .PP -\fBTk_GetAllBindings\fR returns in \fIinterp->result\fR a list +\fBTk_GetAllBindings\fR returns in \fIinterp\fR's result a list of all the event strings for which there are bindings in \fIbindingTable\fR associated with \fIobject\fR. -If there are no bindings for \fIobject\fR then an empty -string is returned in \fIinterp->result\fR. +If there are no bindings for \fIobject\fR, the result will be an empty +string. .PP \fBTk_DeleteAllBindings\fR deletes all of the bindings in \fIbindingTable\fR that are associated with \fIobject\fR. diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3 index 7548099..10f9f08 100644 --- a/doc/CanvPsY.3 +++ b/doc/CanvPsY.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: CanvPsY.3,v 1.8 2008/07/08 22:40:50 patthoyts Exp $ +'\" RCS: @(#) $Id: CanvPsY.3,v 1.9 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures" @@ -84,37 +84,40 @@ transformation. of a bitmap. The Postscript is generated in proper image data format for Postscript, i.e., as data between angle brackets, one bit per pixel. -The Postscript is appended to \fIinterp->result\fR and \fBTCL_OK\fR is returned -unless an error occurs, in which case \fBTCL_ERROR\fR is returned and -\fIinterp->result\fR is overwritten with an error message. +The Postscript is appended to the result of interpreter \fIinterp\fR +and \fBTCL_OK\fR is returned unless an error occurs, in which case +\fBTCL_ERROR\fR is returned and the interpreter result is overwritten +with an error message. .PP \fBTk_CanvasPsColor\fR generates Postscript to set the current color to correspond to its \fIcolorPtr\fR argument, taking into account any color map specified in the \fBpostscript\fR command. -It appends the Postscript to \fIinterp->result\fR and returns -\fBTCL_OK\fR unless an error occurs, in which case \fBTCL_ERROR\fR is returned and -\fIinterp->result\fR is overwritten with an error message. +It appends the Postscript to the interpreter \fIinterp\fR's result and returns +\fBTCL_OK\fR unless an error occurs, in which case \fBTCL_ERROR\fR is +returned and the interpreter's result is overwritten with an error message. .PP \fBTk_CanvasPsFont\fR generates Postscript that sets the current font to match \fItkFont\fR as closely as possible. \fBTk_CanvasPsFont\fR takes into account any font map specified in the \fBpostscript\fR command, and it does the best it can at mapping X fonts to Postscript fonts. -It appends the Postscript to \fIinterp->result\fR and returns \fBTCL_OK\fR -unless an error occurs, in which case \fBTCL_ERROR\fR is returned and -\fIinterp->result\fR is overwritten with an error message. +It appends the Postscript to interpreter \fIinterp\fR's result and +returns \fBTCL_OK\fR unless an error occurs, in which case +\fBTCL_ERROR\fR is returned and the interpreter's result is +overwritten with an error message. .PP \fBTk_CanvasPsPath\fR generates Postscript to set the current path to the set of points given by \fIcoordPtr\fR and \fInumPoints\fR. -It appends the resulting Postscript to \fIinterp->result\fR. +It appends the resulting Postscript to the result of interpreter \fIinterp\fR. .PP \fBTk_CanvasPsStipple\fR generates Postscript that will fill the current path in stippled fashion. It uses \fIbitmap\fR as the stipple pattern and the current Postscript color; ones in the stipple bitmap are drawn in the current color, and zeroes are not drawn at all. -The Postscript is appended to \fIinterp->result\fR and \fBTCL_OK\fR is -returned, unless an error occurs, in which case \fBTCL_ERROR\fR is returned and -\fIinterp->result\fR is overwritten with an error message. +The Postscript is appended to interpreter \fIinterp\fR's result and +\fBTCL_OK\fR is returned, unless an error occurs, in which case +\fBTCL_ERROR\fR is returned and the interpreter's result is +overwritten with an error message. .SH KEYWORDS bitmap, canvas, color, font, path, Postscript, stipple diff --git a/doc/Clipboard.3 b/doc/Clipboard.3 index 927a64e..f7ab6f3 100644 --- a/doc/Clipboard.3 +++ b/doc/Clipboard.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: Clipboard.3,v 1.6 2009/01/06 21:58:15 nijtmans Exp $ +'\" RCS: @(#) $Id: Clipboard.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures" @@ -46,7 +46,8 @@ number of targets. \fBTk_ClipboardClear\fR claims the CLIPBOARD selection and frees any data items previously stored on the clipboard in this application. It normally returns \fBTCL_OK\fR, but if an error occurs it returns -\fBTCL_ERROR\fR and leaves an error message in \fIinterp->result\fR. +\fBTCL_ERROR\fR and leaves an error message in interpreter +\fIinterp\fR's result. \fBTk_ClipboardClear\fR must be called before a sequence of \fBTk_ClipboardAppend\fR calls can be issued. .PP @@ -61,8 +62,8 @@ currently owned by the application, either because \fBTk_ClipboardClear\fR has not been called or because ownership of the clipboard has changed since the last call to \fBTk_ClipboardClear\fR, -\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error message in -\fIinterp->result\fR. +\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error +message in the result of interpreter \fIinterp\fR. .PP In order to guarantee atomicity, no event handling should occur between \fBTk_ClipboardClear\fR and the following diff --git a/doc/ConfigWidg.3 b/doc/ConfigWidg.3 index c9f72f2..14f4c96 100644 --- a/doc/ConfigWidg.3 +++ b/doc/ConfigWidg.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: ConfigWidg.3,v 1.23 2009/01/06 21:58:15 nijtmans Exp $ +'\" RCS: @(#) $Id: ConfigWidg.3,v 1.24 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_ConfigureWidget 3 4.1 Tk "Tk Library Procedures" @@ -91,7 +91,7 @@ to fill in fields of \fIwidgRec\fR that are not specified in \fIargv\fR. case it does not modify \fIinterp\fR. If an error occurs then \fBTCL_ERROR\fR is returned and \fBTk_ConfigureWidget\fR will -leave an error message in \fIinterp->result\fR in the standard Tcl +leave an error message in interpreter \fIinterp\fR's result in the standard Tcl fashion. In the event of an error return, some of the fields of \fIwidgRec\fR could already have been set, if configuration information for them @@ -488,12 +488,12 @@ pointer to a widget record containing the current information for a widget (\fIwidgRec\fR), and a NULL \fIargvName\fR argument, \fBTk_ConfigureInfo\fR generates a string describing all of the configuration options for the window. The string is placed -in \fIinterp->result\fR. Under normal circumstances +in interpreter \fIinterp\fR's result. Under normal circumstances it returns \fBTCL_OK\fR; if an error occurs then it returns \fBTCL_ERROR\fR -and \fIinterp->result\fR contains an error message. +and the interpreter's result will contain an error message. .PP If \fIargvName\fR is NULL, then the value left in -\fIinterp->result\fR by \fBTk_ConfigureInfo\fR +the interpreter's result by \fBTk_ConfigureInfo\fR consists of a list of one or more entries, each of which describes one configuration option (i.e. one entry in \fIspecs\fR). Each entry in the list will contain either two or five values. If the @@ -506,7 +506,7 @@ field of \fIwidgRec\fR by calling procedures like \fBTk_NameOfColor\fR. .PP If the \fIargvName\fR argument to \fBTk_ConfigureInfo\fR is non-NULL, then it indicates a single option, and information is returned only -for that option. The string placed in \fIinterp->result\fR will be +for that option. The string placed in the interpreter's result will be a list containing two or five values as described above; this will be identical to the corresponding sublist that would have been returned if \fIargvName\fR had been NULL. @@ -518,11 +518,11 @@ the \fIspecs\fR entries to consider, just as for \fBTk_ConfigureWidget\fR. \fBTk_ConfigureValue\fR takes arguments similar to \fBTk_ConfigureInfo\fR; instead of returning a list of values, it just returns the current value of the option given by \fIargvName\fR (\fIargvName\fR must not be NULL). -The value is returned in \fIinterp->result\fR and \fBTCL_OK\fR is +The value is returned in interpreter \fIinterp\fR's result and \fBTCL_OK\fR is normally returned as the procedure's result. If an error occurs in \fBTk_ConfigureValue\fR (e.g., \fIargvName\fR is not a valid option name), \fBTCL_ERROR\fR is returned and an error message -is left in \fIinterp->result\fR. +is left in the interpreter's result. This procedure is typically called to implement \fBcget\fR widget commands. .SH TK_FREEOPTIONS @@ -592,7 +592,7 @@ be placed. The procedure should translate the string to whatever form is appropriate for the option and store the value in the widget record. It should normally return \fBTCL_OK\fR, but if an error occurs in translating the string to a value then it should return \fBTCL_ERROR\fR -and store an error message in \fIinterp->result\fR. +and store an error message in interpreter \fIinterp\fR's result. .PP The \fIprintProc\fR procedure is called by \fBTk_ConfigureInfo\fR to produce a string value describing an diff --git a/doc/CrtWindow.3 b/doc/CrtWindow.3 index b48696a..66188b1 100644 --- a/doc/CrtWindow.3 +++ b/doc/CrtWindow.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: CrtWindow.3,v 1.13 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: CrtWindow.3,v 1.14 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_CreateWindow 3 4.2 Tk "Tk Library Procedures" @@ -60,8 +60,8 @@ are used to create new windows for use in Tk-based applications. Each of the procedures returns a token that can be used to manipulate the window in other calls to the Tk library. If the window could not be created successfully, then NULL -is returned and \fIinterp->result\fR is modified to hold an error -message. +is returned and the result of interpreter \fIinterp\fR is modified to +hold an error message. .PP Tk supports two different kinds of windows: internal windows and top-level windows. diff --git a/doc/GetBitmap.3 b/doc/GetBitmap.3 index 7014d98..8370012 100644 --- a/doc/GetBitmap.3 +++ b/doc/GetBitmap.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: GetBitmap.3,v 1.17 2009/02/27 23:23:36 nijtmans Exp $ +'\" RCS: @(#) $Id: GetBitmap.3,v 1.18 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_AllocBitmapFromObj 3 8.1 Tk "Tk Library Procedures" @@ -211,7 +211,7 @@ describe the bitmap. \fBTk_DefineBitmap\fR normally returns \fBTCL_OK\fR; if an error occurs (e.g. a bitmap named \fInameId\fR has already been defined) then \fBTCL_ERROR\fR is returned and an error message is left in -\fIinterp->result\fR. +interpreter \fIinterp\fR's result. Note: \fBTk_DefineBitmap\fR expects the memory pointed to by \fIsource\fR to be static: \fBTk_DefineBitmap\fR does not make a private copy of this memory, but uses the bytes pointed to diff --git a/doc/GetCapStyl.3 b/doc/GetCapStyl.3 index 38217c3..14eea01 100644 --- a/doc/GetCapStyl.3 +++ b/doc/GetCapStyl.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: GetCapStyl.3,v 1.9 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetCapStyl.3,v 1.10 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetCapStyle 3 "" Tk "Tk Library Procedures" @@ -52,7 +52,7 @@ Under normal circumstances the return value is \fBTCL_OK\fR and \fIinterp\fR is unused. If \fIstring\fR does not contain a valid cap style or an abbreviation of one of these names, then an error message is -stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and +stored in interpreter \fIinterp\fR's result, \fBTCL_ERROR\fR is returned, and \fI*capPtr\fR is unmodified. .PP \fBTk_NameOfCapStyle\fR is the logical inverse of \fBTk_GetCapStyle\fR. diff --git a/doc/GetImage.3 b/doc/GetImage.3 index 6b137f3..a6fc19d 100644 --- a/doc/GetImage.3 +++ b/doc/GetImage.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: GetImage.3,v 1.10 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetImage.3,v 1.11 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetImage 3 4.0 Tk "Tk Library Procedures" @@ -75,7 +75,7 @@ identifies the window where the image will be displayed. \fBTk_GetImage\fR looks up the image in the table of existing images and returns a token for a new instance of the image. If the image does not exist then \fBTk_GetImage\fR returns NULL -and leaves an error message in \fIinterp->result\fR. +and leaves an error message in interpreter \fIinterp\fR's result. .PP When a widget wishes to actually display an image it must call \fBTk_RedrawImage\fR, identifying the image (\fIimage\fR), diff --git a/doc/GetJoinStl.3 b/doc/GetJoinStl.3 index 980d9e0..4104ba1 100644 --- a/doc/GetJoinStl.3 +++ b/doc/GetJoinStl.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: GetJoinStl.3,v 1.9 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetJoinStl.3,v 1.10 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetJoinStyle 3 "" Tk "Tk Library Procedures" @@ -51,7 +51,7 @@ Under normal circumstances the return value is \fBTCL_OK\fR and \fIinterp\fR is unused. If \fIstring\fR does not contain a valid join style or an abbreviation of one of these names, then an error message is -stored in \fIinterp->result\fR, \fBTCL_ERROR\fR is returned, and +stored in interpreter \fIinterp\fR's result, \fBTCL_ERROR\fR is returned, and \fI*joinPtr\fR is unmodified. .PP \fBTk_NameOfJoinStyle\fR is the logical inverse of \fBTk_GetJoinStyle\fR. diff --git a/doc/GetScroll.3 b/doc/GetScroll.3 index dd8b7c6..c5aa97b 100644 --- a/doc/GetScroll.3 +++ b/doc/GetScroll.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: GetScroll.3,v 1.7 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetScroll.3,v 1.8 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetScrollInfo 3 8.0 Tk "Tk Library Procedures" @@ -66,7 +66,8 @@ If \fIargv\fR has the \fBscroll\fR form, \fBTK_SCROLL_UNITS\fR or \fBTK_SCROLL_PAGES\fR is returned and \fI*intPtr\fR is filled in with the \fInumber\fR value, which must be a proper integer. If an error occurs in parsing the arguments, \fBTK_SCROLL_ERROR\fR -is returned and an error message is left in \fIinterp->result\fR. +is returned and an error message is left in interpreter +\fIinterp\fR's result. .PP \fBTk_GetScrollInfoObj\fR is identical in function to \fBTk_GetScrollInfo\fR. However, \fBTk_GetScrollInfoObj\fR accepts diff --git a/doc/GetSelect.3 b/doc/GetSelect.3 index 7345cf1..9cdc1bd 100644 --- a/doc/GetSelect.3 +++ b/doc/GetSelect.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: GetSelect.3,v 1.6 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: GetSelect.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures" @@ -43,12 +43,14 @@ selection may actually be retrieved in several pieces; as each piece is retrieved, \fIproc\fR is called to process the piece. \fIProc\fR should have arguments and result that match the type \fBTk_GetSelProc\fR: +.PP .CS typedef int \fBTk_GetSelProc\fR( ClientData \fIclientData\fR, Tcl_Interp *\fIinterp\fR, char *\fIportion\fR); .CE +.PP The \fIclientData\fR and \fIinterp\fR parameters to \fIproc\fR will be copies of the corresponding arguments to \fBTk_GetSelection\fR. \fIPortion\fR will be a pointer to @@ -69,9 +71,10 @@ been completely retrieved and processed by \fIproc\fR, or when a fatal error has occurred (e.g. the selection owner did not respond promptly). \fBTk_GetSelection\fR normally returns \fBTCL_OK\fR; if an error occurs, it returns \fBTCL_ERROR\fR and leaves an error message -in \fIinterp->result\fR. \fIProc\fR should also return either -\fBTCL_OK\fR or \fBTCL_ERROR\fR. If \fIproc\fR encounters an error in dealing with the -selection, it should leave an error message in \fIinterp->result\fR -and return \fBTCL_ERROR\fR; this will abort the selection retrieval. +in interpreter \fIinterp\fR's result. \fIProc\fR should also return either +\fBTCL_OK\fR or \fBTCL_ERROR\fR. If \fIproc\fR encounters an error in +dealing with the selection, it should leave an error message in the +interpreter result and return \fBTCL_ERROR\fR; this will abort the +selection retrieval. .SH KEYWORDS format, get, selection retrieval diff --git a/doc/GetVisual.3 b/doc/GetVisual.3 index 6d1ec2d..a859e7a 100644 --- a/doc/GetVisual.3 +++ b/doc/GetVisual.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: GetVisual.3,v 1.8 2007/12/13 15:23:43 dgp Exp $ +'\" RCS: @(#) $Id: GetVisual.3,v 1.9 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_GetVisual 3 4.0 Tk "Tk Library Procedures" @@ -41,7 +41,7 @@ It returns a pointer to the X Visual structure for the visual and stores the number of bits per pixel for it at \fI*depthPtr\fR. If \fIstring\fR is unrecognizable or if no suitable visual could be found, then NULL is returned and \fBTk_GetVisual\fR leaves -an error message in \fIinterp->result\fR. +an error message in interpreter \fIinterp\fR's result. If \fIcolormap\fR is non-NULL then \fBTk_GetVisual\fR also locates an appropriate colormap for use with the result visual and stores its X identifier at \fI*colormapPtr\fR. diff --git a/doc/MainWin.3 b/doc/MainWin.3 index c80f6b5..5235b45 100644 --- a/doc/MainWin.3 +++ b/doc/MainWin.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: MainWin.3,v 1.5 2008/07/08 22:40:51 patthoyts Exp $ +'\" RCS: @(#) $Id: MainWin.3,v 1.6 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures" @@ -35,7 +35,7 @@ outermost window in an application. 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. +leaves an error message in interpreter \fIinterp\fR's result. .PP \fBTk_GetNumMainWindows\fR returns a count of the number of main windows currently open in the process. @@ -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.10 2008/06/30 22:57:01 dkf Exp $ +'\" RCS: @(#) $Id: Name.3,v 1.11 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_Name 3 "" Tk "Tk Library Procedures" @@ -50,8 +50,7 @@ as a Tk_Uid, which may be used just like a string pointer but also has the properties of a unique identifier (see the manual entry for \fBTk_GetUid\fR for details). .PP -The \fBTk_PathName\fR macro returns a -hierarchical name for \fItkwin\fR. +The \fBTk_PathName\fR macro returns a hierarchical name for \fItkwin\fR. Path names have a structure similar to file names in Unix but with dots between elements instead of slashes: the main window for an application has the path name @@ -76,7 +75,8 @@ The procedure \fBTk_NameToWindow\fR returns the token for a window given its path name (the \fIpathName\fR argument) and another window belonging to the same main window (\fItkwin\fR). It normally returns a token for the named window, but if no such window exists -\fBTk_NameToWindow\fR leaves an error message in \fIinterp->result\fR +\fBTk_NameToWindow\fR leaves an error message in interpreter +\fIinterp\fR's result and returns NULL. The \fItkwin\fR argument to \fBTk_NameToWindow\fR is needed because path names are only unique within a single application hierarchy. If, for example, a single process has opened diff --git a/doc/ParseArgv.3 b/doc/ParseArgv.3 index bf065ee..b24a3f6 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.12 2009/01/06 21:58:15 nijtmans Exp $ +'\" RCS: @(#) $Id: ParseArgv.3,v 1.13 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_ParseArgv 3 "" Tk "Tk Library Procedures" @@ -62,8 +62,8 @@ elements of \fIargv\fR. .PP \fBTk_ParseArgv\fR normally returns the value \fBTCL_OK\fR. If an error occurs while parsing the arguments, then \fBTCL_ERROR\fR is returned and -\fBTk_ParseArgv\fR will leave an error message in \fIinterp->result\fR -in the standard Tcl fashion. In +\fBTk_ParseArgv\fR will leave an error message in the result of +interpreter \fIinterp\fR in the standard Tcl fashion. In the event of an error return, \fI*argvPtr\fR will not have been modified, but \fIargv\fR could have been partially modified. The possible causes of errors are explained below. @@ -188,7 +188,8 @@ specifiers of this type are ignored (as if they did not exist). \fBTK_ARGV_HELP\fR When this kind of option is encountered, \fBTk_ParseArgv\fR uses the \fIhelp\fR fields of \fIargTable\fR to format a message describing -all the valid arguments. The message is placed in \fIinterp->result\fR +all the valid arguments. The message is placed in interpreter +\fIinterp\fR's result and \fBTk_ParseArgv\fR returns \fBTCL_ERROR\fR. When this happens, the caller normally prints the help message and aborts. If the \fIkey\fR field of a \fBTK_ARGV_HELP\fR specifier is NULL, then the specifier will @@ -261,7 +262,8 @@ then return any that are left by compacting them to the beginning of \fIargv\fR (starting at \fIargv\fR[0]). \fIGenfunc\fR should return a count of how many arguments are left in \fIargv\fR; \fBTk_ParseArgv\fR will process them. If \fIgenfunc\fR encounters -an error then it should leave an error message in \fIinterp->result\fR, +an error then it should leave an error message in interpreter +\fIinterp\fR's result, in the usual Tcl fashion, and return \-1; when this happens \fBTk_ParseArgv\fR will abort its processing and return \fBTCL_ERROR\fR. .RE @@ -331,7 +333,7 @@ main(argc, argv) \&... if (Tk_ParseArgv(interp, tkwin, &argc, argv, argTable, 0) != TCL_OK) { - fprintf(stderr, "%s\en", interp->result); + fprintf(stderr, "%s\en", Tcl_GetString(Tcl_GetObjResult(interp))); exit(1); } diff --git a/doc/TextLayout.3 b/doc/TextLayout.3 index e8e006d..7d2f5c5 100644 --- a/doc/TextLayout.3 +++ b/doc/TextLayout.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: TextLayout.3,v 1.12 2009/04/03 09:41:35 dkf Exp $ +'\" RCS: @(#) $Id: TextLayout.3,v 1.13 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_ComputeTextLayout 3 8.1 Tk "Tk Library Procedures" @@ -125,7 +125,7 @@ Specifies the width and height, in pixels, of the rectangular area to compare for intersection against the text layout. .AP Tcl_Interp *interp out Postscript code that will print the text layout is appended to -\fIinterp->result\fR. +the result of interpreter \fIinterp\fR. .BE .SH DESCRIPTION .PP @@ -233,7 +233,7 @@ array of strings that represent the individual lines in \fIlayout\fR. It is the responsibility of the caller to take the Postscript array of strings and add some Postscript function operate on the array to render each of the lines. The code that represents the Postscript array of -strings is appended to \fIinterp->result\fR. +strings is appended to interpreter \fIinterp\fR's result. .SH "DISPLAY MODEL" .PP When measuring a text layout, space characters that occur at the end of a diff --git a/doc/Tk_Init.3 b/doc/Tk_Init.3 index 6dbad09..95cf483 100644 --- a/doc/Tk_Init.3 +++ b/doc/Tk_Init.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: Tk_Init.3,v 1.7 2008/06/30 22:57:02 dkf Exp $ +'\" RCS: @(#) $Id: Tk_Init.3,v 1.8 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_Init 3 8.0 Tk "Tk Library Procedures" @@ -35,7 +35,7 @@ and creates a new Tk application, including its main window. If the initialization is successful \fBTk_Init\fR returns \fBTCL_OK\fR; if there is an error it returns \fBTCL_ERROR\fR. \fBTk_Init\fR also leaves a result or error message -in \fIinterp->result\fR. +in interpreter \fIinterp\fR's result. .PP If there is a variable \fBargv\fR in \fIinterp\fR, \fBTk_Init\fR treats the contents of this variable as a list of options for the |