From ec1aaba502e58fe3b9f25759b6d389dab85bdd46 Mon Sep 17 00:00:00 2001 From: patthoyts Date: Tue, 8 Jul 2008 22:40:48 +0000 Subject: Fixed broken line endings from last doc commit --- ChangeLog | 4 + doc/CanvPsY.3 | 240 +++---- doc/Clipboard.3 | 156 ++--- doc/ClrSelect.3 | 80 +-- doc/CoordToWin.3 | 98 +-- doc/CrtGenHdlr.3 | 166 ++--- doc/DrawFocHlt.3 | 76 +-- doc/EventHndlr.3 | 154 ++--- doc/GeomReq.3 | 190 +++--- doc/GetGC.3 | 144 ++-- doc/GetHWND.3 | 78 +-- doc/GetPixmap.3 | 108 +-- doc/Grab.3 | 120 ++-- doc/HWNDToWindow.3 | 56 +- doc/HandleEvent.3 | 94 +-- doc/IdToWindow.3 | 68 +- doc/ImgChanged.3 | 132 ++-- doc/MainLoop.3 | 60 +- doc/MainWin.3 | 86 +-- doc/OwnSelect.3 | 102 +-- doc/QWinEvent.3 | 102 +-- doc/Restack.3 | 94 +-- doc/SetCaret.3 | 76 +-- doc/SetClass.3 | 118 ++-- doc/SetClassProcs.3 | 178 ++--- doc/SetGrid.3 | 130 ++-- doc/bell.n | 68 +- doc/bitmap.n | 222 +++--- doc/keysyms.n | 1856 +++++++++++++++++++++++++-------------------------- doc/lower.n | 72 +- doc/menubar.n | 76 +-- doc/popup.n | 98 +-- doc/tkerror.n | 74 +- doc/tkwait.n | 100 +-- 34 files changed, 2740 insertions(+), 2736 deletions(-) diff --git a/ChangeLog b/ChangeLog index 8e7b0ab..8361c09 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-07-08 Pat Thoyts + + * doc/*.n: Fixed broken line endings from last doc commit. + 2008-07-04 Joe English * generic/ttk/ttkDefaultTheme.c, generic/ttk/ttkClamTheme.c, diff --git a/doc/CanvPsY.3 b/doc/CanvPsY.3 index 05b214e..7548099 100644 --- a/doc/CanvPsY.3 +++ b/doc/CanvPsY.3 @@ -1,120 +1,120 @@ -'\" -'\" 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: CanvPsY.3,v 1.7 2008/06/30 22:57:00 dkf Exp $ -'\" -.so man.macros -.TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -double -\fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR) -.sp -int -\fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR) -.sp -int -\fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR) -.sp -int -\fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR) -.sp -\fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR) -.sp -int -\fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR) -.SH ARGUMENTS -.AS "unsigned int" "numPoints" -.AP Tk_Canvas canvas in -A token that identifies a canvas widget for which Postscript is -being generated. -.AP double canvasY in -Y-coordinate in the space of the canvas. -.AP Tcl_Interp *interp in/out -A Tcl interpreter; Postscript is appended to its result, or the -result may be replaced with an error message. -.AP Pixmap bitmap in -Bitmap to use for generating Postscript. -.AP int x in -X-coordinate within \fIbitmap\fR of left edge of region to output. -.AP int y in -Y-coordinate within \fIbitmap\fR of top edge of region to output. -.AP "int" width in -Width of region of bitmap to output, in pixels. -.AP "int" height in -Height of region of bitmap to output, in pixels. -.AP XColor *colorPtr in -Information about color value to set in Postscript. -.AP Tk_Font tkFont in -Font for which Postscript is to be generated. -.AP double *coordPtr in -Pointer to an array of coordinates for one or more -points specified in canvas coordinates. -The order of values in \fIcoordPtr\fR is x1, y1, x2, y2, x3, y3, -and so on. -.AP int numPoints in -Number of points at \fIcoordPtr\fR. -.BE -.SH DESCRIPTION -.PP -These procedures are called by canvas type managers to carry out -common functions related to generating Postscript. -Most of the procedures take a \fIcanvas\fR argument, which -refers to a canvas widget for which Postscript is being -generated. -.PP -\fBTk_CanvasPsY\fR takes as argument a y-coordinate in the space of -a canvas and returns the value that should be used for that point -in the Postscript currently being generated for \fIcanvas\fR. -Y coordinates require transformation because Postscript uses an -origin at the lower-left corner whereas X uses an origin at the -upper-left corner. -Canvas x coordinates can be used directly in Postscript without -transformation. -.PP -\fBTk_CanvasPsBitmap\fR generates Postscript to describe a region -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. -.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. -.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. -.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. -.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. -.SH KEYWORDS -bitmap, canvas, color, font, path, Postscript, stipple +'\" +'\" 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: CanvPsY.3,v 1.8 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_CanvasPs 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_CanvasPsY, Tk_CanvasPsBitmap, Tk_CanvasPsColor, Tk_CanvasPsFont, Tk_CanvasPsPath, Tk_CanvasPsStipple \- utility procedures for generating Postscript for canvases +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +double +\fBTk_CanvasPsY\fR(\fIcanvas, canvasY\fR) +.sp +int +\fBTk_CanvasPsBitmap\fR(\fIinterp, canvas, bitmap, x, y, width, height\fR) +.sp +int +\fBTk_CanvasPsColor\fR(\fIinterp, canvas, colorPtr\fR) +.sp +int +\fBTk_CanvasPsFont\fR(\fIinterp, canvas, tkFont\fR) +.sp +\fBTk_CanvasPsPath\fR(\fIinterp, canvas, coordPtr, numPoints\fR) +.sp +int +\fBTk_CanvasPsStipple\fR(\fIinterp, canvas, bitmap\fR) +.SH ARGUMENTS +.AS "unsigned int" "numPoints" +.AP Tk_Canvas canvas in +A token that identifies a canvas widget for which Postscript is +being generated. +.AP double canvasY in +Y-coordinate in the space of the canvas. +.AP Tcl_Interp *interp in/out +A Tcl interpreter; Postscript is appended to its result, or the +result may be replaced with an error message. +.AP Pixmap bitmap in +Bitmap to use for generating Postscript. +.AP int x in +X-coordinate within \fIbitmap\fR of left edge of region to output. +.AP int y in +Y-coordinate within \fIbitmap\fR of top edge of region to output. +.AP "int" width in +Width of region of bitmap to output, in pixels. +.AP "int" height in +Height of region of bitmap to output, in pixels. +.AP XColor *colorPtr in +Information about color value to set in Postscript. +.AP Tk_Font tkFont in +Font for which Postscript is to be generated. +.AP double *coordPtr in +Pointer to an array of coordinates for one or more +points specified in canvas coordinates. +The order of values in \fIcoordPtr\fR is x1, y1, x2, y2, x3, y3, +and so on. +.AP int numPoints in +Number of points at \fIcoordPtr\fR. +.BE +.SH DESCRIPTION +.PP +These procedures are called by canvas type managers to carry out +common functions related to generating Postscript. +Most of the procedures take a \fIcanvas\fR argument, which +refers to a canvas widget for which Postscript is being +generated. +.PP +\fBTk_CanvasPsY\fR takes as argument a y-coordinate in the space of +a canvas and returns the value that should be used for that point +in the Postscript currently being generated for \fIcanvas\fR. +Y coordinates require transformation because Postscript uses an +origin at the lower-left corner whereas X uses an origin at the +upper-left corner. +Canvas x coordinates can be used directly in Postscript without +transformation. +.PP +\fBTk_CanvasPsBitmap\fR generates Postscript to describe a region +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. +.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. +.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. +.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. +.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. +.SH KEYWORDS +bitmap, canvas, color, font, path, Postscript, stipple diff --git a/doc/Clipboard.3 b/doc/Clipboard.3 index d0646ea..42fbbb3 100644 --- a/doc/Clipboard.3 +++ b/doc/Clipboard.3 @@ -1,78 +1,78 @@ -'\" -'\" Copyright (c) 1994 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: Clipboard.3,v 1.4 2008/06/30 22:57:00 dkf Exp $ -'\" -.so man.macros -.TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_ClipboardClear, Tk_ClipboardAppend \- Manage the clipboard -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -int -\fBTk_ClipboardClear\fR(\fIinterp, tkwin\fR) -.sp -int -\fBTk_ClipboardAppend\fR(\fIinterp, tkwin, target, format, buffer\fR) -.SH ARGUMENTS -.AS Tk_ClipboardClear tkwin -.AP Tcl_Interp *interp in -Interpreter to use for reporting errors. -.AP Tk_Window tkwin in -Window that determines which display's clipboard to manipulate. -.AP Atom target in -Conversion type for this clipboard item; has same meaning as -\fItarget\fR argument to \fBTk_CreateSelHandler\fR. -.AP Atom format in -Representation to use when data is retrieved; has same meaning as -\fIformat\fR argument to \fBTk_CreateSelHandler\fR. -.AP char *buffer in -Null terminated string containing the data to be appended to the clipboard. -.BE -.SH DESCRIPTION -.PP -These two procedures manage the clipboard for Tk. -The clipboard is typically managed by calling \fBTk_ClipboardClear\fR -once, then calling \fBTk_ClipboardAppend\fR to add data for any -number of targets. -.PP -\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. -\fBTk_ClipboardClear\fR must be called before a sequence of -\fBTk_ClipboardAppend\fR calls can be issued. -.PP -\fBTk_ClipboardAppend\fR appends a buffer of data to the clipboard. -The first buffer for a given \fItarget\fR determines the \fIformat\fR -for that \fItarget\fR. -Any successive appends for that \fItarget\fR must have -the same format or an error will be returned. -\fBTk_ClipboardAppend\fR returns \fBTCL_OK\fR if the buffer is -successfully copied onto the clipboard. If the clipboard is not -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. -.PP -In order to guarantee atomicity, no event handling should occur -between \fBTk_ClipboardClear\fR and the following -\fBTk_ClipboardAppend\fR calls (otherwise someone could retrieve -a partially completed clipboard or claim ownership away from -this application). -.PP -\fBTk_ClipboardClear\fR may invoke callbacks, including arbitrary -Tcl scripts, as a result of losing the CLIPBOARD selection, so -any calling function should take care to be reentrant at the point -\fBTk_ClipboardClear\fR is invoked. -.SH KEYWORDS -append, clipboard, clear, format, type +'\" +'\" Copyright (c) 1994 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: Clipboard.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_ClipboardClear, Tk_ClipboardAppend \- Manage the clipboard +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +int +\fBTk_ClipboardClear\fR(\fIinterp, tkwin\fR) +.sp +int +\fBTk_ClipboardAppend\fR(\fIinterp, tkwin, target, format, buffer\fR) +.SH ARGUMENTS +.AS Tk_ClipboardClear tkwin +.AP Tcl_Interp *interp in +Interpreter to use for reporting errors. +.AP Tk_Window tkwin in +Window that determines which display's clipboard to manipulate. +.AP Atom target in +Conversion type for this clipboard item; has same meaning as +\fItarget\fR argument to \fBTk_CreateSelHandler\fR. +.AP Atom format in +Representation to use when data is retrieved; has same meaning as +\fIformat\fR argument to \fBTk_CreateSelHandler\fR. +.AP char *buffer in +Null terminated string containing the data to be appended to the clipboard. +.BE +.SH DESCRIPTION +.PP +These two procedures manage the clipboard for Tk. +The clipboard is typically managed by calling \fBTk_ClipboardClear\fR +once, then calling \fBTk_ClipboardAppend\fR to add data for any +number of targets. +.PP +\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. +\fBTk_ClipboardClear\fR must be called before a sequence of +\fBTk_ClipboardAppend\fR calls can be issued. +.PP +\fBTk_ClipboardAppend\fR appends a buffer of data to the clipboard. +The first buffer for a given \fItarget\fR determines the \fIformat\fR +for that \fItarget\fR. +Any successive appends for that \fItarget\fR must have +the same format or an error will be returned. +\fBTk_ClipboardAppend\fR returns \fBTCL_OK\fR if the buffer is +successfully copied onto the clipboard. If the clipboard is not +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. +.PP +In order to guarantee atomicity, no event handling should occur +between \fBTk_ClipboardClear\fR and the following +\fBTk_ClipboardAppend\fR calls (otherwise someone could retrieve +a partially completed clipboard or claim ownership away from +this application). +.PP +\fBTk_ClipboardClear\fR may invoke callbacks, including arbitrary +Tcl scripts, as a result of losing the CLIPBOARD selection, so +any calling function should take care to be reentrant at the point +\fBTk_ClipboardClear\fR is invoked. +.SH KEYWORDS +append, clipboard, clear, format, type diff --git a/doc/ClrSelect.3 b/doc/ClrSelect.3 index d00d51b..a470390 100644 --- a/doc/ClrSelect.3 +++ b/doc/ClrSelect.3 @@ -1,40 +1,40 @@ -'\" -'\" Copyright (c) 1992-1994 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: ClrSelect.3,v 1.3 2008/06/30 22:57:00 dkf Exp $ -'\" -.so man.macros -.TH Tk_ClearSelection 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_ClearSelection \- Deselect a selection -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_ClearSelection\fR(\fItkwin, selection\fR) -.SH ARGUMENTS -.AS Tk_Window tkwin -.AP Tk_Window tkwin in -The selection will be cleared from the display containing this -window. -.AP Atom selection in -The name of selection to be cleared. -.BE -.SH DESCRIPTION -.PP -\fBTk_ClearSelection\fR cancels the selection specified by the atom -\fIselection\fR for the display containing \fItkwin\fR. -The selection need not be in \fItkwin\fR itself or even in -\fItkwin\fR's application. -If there is a window anywhere on \fItkwin\fR's display that -owns \fIselection\fR, the window will be notified and the -selection will be cleared. -If there is no owner for \fIselection\fR on the display, then the -procedure has no effect. -.SH KEYWORDS -clear, selection +'\" +'\" Copyright (c) 1992-1994 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: ClrSelect.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_ClearSelection 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_ClearSelection \- Deselect a selection +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_ClearSelection\fR(\fItkwin, selection\fR) +.SH ARGUMENTS +.AS Tk_Window tkwin +.AP Tk_Window tkwin in +The selection will be cleared from the display containing this +window. +.AP Atom selection in +The name of selection to be cleared. +.BE +.SH DESCRIPTION +.PP +\fBTk_ClearSelection\fR cancels the selection specified by the atom +\fIselection\fR for the display containing \fItkwin\fR. +The selection need not be in \fItkwin\fR itself or even in +\fItkwin\fR's application. +If there is a window anywhere on \fItkwin\fR's display that +owns \fIselection\fR, the window will be notified and the +selection will be cleared. +If there is no owner for \fIselection\fR on the display, then the +procedure has no effect. +.SH KEYWORDS +clear, selection diff --git a/doc/CoordToWin.3 b/doc/CoordToWin.3 index 9eb8427..5e8996c 100644 --- a/doc/CoordToWin.3 +++ b/doc/CoordToWin.3 @@ -1,49 +1,49 @@ -'\" -'\" Copyright (c) 1990-1993 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: CoordToWin.3,v 1.3 2008/06/30 22:57:00 dkf Exp $ -'\" -.so man.macros -.TH Tk_CoordsToWindow 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_CoordsToWindow \- Find window containing a point -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -Tk_Window -\fBTk_CoordsToWindow\fR(\fIrootX, rootY, tkwin\fR) -.SH ARGUMENTS -.AS Tk_Window tkwin -.AP int rootX in -X-coordinate (in root window coordinates). -.AP int rootY in -Y-coordinate (in root window coordinates). -.AP Tk_Window tkwin in -Token for window that identifies application. -.BE -.SH DESCRIPTION -.PP -\fBTk_CoordsToWindow\fR locates the window that contains a given point. -The point is specified in root coordinates with \fIrootX\fR and -\fIrootY\fR (if a virtual-root window manager is in use then -\fIrootX\fR and \fIrootY\fR are in the coordinate system of the -virtual root window). -The return value from the procedure is a token for the window that -contains the given point. -If the point is not in any window, or if the containing window -is not in the same application as \fItkwin\fR, then NULL is -returned. -.PP -The containing window is decided using the same rules that determine -which window contains the mouse cursor: if a parent and a child both -contain the point then the child gets preference, and if two siblings -both contain the point then the highest one in the stacking order -(i.e. the one that's visible on the screen) gets preference. -.SH KEYWORDS -containing, coordinates, root window +'\" +'\" Copyright (c) 1990-1993 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: CoordToWin.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_CoordsToWindow 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_CoordsToWindow \- Find window containing a point +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +Tk_Window +\fBTk_CoordsToWindow\fR(\fIrootX, rootY, tkwin\fR) +.SH ARGUMENTS +.AS Tk_Window tkwin +.AP int rootX in +X-coordinate (in root window coordinates). +.AP int rootY in +Y-coordinate (in root window coordinates). +.AP Tk_Window tkwin in +Token for window that identifies application. +.BE +.SH DESCRIPTION +.PP +\fBTk_CoordsToWindow\fR locates the window that contains a given point. +The point is specified in root coordinates with \fIrootX\fR and +\fIrootY\fR (if a virtual-root window manager is in use then +\fIrootX\fR and \fIrootY\fR are in the coordinate system of the +virtual root window). +The return value from the procedure is a token for the window that +contains the given point. +If the point is not in any window, or if the containing window +is not in the same application as \fItkwin\fR, then NULL is +returned. +.PP +The containing window is decided using the same rules that determine +which window contains the mouse cursor: if a parent and a child both +contain the point then the child gets preference, and if two siblings +both contain the point then the highest one in the stacking order +(i.e. the one that's visible on the screen) gets preference. +.SH KEYWORDS +containing, coordinates, root window diff --git a/doc/CrtGenHdlr.3 b/doc/CrtGenHdlr.3 index 095361f..004e01a 100644 --- a/doc/CrtGenHdlr.3 +++ b/doc/CrtGenHdlr.3 @@ -1,83 +1,83 @@ -'\" -'\" Copyright (c) 1992-1994 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: CrtGenHdlr.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_CreateGenericHandler 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback with all X events -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_CreateGenericHandler\fR(\fIproc, clientData\fR) -.sp -\fBTk_DeleteGenericHandler\fR(\fIproc, clientData\fR) -.SH ARGUMENTS -.AS "Tk_GenericProc" clientData -.AP Tk_GenericProc *proc in -Procedure to invoke whenever any X event occurs on any display. -.AP ClientData clientData in -Arbitrary one-word value to pass to \fIproc\fR. -.BE -.SH DESCRIPTION -.PP -\fBTk_CreateGenericHandler\fR arranges for \fIproc\fR to be -invoked in the future whenever any X event occurs. This mechanism is -\fInot\fR intended for dispatching X events on windows managed by Tk -(you should use \fBTk_CreateEventHandler\fR for this purpose). -\fBTk_CreateGenericHandler\fR is intended for other purposes, such -as tracing X events, monitoring events on windows not owned by Tk, -accessing X-related libraries that were not originally designed for -use with Tk, and so on. -.PP -The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR; -this mechanism only works in programs that dispatch events -through \fBTk_HandleEvent\fR (or through other Tk procedures that -call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or -\fBTk_MainLoop\fR). -.PP -\fIProc\fR should have arguments and result that match the -type \fBTk_GenericProc\fR: -.CS -typedef int \fBTk_GenericProc\fR( - ClientData \fIclientData\fR, - XEvent *\fIeventPtr\fR); -.CE -The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR -argument given to \fBTk_CreateGenericHandler\fR when the callback -was created. Typically, \fIclientData\fR points to a data -structure containing application-specific information about -how to handle events. -\fIEventPtr\fR is a pointer to the X event. -.PP -Whenever an X event is processed by \fBTk_HandleEvent\fR, \fIproc\fR -is called. The return value from \fIproc\fR is normally 0. -A non-zero return value indicates that the event is not to be handled -further; that is, \fIproc\fR has done all processing that is to be -allowed for the event. -.PP -If there are multiple generic event handlers, each one is called -for each event, in the order in which they were established. -.PP -\fBTk_DeleteGenericHandler\fR may be called to delete a -previously-created generic event handler: it deletes each handler -it finds that matches the \fIproc\fR and \fIclientData\fR arguments. If -no such handler exists, then \fBTk_DeleteGenericHandler\fR returns -without doing anything. Although Tk supports it, it's probably -a bad idea to have more than one callback with the same -\fIproc\fR and \fIclientData\fR arguments. -.PP -Establishing a generic event handler does nothing to ensure that the -process will actually receive the X events that the handler wants to -process. -For example, it is the caller's responsibility to invoke -\fBXSelectInput\fR to select the desired events, if that is necessary. -.SH KEYWORDS -bind, callback, event, handler +'\" +'\" Copyright (c) 1992-1994 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: CrtGenHdlr.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_CreateGenericHandler 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback with all X events +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_CreateGenericHandler\fR(\fIproc, clientData\fR) +.sp +\fBTk_DeleteGenericHandler\fR(\fIproc, clientData\fR) +.SH ARGUMENTS +.AS "Tk_GenericProc" clientData +.AP Tk_GenericProc *proc in +Procedure to invoke whenever any X event occurs on any display. +.AP ClientData clientData in +Arbitrary one-word value to pass to \fIproc\fR. +.BE +.SH DESCRIPTION +.PP +\fBTk_CreateGenericHandler\fR arranges for \fIproc\fR to be +invoked in the future whenever any X event occurs. This mechanism is +\fInot\fR intended for dispatching X events on windows managed by Tk +(you should use \fBTk_CreateEventHandler\fR for this purpose). +\fBTk_CreateGenericHandler\fR is intended for other purposes, such +as tracing X events, monitoring events on windows not owned by Tk, +accessing X-related libraries that were not originally designed for +use with Tk, and so on. +.PP +The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR; +this mechanism only works in programs that dispatch events +through \fBTk_HandleEvent\fR (or through other Tk procedures that +call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or +\fBTk_MainLoop\fR). +.PP +\fIProc\fR should have arguments and result that match the +type \fBTk_GenericProc\fR: +.CS +typedef int \fBTk_GenericProc\fR( + ClientData \fIclientData\fR, + XEvent *\fIeventPtr\fR); +.CE +The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR +argument given to \fBTk_CreateGenericHandler\fR when the callback +was created. Typically, \fIclientData\fR points to a data +structure containing application-specific information about +how to handle events. +\fIEventPtr\fR is a pointer to the X event. +.PP +Whenever an X event is processed by \fBTk_HandleEvent\fR, \fIproc\fR +is called. The return value from \fIproc\fR is normally 0. +A non-zero return value indicates that the event is not to be handled +further; that is, \fIproc\fR has done all processing that is to be +allowed for the event. +.PP +If there are multiple generic event handlers, each one is called +for each event, in the order in which they were established. +.PP +\fBTk_DeleteGenericHandler\fR may be called to delete a +previously-created generic event handler: it deletes each handler +it finds that matches the \fIproc\fR and \fIclientData\fR arguments. If +no such handler exists, then \fBTk_DeleteGenericHandler\fR returns +without doing anything. Although Tk supports it, it's probably +a bad idea to have more than one callback with the same +\fIproc\fR and \fIclientData\fR arguments. +.PP +Establishing a generic event handler does nothing to ensure that the +process will actually receive the X events that the handler wants to +process. +For example, it is the caller's responsibility to invoke +\fBXSelectInput\fR to select the desired events, if that is necessary. +.SH KEYWORDS +bind, callback, event, handler diff --git a/doc/DrawFocHlt.3 b/doc/DrawFocHlt.3 index a66d347..a3dffed 100644 --- a/doc/DrawFocHlt.3 +++ b/doc/DrawFocHlt.3 @@ -1,38 +1,38 @@ -'\" -'\" Copyright (c) 1995-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: DrawFocHlt.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR -.SH ARGUMENTS -.AS "Tcl_Interp" *joinPtr -.AP Tk_Window tkwin in -Window for which the highlight is being drawn. Used to retrieve -the window's dimensions, among other things. -.AP GC gc in -Graphics context to use for drawing the highlight. -.AP int width in -Width of the highlight ring, in pixels. -.AP Drawable drawable in -Drawable in which to draw the highlight; usually an offscreen -pixmap for double buffering. -.BE -.SH DESCRIPTION -.PP -\fBTk_DrawFocusHighlight\fR is a utility procedure that draws the -traversal highlight ring for a widget. -It is typically invoked by widgets during redisplay. -.SH KEYWORDS -focus, traversal highlight +'\" +'\" Copyright (c) 1995-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: DrawFocHlt.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_DrawFocusHighlight 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_DrawFocusHighlight \- draw the traversal highlight ring for a widget +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_DrawFocusHighlight(\fItkwin, gc, width, drawable\fB)\fR +.SH ARGUMENTS +.AS "Tcl_Interp" *joinPtr +.AP Tk_Window tkwin in +Window for which the highlight is being drawn. Used to retrieve +the window's dimensions, among other things. +.AP GC gc in +Graphics context to use for drawing the highlight. +.AP int width in +Width of the highlight ring, in pixels. +.AP Drawable drawable in +Drawable in which to draw the highlight; usually an offscreen +pixmap for double buffering. +.BE +.SH DESCRIPTION +.PP +\fBTk_DrawFocusHighlight\fR is a utility procedure that draws the +traversal highlight ring for a widget. +It is typically invoked by widgets during redisplay. +.SH KEYWORDS +focus, traversal highlight diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3 index 3096c38..36ac475 100644 --- a/doc/EventHndlr.3 +++ b/doc/EventHndlr.3 @@ -1,77 +1,77 @@ -'\" -'\" Copyright (c) 1990 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: EventHndlr.3,v 1.6 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR) -.sp -\fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR) -.SH ARGUMENTS -.AS "unsigned long" clientData -.AP Tk_Window tkwin in -Token for window in which events may occur. -.AP "unsigned long" mask in -Bit-mask of events (such as \fBButtonPressMask\fR) -for which \fIproc\fR should be called. -.AP Tk_EventProc *proc in -Procedure to invoke whenever an event in \fImask\fR occurs -in the window given by \fItkwin\fR. -.AP ClientData clientData in -Arbitrary one-word value to pass to \fIproc\fR. -.BE -.SH DESCRIPTION -.PP -\fBTk_CreateEventHandler\fR arranges for \fIproc\fR to be -invoked in the future whenever one of the event types specified -by \fImask\fR occurs in the window specified by \fItkwin\fR. -The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR; -this mechanism only works in programs that dispatch events -through \fBTk_HandleEvent\fR (or through other Tk procedures that -call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or -\fBTk_MainLoop\fR). -.PP -\fIProc\fR should have arguments and result that match the -type \fBTk_EventProc\fR: -.CS -typedef void \fBTk_EventProc\fR( - ClientData \fIclientData\fR, - XEvent *\fIeventPtr\fR); -.CE -The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR -argument given to \fBTk_CreateEventHandler\fR when the callback -was created. Typically, \fIclientData\fR points to a data -structure containing application-specific information about -the window in which the event occurred. \fIEventPtr\fR is -a pointer to the X event, which will be one of the ones -specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR. -.PP -\fBTk_DeleteEventHandler\fR may be called to delete a -previously-created event handler: it deletes the first handler -it finds that is associated with \fItkwin\fR and matches the -\fImask\fR, \fIproc\fR, and \fIclientData\fR arguments. If -no such handler exists, then \fBTk_HandleEvent\fR returns -without doing anything. Although Tk supports it, it's probably -a bad idea to have more than one callback with the same \fImask\fR, -\fIproc\fR, and \fIclientData\fR arguments. -When a window is deleted all of its handlers will be deleted -automatically; in this case there is no need to call -\fBTk_DeleteEventHandler\fR. -.PP -If multiple handlers are declared for the same type of X event -on the same window, then the handlers will be invoked in the -order they were created. -.SH KEYWORDS -bind, callback, event, handler +'\" +'\" Copyright (c) 1990 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: EventHndlr.3,v 1.7 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR) +.sp +\fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR) +.SH ARGUMENTS +.AS "unsigned long" clientData +.AP Tk_Window tkwin in +Token for window in which events may occur. +.AP "unsigned long" mask in +Bit-mask of events (such as \fBButtonPressMask\fR) +for which \fIproc\fR should be called. +.AP Tk_EventProc *proc in +Procedure to invoke whenever an event in \fImask\fR occurs +in the window given by \fItkwin\fR. +.AP ClientData clientData in +Arbitrary one-word value to pass to \fIproc\fR. +.BE +.SH DESCRIPTION +.PP +\fBTk_CreateEventHandler\fR arranges for \fIproc\fR to be +invoked in the future whenever one of the event types specified +by \fImask\fR occurs in the window specified by \fItkwin\fR. +The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR; +this mechanism only works in programs that dispatch events +through \fBTk_HandleEvent\fR (or through other Tk procedures that +call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or +\fBTk_MainLoop\fR). +.PP +\fIProc\fR should have arguments and result that match the +type \fBTk_EventProc\fR: +.CS +typedef void \fBTk_EventProc\fR( + ClientData \fIclientData\fR, + XEvent *\fIeventPtr\fR); +.CE +The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR +argument given to \fBTk_CreateEventHandler\fR when the callback +was created. Typically, \fIclientData\fR points to a data +structure containing application-specific information about +the window in which the event occurred. \fIEventPtr\fR is +a pointer to the X event, which will be one of the ones +specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR. +.PP +\fBTk_DeleteEventHandler\fR may be called to delete a +previously-created event handler: it deletes the first handler +it finds that is associated with \fItkwin\fR and matches the +\fImask\fR, \fIproc\fR, and \fIclientData\fR arguments. If +no such handler exists, then \fBTk_HandleEvent\fR returns +without doing anything. Although Tk supports it, it's probably +a bad idea to have more than one callback with the same \fImask\fR, +\fIproc\fR, and \fIclientData\fR arguments. +When a window is deleted all of its handlers will be deleted +automatically; in this case there is no need to call +\fBTk_DeleteEventHandler\fR. +.PP +If multiple handlers are declared for the same type of X event +on the same window, then the handlers will be invoked in the +order they were created. +.SH KEYWORDS +bind, callback, event, handler diff --git a/doc/GeomReq.3 b/doc/GeomReq.3 index 72ccc5a..ab2223a 100644 --- a/doc/GeomReq.3 +++ b/doc/GeomReq.3 @@ -1,95 +1,95 @@ -'\" -'\" Copyright (c) 1990-1994 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: GeomReq.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetInternalBorderEx \- specify desired geometry or internal border for a window -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR) -.sp -\fBTk_SetMinimumRequestSize\fR(\fItkwin, minWidth, minHeight\fR) -.sp -\fBTk_SetInternalBorder\fR(\fItkwin, width\fR) -.sp -\fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR) -.SH ARGUMENTS -.AS baseHeight clientData -.AP Tk_Window tkwin in -Window for which geometry is being requested. -.AP int reqWidth in -Desired width for \fItkwin\fR, in pixel units. -.AP int reqHeight in -Desired height for \fItkwin\fR, in pixel units. -.AP int minWidth in -Desired minimum requested width for \fItkwin\fR, in pixel units. -.AP int minHeight in -Desired minimum requested height for \fItkwin\fR, in pixel units. -.AP int width in -Space to leave for internal border for \fItkwin\fR, in pixel units. -.AP int left in -Space to leave for left side of internal border for \fItkwin\fR, in pixel units. -.AP int right in -Space to leave for right side of internal border for \fItkwin\fR, in pixel units. -.AP int top in -Space to leave for top side of internal border for \fItkwin\fR, in pixel units. -.AP int bottom in -Space to leave for bottom side of internal border for \fItkwin\fR, in pixel units. -.BE -.SH DESCRIPTION -.PP -\fBTk_GeometryRequest\fR is called by widget code to indicate its -preference for the dimensions of a particular window. The arguments -to \fBTk_GeometryRequest\fR are made available to the geometry -manager for the window, which then decides on the actual geometry -for the window. Although geometry managers generally try to satisfy -requests made to \fBTk_GeometryRequest\fR, there is no guarantee that -this will always be possible. Widget code should not assume that -a geometry request will be satisfied until it receives a -\fBConfigureNotify\fR event indicating that the geometry change has -occurred. Widget code should never call procedures like -\fBTk_ResizeWindow\fR directly. Instead, it should invoke -\fBTk_GeometryRequest\fR and leave the final geometry decisions to -the geometry manager. -.PP -If \fItkwin\fR is a top-level window, then the geometry information -will be passed to the window manager using the standard ICCCM protocol. -.PP -\fBTk_SetInternalBorder\fR is called by widget code to indicate that -the widget has an internal border. This means that the widget draws -a decorative border inside the window instead of using the standard -X borders, which are external to the window's area. For example, -internal borders are used to draw 3-D effects. \fIWidth\fR -specifies the width of the border in pixels. Geometry managers will -use this information to avoid placing any children of \fItkwin\fR -overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area. -.PP -\fBTk_SetInternalBorderEx\fR works like \fBTk_SetInternalBorder\fR -but lets you specify different widths for different sides of the window. -.PP -\fBTk_SetMinimumRequestSize\fR is called by widget code to indicate -that a geometry manager should request at least this size for the -widget. This allows a widget to have some control over its size when -a propagating geometry manager is used inside it. -.PP -The information specified in calls to \fBTk_GeometryRequest\fR, -\fBTk_SetMinimumRequestSize\fR, \fBTk_SetInternalBorder\fR and -\fBTk_SetInternalBorderEx\fR can be retrieved using the macros -\fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, \fBTk_MinReqWidth\fR, -\fBTk_MinReqHeight\fR, \fBTk_MinReqWidth\fR, \fBTk_InternalBorderLeft\fR, -\fBTk_InternalBorderRight\fR, \fBTk_InternalBorderTop\fR and -\fBTk_InternalBorderBottom\fR. -See the \fBTk_WindowId\fR manual entry for details. -.SH KEYWORDS -geometry, request +'\" +'\" Copyright (c) 1990-1994 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: GeomReq.3,v 1.5 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_GeometryRequest 3 "8.4" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_GeometryRequest, Tk_SetMinimumRequestSize, Tk_SetInternalBorder, Tk_SetInternalBorderEx \- specify desired geometry or internal border for a window +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_GeometryRequest\fR(\fItkwin, reqWidth, reqHeight\fR) +.sp +\fBTk_SetMinimumRequestSize\fR(\fItkwin, minWidth, minHeight\fR) +.sp +\fBTk_SetInternalBorder\fR(\fItkwin, width\fR) +.sp +\fBTk_SetInternalBorderEx\fR(\fItkwin, left, right, top, bottom\fR) +.SH ARGUMENTS +.AS baseHeight clientData +.AP Tk_Window tkwin in +Window for which geometry is being requested. +.AP int reqWidth in +Desired width for \fItkwin\fR, in pixel units. +.AP int reqHeight in +Desired height for \fItkwin\fR, in pixel units. +.AP int minWidth in +Desired minimum requested width for \fItkwin\fR, in pixel units. +.AP int minHeight in +Desired minimum requested height for \fItkwin\fR, in pixel units. +.AP int width in +Space to leave for internal border for \fItkwin\fR, in pixel units. +.AP int left in +Space to leave for left side of internal border for \fItkwin\fR, in pixel units. +.AP int right in +Space to leave for right side of internal border for \fItkwin\fR, in pixel units. +.AP int top in +Space to leave for top side of internal border for \fItkwin\fR, in pixel units. +.AP int bottom in +Space to leave for bottom side of internal border for \fItkwin\fR, in pixel units. +.BE +.SH DESCRIPTION +.PP +\fBTk_GeometryRequest\fR is called by widget code to indicate its +preference for the dimensions of a particular window. The arguments +to \fBTk_GeometryRequest\fR are made available to the geometry +manager for the window, which then decides on the actual geometry +for the window. Although geometry managers generally try to satisfy +requests made to \fBTk_GeometryRequest\fR, there is no guarantee that +this will always be possible. Widget code should not assume that +a geometry request will be satisfied until it receives a +\fBConfigureNotify\fR event indicating that the geometry change has +occurred. Widget code should never call procedures like +\fBTk_ResizeWindow\fR directly. Instead, it should invoke +\fBTk_GeometryRequest\fR and leave the final geometry decisions to +the geometry manager. +.PP +If \fItkwin\fR is a top-level window, then the geometry information +will be passed to the window manager using the standard ICCCM protocol. +.PP +\fBTk_SetInternalBorder\fR is called by widget code to indicate that +the widget has an internal border. This means that the widget draws +a decorative border inside the window instead of using the standard +X borders, which are external to the window's area. For example, +internal borders are used to draw 3-D effects. \fIWidth\fR +specifies the width of the border in pixels. Geometry managers will +use this information to avoid placing any children of \fItkwin\fR +overlapping the outermost \fIwidth\fR pixels of \fItkwin\fR's area. +.PP +\fBTk_SetInternalBorderEx\fR works like \fBTk_SetInternalBorder\fR +but lets you specify different widths for different sides of the window. +.PP +\fBTk_SetMinimumRequestSize\fR is called by widget code to indicate +that a geometry manager should request at least this size for the +widget. This allows a widget to have some control over its size when +a propagating geometry manager is used inside it. +.PP +The information specified in calls to \fBTk_GeometryRequest\fR, +\fBTk_SetMinimumRequestSize\fR, \fBTk_SetInternalBorder\fR and +\fBTk_SetInternalBorderEx\fR can be retrieved using the macros +\fBTk_ReqWidth\fR, \fBTk_ReqHeight\fR, \fBTk_MinReqWidth\fR, +\fBTk_MinReqHeight\fR, \fBTk_MinReqWidth\fR, \fBTk_InternalBorderLeft\fR, +\fBTk_InternalBorderRight\fR, \fBTk_InternalBorderTop\fR and +\fBTk_InternalBorderBottom\fR. +See the \fBTk_WindowId\fR manual entry for details. +.SH KEYWORDS +geometry, request diff --git a/doc/GetGC.3 b/doc/GetGC.3 index 97ac503..c2b61b9 100644 --- a/doc/GetGC.3 +++ b/doc/GetGC.3 @@ -1,72 +1,72 @@ -'\" -'\" Copyright (c) 1990 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: GetGC.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_GetGC 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_GetGC, Tk_FreeGC \- maintain database of read-only graphics contexts -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -GC -\fBTk_GetGC\fR(\fItkwin, valueMask, valuePtr\fR) -.sp -\fBTk_FreeGC(\fIdisplay, gc\fR) -.SH ARGUMENTS -.AS "unsigned long" valueMask -.AP Tk_Window tkwin in -Token for window in which the graphics context will be used. -.AP "unsigned long" valueMask in -Mask of bits (such as \fBGCForeground\fR or \fBGCStipple\fR) -indicating which fields of \fI*valuePtr\fR are valid. -.AP XGCValues *valuePtr in -Pointer to structure describing the desired values for the -graphics context. -.AP Display *display in -Display for which \fIgc\fR was allocated. -.AP GC gc in -X identifier for graphics context that is no longer needed. -Must have been allocated by \fBTk_GetGC\fR. -.BE -.SH DESCRIPTION -.PP -\fBTk_GetGC\fR and \fBTk_FreeGC\fR manage a collection of graphics contexts -being used by an application. The procedures allow graphics contexts to be -shared, thereby avoiding the server overhead that would be incurred -if a separate GC were created for each use. \fBTk_GetGC\fR takes arguments -describing the desired graphics context and returns an X identifier -for a GC that fits the description. The graphics context that is returned -will have default values in all of the fields not specified explicitly -by \fIvalueMask\fR and \fIvaluePtr\fR. -.PP -\fBTk_GetGC\fR maintains a -database of all the graphics contexts it has created. Whenever possible, -a call to \fBTk_GetGC\fR will -return an existing graphics context rather than creating a new one. This -approach can substantially reduce server overhead, so \fBTk_GetGC\fR -should generally be used in preference to the Xlib procedure -\fBXCreateGC\fR, which creates a new graphics context on each call. -.PP -Since the return values of \fBTk_GetGC\fR -are shared, callers should never modify the graphics contexts -returned by \fBTk_GetGC\fR. -If a graphics context must be modified dynamically, then it should be -created by calling \fBXCreateGC\fR instead of \fBTk_GetGC\fR. -.PP -When a graphics context -is no longer needed, \fBTk_FreeGC\fR should be called to release it. -There should be exactly one call to \fBTk_FreeGC\fR for -each call to \fBTk_GetGC\fR. -When a graphics context is no longer in use anywhere (i.e. it has -been freed as many times as it has been gotten) \fBTk_FreeGC\fR -will release it to the X server and delete it from the database. -.SH KEYWORDS -graphics context +'\" +'\" Copyright (c) 1990 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: GetGC.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_GetGC 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_GetGC, Tk_FreeGC \- maintain database of read-only graphics contexts +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +GC +\fBTk_GetGC\fR(\fItkwin, valueMask, valuePtr\fR) +.sp +\fBTk_FreeGC(\fIdisplay, gc\fR) +.SH ARGUMENTS +.AS "unsigned long" valueMask +.AP Tk_Window tkwin in +Token for window in which the graphics context will be used. +.AP "unsigned long" valueMask in +Mask of bits (such as \fBGCForeground\fR or \fBGCStipple\fR) +indicating which fields of \fI*valuePtr\fR are valid. +.AP XGCValues *valuePtr in +Pointer to structure describing the desired values for the +graphics context. +.AP Display *display in +Display for which \fIgc\fR was allocated. +.AP GC gc in +X identifier for graphics context that is no longer needed. +Must have been allocated by \fBTk_GetGC\fR. +.BE +.SH DESCRIPTION +.PP +\fBTk_GetGC\fR and \fBTk_FreeGC\fR manage a collection of graphics contexts +being used by an application. The procedures allow graphics contexts to be +shared, thereby avoiding the server overhead that would be incurred +if a separate GC were created for each use. \fBTk_GetGC\fR takes arguments +describing the desired graphics context and returns an X identifier +for a GC that fits the description. The graphics context that is returned +will have default values in all of the fields not specified explicitly +by \fIvalueMask\fR and \fIvaluePtr\fR. +.PP +\fBTk_GetGC\fR maintains a +database of all the graphics contexts it has created. Whenever possible, +a call to \fBTk_GetGC\fR will +return an existing graphics context rather than creating a new one. This +approach can substantially reduce server overhead, so \fBTk_GetGC\fR +should generally be used in preference to the Xlib procedure +\fBXCreateGC\fR, which creates a new graphics context on each call. +.PP +Since the return values of \fBTk_GetGC\fR +are shared, callers should never modify the graphics contexts +returned by \fBTk_GetGC\fR. +If a graphics context must be modified dynamically, then it should be +created by calling \fBXCreateGC\fR instead of \fBTk_GetGC\fR. +.PP +When a graphics context +is no longer needed, \fBTk_FreeGC\fR should be called to release it. +There should be exactly one call to \fBTk_FreeGC\fR for +each call to \fBTk_GetGC\fR. +When a graphics context is no longer in use anywhere (i.e. it has +been freed as many times as it has been gotten) \fBTk_FreeGC\fR +will release it to the X server and delete it from the database. +.SH KEYWORDS +graphics context diff --git a/doc/GetHWND.3 b/doc/GetHWND.3 index 664277c..7356f89 100644 --- a/doc/GetHWND.3 +++ b/doc/GetHWND.3 @@ -1,39 +1,39 @@ -'\" -'\" Copyright (c) 1998-2000 by Scriptics Corporation. -'\" All rights reserved. -'\" -'\" RCS: @(#) $Id: GetHWND.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" -'\" -.so man.macros -.TH HWND 3 8.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_GetHWND, Tk_AttachHWND \- manage interactions between the Windows handle and an X window -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -HWND -\fBTk_GetHWND\fR(\fIwindow\fR) -.sp -Window -\fBTk_AttachHWND\fR(\fItkwin, hwnd\fR) -.SH ARGUMENTS -.AP Window window in -X token for window. -.AP Tk_Window tkwin in -Tk window for window. -.AP HWND hwnd in -Windows HWND for window. -.BE -.SH DESCRIPTION -.PP -\fBTk_GetHWND\fR returns the Windows HWND identifier for X Windows -window given by \fIwindow\fR. -.PP -\fBTk_AttachHWND\fR binds the Windows HWND identifier to the -specified Tk_Window given by \fItkwin\fR. It returns an X Windows -window that encapsulates the HWND. -.SH KEYWORDS -identifier, window +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: GetHWND.3,v 1.6 2008/07/08 22:40:50 patthoyts Exp $ +'\" +'\" +.so man.macros +.TH HWND 3 8.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_GetHWND, Tk_AttachHWND \- manage interactions between the Windows handle and an X window +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +HWND +\fBTk_GetHWND\fR(\fIwindow\fR) +.sp +Window +\fBTk_AttachHWND\fR(\fItkwin, hwnd\fR) +.SH ARGUMENTS +.AP Window window in +X token for window. +.AP Tk_Window tkwin in +Tk window for window. +.AP HWND hwnd in +Windows HWND for window. +.BE +.SH DESCRIPTION +.PP +\fBTk_GetHWND\fR returns the Windows HWND identifier for X Windows +window given by \fIwindow\fR. +.PP +\fBTk_AttachHWND\fR binds the Windows HWND identifier to the +specified Tk_Window given by \fItkwin\fR. It returns an X Windows +window that encapsulates the HWND. +.SH KEYWORDS +identifier, window diff --git a/doc/GetPixmap.3 b/doc/GetPixmap.3 index d851387..93460c0 100644 --- a/doc/GetPixmap.3 +++ b/doc/GetPixmap.3 @@ -1,54 +1,54 @@ -'\" -'\" Copyright (c) 1990 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: GetPixmap.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -Pixmap -\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR -.sp -\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR -.SH ARGUMENTS -.AS "Drawable" *pixelPtr -.AP Display *display in -X display for the pixmap. -.AP Drawable d in -Pixmap or window where the new pixmap will be used for drawing. -.AP "int" width in -Width of pixmap. -.AP "int" height in -Height of pixmap. -.AP "int" depth in -Number of bits per pixel in pixmap. -.AP Pixmap pixmap in -Pixmap to destroy. -.BE -.SH DESCRIPTION -.PP -These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR -and \fBXFreePixmap\fR, except that they have extra code to manage X -resource identifiers so that identifiers for deleted pixmaps can be -reused in the future. -It is important for Tk applications to use these procedures rather -than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running -applications may run out of resource identifiers. -.PP -\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR, -with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR, -and returns its identifier. -\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes -its resource identifier available for reuse. -.SH KEYWORDS -pixmap, resource identifier +'\" +'\" Copyright (c) 1990 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: GetPixmap.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_GetPixmap 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_GetPixmap, Tk_FreePixmap \- allocate and free pixmaps +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +Pixmap +\fBTk_GetPixmap(\fIdisplay, d, width, height, depth\fB)\fR +.sp +\fBTk_FreePixmap(\fIdisplay, pixmap\fB)\fR +.SH ARGUMENTS +.AS "Drawable" *pixelPtr +.AP Display *display in +X display for the pixmap. +.AP Drawable d in +Pixmap or window where the new pixmap will be used for drawing. +.AP "int" width in +Width of pixmap. +.AP "int" height in +Height of pixmap. +.AP "int" depth in +Number of bits per pixel in pixmap. +.AP Pixmap pixmap in +Pixmap to destroy. +.BE +.SH DESCRIPTION +.PP +These procedures are identical to the Xlib procedures \fBXCreatePixmap\fR +and \fBXFreePixmap\fR, except that they have extra code to manage X +resource identifiers so that identifiers for deleted pixmaps can be +reused in the future. +It is important for Tk applications to use these procedures rather +than \fBXCreatePixmap\fR and \fBXFreePixmap\fR; otherwise long-running +applications may run out of resource identifiers. +.PP +\fBTk_GetPixmap\fR creates a pixmap suitable for drawing in \fId\fR, +with dimensions given by \fIwidth\fR, \fIheight\fR, and \fIdepth\fR, +and returns its identifier. +\fBTk_FreePixmap\fR destroys the pixmap given by \fIpixmap\fR and makes +its resource identifier available for reuse. +.SH KEYWORDS +pixmap, resource identifier diff --git a/doc/Grab.3 b/doc/Grab.3 index 0db62c0..fd4c2f7 100644 --- a/doc/Grab.3 +++ b/doc/Grab.3 @@ -1,60 +1,60 @@ -'\" -'\" Copyright (c) 1998-2000 by Scriptics Corporation. -'\" All rights reserved. -'\" -'\" RCS: @(#) $Id: Grab.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_Grab 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_Grab, Tk_Ungrab \- manipulate grab state in an application -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -int -\fBTk_Grab\fR(\fIinterp, tkwin, grabGlobal\fR) -.sp -void -\fBTk_Ungrab\fR(\fItkwin\fR) -.SH ARGUMENTS -.AP Tcl_Interp *interp in -Interpreter to use for error reporting -.AP Tk_Window tkwin in -Window on whose behalf the pointer is to be grabbed or released -.AP int grabGlobal in -Boolean indicating whether the grab is global or application local -.BE -.SH DESCRIPTION -.PP -These functions are used to set or release a global or -application local grab. When a grab is set on a particular window -in a Tk application, mouse and keyboard events can only be received by -that window and its descendants. Mouse and keyboard events for -windows outside the tree rooted at \fItkwin\fR will be redirected to -\fItkwin\fR. If the grab is global, then all mouse and keyboard -events for windows outside the tree rooted at \fItkwin\fR (even those -intended for windows in other applications) will be redirected to -\fItkwin\fR. If the grab is application local, only mouse and -keyboard events intended for a windows within the same application -(but outside the tree rooted at \fItkwin\fR) will be redirected. -.PP -\fBTk_Grab\fR sets a grab on a particular window. \fITkwin\fR -specifies the window on whose behalf the pointer is to be grabbed. -\fIGrabGlobal\fR indicates whether the grab should be global or -application local; if it is non-zero, it means the grab should be -global. Normally, \fBTk_Grab\fR returns \fBTCL_OK\fR; if an error occurs -and the grab cannot be set, \fBTCL_ERROR\fR is returned and an error message -is left if \fIinterp\fR's result. Once this call completes -successfully, no window outside the tree rooted at \fItkwin\fR will -receive pointer- or keyboard-related events until the next call to -Tk_Ungrab. If a previous grab was in effect within the application, -then it is replaced with a new one. -.PP -\fBTcl_Ungrab\fR releases a grab on the mouse pointer and keyboard, if -there is one set on the window given by \fItkwin\fR. Once a grab is -released, pointer and keyboard events will start being delivered to -other windows again. -.SH KEYWORDS -grab, window +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: Grab.3,v 1.4 2008/07/08 22:40:50 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_Grab 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_Grab, Tk_Ungrab \- manipulate grab state in an application +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +int +\fBTk_Grab\fR(\fIinterp, tkwin, grabGlobal\fR) +.sp +void +\fBTk_Ungrab\fR(\fItkwin\fR) +.SH ARGUMENTS +.AP Tcl_Interp *interp in +Interpreter to use for error reporting +.AP Tk_Window tkwin in +Window on whose behalf the pointer is to be grabbed or released +.AP int grabGlobal in +Boolean indicating whether the grab is global or application local +.BE +.SH DESCRIPTION +.PP +These functions are used to set or release a global or +application local grab. When a grab is set on a particular window +in a Tk application, mouse and keyboard events can only be received by +that window and its descendants. Mouse and keyboard events for +windows outside the tree rooted at \fItkwin\fR will be redirected to +\fItkwin\fR. If the grab is global, then all mouse and keyboard +events for windows outside the tree rooted at \fItkwin\fR (even those +intended for windows in other applications) will be redirected to +\fItkwin\fR. If the grab is application local, only mouse and +keyboard events intended for a windows within the same application +(but outside the tree rooted at \fItkwin\fR) will be redirected. +.PP +\fBTk_Grab\fR sets a grab on a particular window. \fITkwin\fR +specifies the window on whose behalf the pointer is to be grabbed. +\fIGrabGlobal\fR indicates whether the grab should be global or +application local; if it is non-zero, it means the grab should be +global. Normally, \fBTk_Grab\fR returns \fBTCL_OK\fR; if an error occurs +and the grab cannot be set, \fBTCL_ERROR\fR is returned and an error message +is left if \fIinterp\fR's result. Once this call completes +successfully, no window outside the tree rooted at \fItkwin\fR will +receive pointer- or keyboard-related events until the next call to +Tk_Ungrab. If a previous grab was in effect within the application, +then it is replaced with a new one. +.PP +\fBTcl_Ungrab\fR releases a grab on the mouse pointer and keyboard, if +there is one set on the window given by \fItkwin\fR. Once a grab is +released, pointer and keyboard events will start being delivered to +other windows again. +.SH KEYWORDS +grab, window diff --git a/doc/HWNDToWindow.3 b/doc/HWNDToWindow.3 index 9e60bab..8fdf4a2 100644 --- a/doc/HWNDToWindow.3 +++ b/doc/HWNDToWindow.3 @@ -1,28 +1,28 @@ -'\" -'\" Copyright (c) 1998-2000 by Scriptics Corporation. -'\" All rights reserved. -'\" -'\" RCS: @(#) $Id: HWNDToWindow.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_HWNDToWindow \- Find Tk's window information for a Windows window -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -Tk_Window -\fBTk_HWNDToWindow\fR(\fIhwnd\fR) -.SH ARGUMENTS -.AP HWND hwnd in -Windows handle for the window. -.BE -.SH DESCRIPTION -.PP -Given a Windows HWND window identifier, this procedure returns the -corresponding Tk_Window handle. If there is no Tk_Window corresponding -to \fIhwnd\fR then NULL is returned. -.SH KEYWORDS -Windows window id +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: HWNDToWindow.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_HWNDToWindow 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_HWNDToWindow \- Find Tk's window information for a Windows window +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +Tk_Window +\fBTk_HWNDToWindow\fR(\fIhwnd\fR) +.SH ARGUMENTS +.AP HWND hwnd in +Windows handle for the window. +.BE +.SH DESCRIPTION +.PP +Given a Windows HWND window identifier, this procedure returns the +corresponding Tk_Window handle. If there is no Tk_Window corresponding +to \fIhwnd\fR then NULL is returned. +.SH KEYWORDS +Windows window id diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3 index 69ed289..8f1b319 100644 --- a/doc/HandleEvent.3 +++ b/doc/HandleEvent.3 @@ -1,47 +1,47 @@ -'\" -'\" Copyright (c) 1990-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: HandleEvent.3,v 1.5 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_HandleEvent \- invoke event handlers for window system events -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_HandleEvent\fR(\fIeventPtr\fR) -.SH ARGUMENTS -.AS XEvent *eventPtr -.AP XEvent *eventPtr in -Pointer to X event to dispatch to relevant handler(s). -.BE -.SH DESCRIPTION -.PP -\fBTk_HandleEvent\fR is a lower-level procedure that deals with window -events. It is called by \fBTcl_ServiceEvent\fR (and indirectly by -\fBTk_DoOneEvent\fR), and in a few other cases within Tk. -It makes callbacks to any window event -handlers (created by calls to \fBTk_CreateEventHandler\fR) -that match \fIeventPtr\fR and then returns. In some cases -it may be useful for an application to bypass the Tk event -queue and call \fBTk_HandleEvent\fR directly instead of -calling \fBTcl_QueueEvent\fR followed by -\fBTcl_ServiceEvent\fR. -.PP -This procedure may be invoked recursively. For example, -it is possible to invoke \fBTk_HandleEvent\fR recursively -from a handler called by \fBTk_HandleEvent\fR. This sort -of operation is useful in some modal situations, such -as when a -notifier has been popped up and an application wishes to -wait for the user to click a button in the notifier before -doing anything else. -.SH KEYWORDS -callback, event, handler, window +'\" +'\" Copyright (c) 1990-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: HandleEvent.3,v 1.6 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_HandleEvent \- invoke event handlers for window system events +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_HandleEvent\fR(\fIeventPtr\fR) +.SH ARGUMENTS +.AS XEvent *eventPtr +.AP XEvent *eventPtr in +Pointer to X event to dispatch to relevant handler(s). +.BE +.SH DESCRIPTION +.PP +\fBTk_HandleEvent\fR is a lower-level procedure that deals with window +events. It is called by \fBTcl_ServiceEvent\fR (and indirectly by +\fBTk_DoOneEvent\fR), and in a few other cases within Tk. +It makes callbacks to any window event +handlers (created by calls to \fBTk_CreateEventHandler\fR) +that match \fIeventPtr\fR and then returns. In some cases +it may be useful for an application to bypass the Tk event +queue and call \fBTk_HandleEvent\fR directly instead of +calling \fBTcl_QueueEvent\fR followed by +\fBTcl_ServiceEvent\fR. +.PP +This procedure may be invoked recursively. For example, +it is possible to invoke \fBTk_HandleEvent\fR recursively +from a handler called by \fBTk_HandleEvent\fR. This sort +of operation is useful in some modal situations, such +as when a +notifier has been popped up and an application wishes to +wait for the user to click a button in the notifier before +doing anything else. +.SH KEYWORDS +callback, event, handler, window diff --git a/doc/IdToWindow.3 b/doc/IdToWindow.3 index b1cb5c3..f6e2486 100644 --- a/doc/IdToWindow.3 +++ b/doc/IdToWindow.3 @@ -1,34 +1,34 @@ -'\" -'\" Copyright (c) 1995-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: IdToWindow.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_IdToWindow 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_IdToWindow \- Find Tk's window information for an X window -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -Tk_Window -\fBTk_IdToWindow\fR(\fIdisplay, window\fR) -.SH ARGUMENTS -.AS Tk_Window display -.AP Display *display in -X display containing the window. -.AP Window window in -X id for window. -.BE -.SH DESCRIPTION -.PP -Given an X window identifier and the X display it corresponds to, -this procedure returns the corresponding Tk_Window handle. -If there is no Tk_Window corresponding to \fIwindow\fR then -NULL is returned. -.SH KEYWORDS -X window id +'\" +'\" Copyright (c) 1995-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: IdToWindow.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_IdToWindow 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_IdToWindow \- Find Tk's window information for an X window +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +Tk_Window +\fBTk_IdToWindow\fR(\fIdisplay, window\fR) +.SH ARGUMENTS +.AS Tk_Window display +.AP Display *display in +X display containing the window. +.AP Window window in +X id for window. +.BE +.SH DESCRIPTION +.PP +Given an X window identifier and the X display it corresponds to, +this procedure returns the corresponding Tk_Window handle. +If there is no Tk_Window corresponding to \fIwindow\fR then +NULL is returned. +.SH KEYWORDS +X window id diff --git a/doc/ImgChanged.3 b/doc/ImgChanged.3 index 99f24fd..7344c53 100644 --- a/doc/ImgChanged.3 +++ b/doc/ImgChanged.3 @@ -1,66 +1,66 @@ -'\" -'\" Copyright (c) 1994 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: ImgChanged.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_ImageChanged \- notify widgets that image needs to be redrawn -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR) -.SH ARGUMENTS -.AS Tk_ImageMaster imageHeight -.AP Tk_ImageMaster imageMaster in -Token for image, which was passed to image's \fIcreateProc\fR when -the image was created. -.AP int x in -X-coordinate of upper-left corner of region that needs redisplay (measured -from upper-left corner of image). -.AP int y in -Y-coordinate of upper-left corner of region that needs redisplay (measured -from upper-left corner of image). -.AP "int" width in -Width of region that needs to be redrawn, in pixels. -.AP "int" height in -Height of region that needs to be redrawn, in pixels. -.AP "int" imageWidth in -Current width of image, in pixels. -.AP "int" imageHeight in -Current height of image, in pixels. -.BE -.SH DESCRIPTION -.PP -An image manager calls \fBTk_ImageChanged\fR for an image -whenever anything happens that requires the image to be redrawn. -As a result of calling \fBTk_ImageChanged\fR, any widgets using -the image are notified so that they can redisplay themselves -appropriately. -The \fIimageMaster\fR argument identifies the image, and -\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR -specify a rectangular region within the image that needs to -be redrawn. -\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size. -.PP -An image manager should call \fBTk_ImageChanged\fR during -its \fIcreateProc\fR to specify the image's initial size and to -force redisplay if there are existing instances for the image. -If any of the pixel values in the image should change later on, -\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR, -\fIwidth\fR, and \fIheight\fR values that cover all the pixels -that changed. -If the size of the image should change, then \fBTk_ImageChanged\fR -must be called to indicate the new size, even if no pixels -need to be redisplayed. -.SH "SEE ALSO" -Tk_CreateImageType -.SH KEYWORDS -images, redisplay, image size changes +'\" +'\" Copyright (c) 1994 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: ImgChanged.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_ImageChanged 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_ImageChanged \- notify widgets that image needs to be redrawn +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_ImageChanged\fR(\fIimageMaster, x, y, width, height, imageWidth, imageHeight\fR) +.SH ARGUMENTS +.AS Tk_ImageMaster imageHeight +.AP Tk_ImageMaster imageMaster in +Token for image, which was passed to image's \fIcreateProc\fR when +the image was created. +.AP int x in +X-coordinate of upper-left corner of region that needs redisplay (measured +from upper-left corner of image). +.AP int y in +Y-coordinate of upper-left corner of region that needs redisplay (measured +from upper-left corner of image). +.AP "int" width in +Width of region that needs to be redrawn, in pixels. +.AP "int" height in +Height of region that needs to be redrawn, in pixels. +.AP "int" imageWidth in +Current width of image, in pixels. +.AP "int" imageHeight in +Current height of image, in pixels. +.BE +.SH DESCRIPTION +.PP +An image manager calls \fBTk_ImageChanged\fR for an image +whenever anything happens that requires the image to be redrawn. +As a result of calling \fBTk_ImageChanged\fR, any widgets using +the image are notified so that they can redisplay themselves +appropriately. +The \fIimageMaster\fR argument identifies the image, and +\fIx\fR, \fIy\fR, \fIwidth\fR, and \fIheight\fR +specify a rectangular region within the image that needs to +be redrawn. +\fIimageWidth\fR and \fIimageHeight\fR specify the image's (new) size. +.PP +An image manager should call \fBTk_ImageChanged\fR during +its \fIcreateProc\fR to specify the image's initial size and to +force redisplay if there are existing instances for the image. +If any of the pixel values in the image should change later on, +\fBTk_ImageChanged\fR should be called again with \fIx\fR, \fIy\fR, +\fIwidth\fR, and \fIheight\fR values that cover all the pixels +that changed. +If the size of the image should change, then \fBTk_ImageChanged\fR +must be called to indicate the new size, even if no pixels +need to be redisplayed. +.SH "SEE ALSO" +Tk_CreateImageType +.SH KEYWORDS +images, redisplay, image size changes diff --git a/doc/MainLoop.3 b/doc/MainLoop.3 index 0b7f39d..d3129e0 100644 --- a/doc/MainLoop.3 +++ b/doc/MainLoop.3 @@ -1,30 +1,30 @@ -'\" -'\" Copyright (c) 1990-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: MainLoop.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_MainLoop 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_MainLoop \- loop for events until all windows are deleted -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_MainLoop\fR() -.BE -.SH DESCRIPTION -.PP -\fBTk_MainLoop\fR is a procedure that loops repeatedly calling -\fBTcl_DoOneEvent\fR. It returns only when there are no applications -left in this process (i.e. no main windows exist anymore). Most -windowing applications will call \fBTk_MainLoop\fR after -initialization; the main execution of the application will consist -entirely of callbacks invoked via \fBTcl_DoOneEvent\fR. -.SH KEYWORDS -application, event, main loop +'\" +'\" Copyright (c) 1990-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: MainLoop.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_MainLoop 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_MainLoop \- loop for events until all windows are deleted +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_MainLoop\fR() +.BE +.SH DESCRIPTION +.PP +\fBTk_MainLoop\fR is a procedure that loops repeatedly calling +\fBTcl_DoOneEvent\fR. It returns only when there are no applications +left in this process (i.e. no main windows exist anymore). Most +windowing applications will call \fBTk_MainLoop\fR after +initialization; the main execution of the application will consist +entirely of callbacks invoked via \fBTcl_DoOneEvent\fR. +.SH KEYWORDS +application, event, main loop diff --git a/doc/MainWin.3 b/doc/MainWin.3 index 93f0190..c80f6b5 100644 --- a/doc/MainWin.3 +++ b/doc/MainWin.3 @@ -1,43 +1,43 @@ -'\" -'\" Copyright (c) 1990 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: MainWin.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main -window information -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -Tk_Window -\fBTk_MainWindow\fR(\fIinterp\fR) -.sp -int -\fBTk_GetNumMainWindows\fR() -.SH ARGUMENTS -.AS Tcl_Interp *pathName -.AP Tcl_Interp *interp in/out -Interpreter associated with the application. -.BE -.SH DESCRIPTION -.PP -A main window is a special kind of toplevel window used as the -outermost window in an application. -.PP -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. -.PP -\fBTk_GetNumMainWindows\fR returns a count of the number of main -windows currently open in the process. -.SH KEYWORDS -application, main window +'\" +'\" Copyright (c) 1990 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: MainWin.3,v 1.5 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_MainWindow 3 7.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_MainWindow, Tk_GetNumMainWindows \- functions for querying main +window information +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +Tk_Window +\fBTk_MainWindow\fR(\fIinterp\fR) +.sp +int +\fBTk_GetNumMainWindows\fR() +.SH ARGUMENTS +.AS Tcl_Interp *pathName +.AP Tcl_Interp *interp in/out +Interpreter associated with the application. +.BE +.SH DESCRIPTION +.PP +A main window is a special kind of toplevel window used as the +outermost window in an application. +.PP +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. +.PP +\fBTk_GetNumMainWindows\fR returns a count of the number of main +windows currently open in the process. +.SH KEYWORDS +application, main window diff --git a/doc/OwnSelect.3 b/doc/OwnSelect.3 index 98d9fb5..83b5b25 100644 --- a/doc/OwnSelect.3 +++ b/doc/OwnSelect.3 @@ -1,51 +1,51 @@ -'\" -'\" Copyright (c) 1990-1994 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: OwnSelect.3,v 1.3 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_OwnSelection \- make a window the owner of the primary selection -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR) -.SH ARGUMENTS -.AS Tk_LostSelProc clientData -.AP Tk_Window tkwin in -Window that is to become new selection owner. -.AP Atom selection in -The name of the selection to be owned, such as XA_PRIMARY. -.AP Tk_LostSelProc *proc in -Procedure to invoke when \fItkwin\fR loses selection ownership later. -.AP ClientData clientData in -Arbitrary one-word value to pass to \fIproc\fR. -.BE -.SH DESCRIPTION -.PP -\fBTk_OwnSelection\fR arranges for \fItkwin\fR to become the -new owner of the selection specified by the atom -\fIselection\fR. After this call completes, future requests -for the selection will be directed to handlers created for -\fItkwin\fR using \fBTk_CreateSelHandler\fR. When \fItkwin\fR -eventually loses the selection ownership, \fIproc\fR will be -invoked so that the window can clean itself up (e.g. by -unhighlighting the selection). \fIProc\fR should have arguments and -result that match the type \fBTk_LostSelProc\fR: -.CS -typedef void \fBTk_LostSelProc\fR( - ClientData \fIclientData\fR); -.CE -The \fIclientData\fR parameter to \fIproc\fR is a copy of the -\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is -usually a pointer to a data structure containing application-specific -information about \fItkwin\fR. -.SH KEYWORDS -own, selection owner +'\" +'\" Copyright (c) 1990-1994 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: OwnSelect.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_OwnSelection 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_OwnSelection \- make a window the owner of the primary selection +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_OwnSelection\fR(\fItkwin, selection, proc, clientData\fR) +.SH ARGUMENTS +.AS Tk_LostSelProc clientData +.AP Tk_Window tkwin in +Window that is to become new selection owner. +.AP Atom selection in +The name of the selection to be owned, such as XA_PRIMARY. +.AP Tk_LostSelProc *proc in +Procedure to invoke when \fItkwin\fR loses selection ownership later. +.AP ClientData clientData in +Arbitrary one-word value to pass to \fIproc\fR. +.BE +.SH DESCRIPTION +.PP +\fBTk_OwnSelection\fR arranges for \fItkwin\fR to become the +new owner of the selection specified by the atom +\fIselection\fR. After this call completes, future requests +for the selection will be directed to handlers created for +\fItkwin\fR using \fBTk_CreateSelHandler\fR. When \fItkwin\fR +eventually loses the selection ownership, \fIproc\fR will be +invoked so that the window can clean itself up (e.g. by +unhighlighting the selection). \fIProc\fR should have arguments and +result that match the type \fBTk_LostSelProc\fR: +.CS +typedef void \fBTk_LostSelProc\fR( + ClientData \fIclientData\fR); +.CE +The \fIclientData\fR parameter to \fIproc\fR is a copy of the +\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is +usually a pointer to a data structure containing application-specific +information about \fItkwin\fR. +.SH KEYWORDS +own, selection owner diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3 index 1117b86..0f82210 100644 --- a/doc/QWinEvent.3 +++ b/doc/QWinEvent.3 @@ -1,51 +1,51 @@ -'\" -'\" Copyright (c) 1995-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: QWinEvent.3,v 1.4 2008/06/30 22:57:01 dkf Exp $ -'\" -.so man.macros -.TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_CollapseMotionEvents, Tk_QueueWindowEvent \- Add a window event to the Tcl event queue -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -int -\fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR) -.sp -\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR) -.SH ARGUMENTS -.AS Tcl_QueuePosition position -.AP Display *display in -Display for which to control motion event collapsing. -.AP int collapse in -Indicates whether motion events should be collapsed or not. -.AP XEvent *eventPtr in -An event to add to the event queue. -.AP Tcl_QueuePosition position in -Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR, -\fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR. -.BE -.SH DESCRIPTION -.PP -\fBTk_QueueWindowEvent\fR places a window event on Tcl's internal event -queue for eventual servicing. It creates a Tcl_Event structure, copies the -event into that structure, and calls \fBTcl_QueueEvent\fR to add the event -to the queue. When the event is eventually removed from the queue it is -processed just like all window events. -.PP -When multiple motion events are received for the same window in rapid -succession, they are collapsed by default. This behavior can be controlled -with \fBTk_CollapseMotionEvents\fR. \fBTk_CollapseMotionEvents\fR always -returns the previous value for collapse behavior on the \fIdisplay\fR. -.PP -The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has -the same significance as for \fBTcl_QueueEvent\fR; see the -documentation for \fBTcl_QueueEvent\fR for details. -.SH KEYWORDS -callback, clock, handler, modal timeout, events +'\" +'\" Copyright (c) 1995-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: QWinEvent.3,v 1.5 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_CollapseMotionEvents, Tk_QueueWindowEvent \- Add a window event to the Tcl event queue +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +int +\fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR) +.sp +\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR) +.SH ARGUMENTS +.AS Tcl_QueuePosition position +.AP Display *display in +Display for which to control motion event collapsing. +.AP int collapse in +Indicates whether motion events should be collapsed or not. +.AP XEvent *eventPtr in +An event to add to the event queue. +.AP Tcl_QueuePosition position in +Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR, +\fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR. +.BE +.SH DESCRIPTION +.PP +\fBTk_QueueWindowEvent\fR places a window event on Tcl's internal event +queue for eventual servicing. It creates a Tcl_Event structure, copies the +event into that structure, and calls \fBTcl_QueueEvent\fR to add the event +to the queue. When the event is eventually removed from the queue it is +processed just like all window events. +.PP +When multiple motion events are received for the same window in rapid +succession, they are collapsed by default. This behavior can be controlled +with \fBTk_CollapseMotionEvents\fR. \fBTk_CollapseMotionEvents\fR always +returns the previous value for collapse behavior on the \fIdisplay\fR. +.PP +The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has +the same significance as for \fBTcl_QueueEvent\fR; see the +documentation for \fBTcl_QueueEvent\fR for details. +.SH KEYWORDS +callback, clock, handler, modal timeout, events diff --git a/doc/Restack.3 b/doc/Restack.3 index a0a6350..cda9284 100644 --- a/doc/Restack.3 +++ b/doc/Restack.3 @@ -1,47 +1,47 @@ -'\" -'\" Copyright (c) 1990 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: Restack.3,v 1.3 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH Tk_RestackWindow 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_RestackWindow \- Change a window's position in the stacking order -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -int -\fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR) -.SH ARGUMENTS -.AS Tk_Window aboveBelow -.AP Tk_Window tkwin in -Token for window to restack. -.AP int aboveBelow in -Indicates new position of \fItkwin\fR relative to \fIother\fR; -must be \fBAbove\fR or \fBBelow\fR. -.AP Tk_Window other in -\fITkwin\fR will be repositioned just above or below this window. -Must be a sibling of \fItkwin\fR or a descendant of a sibling. -If NULL then \fItkwin\fR is restacked above or below all siblings. -.BE -.SH DESCRIPTION -.PP -\fBTk_RestackWindow\fR changes the stacking order of \fIwindow\fR relative -to its siblings. -If \fIother\fR is specified as NULL then \fIwindow\fR is repositioned -at the top or bottom of its stacking order, depending on whether -\fIaboveBelow\fR is \fBAbove\fR or \fBBelow\fR. -If \fIother\fR has a non-NULL value then \fIwindow\fR is repositioned -just above or below \fIother\fR. -.PP -The \fIaboveBelow\fR argument must have one of the symbolic values -\fBAbove\fR or \fBBelow\fR. -Both of these values are defined by the include file . -.SH KEYWORDS -above, below, obscure, stacking order +'\" +'\" Copyright (c) 1990 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: Restack.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_RestackWindow 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_RestackWindow \- Change a window's position in the stacking order +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +int +\fBTk_RestackWindow\fR(\fItkwin, aboveBelow, other\fR) +.SH ARGUMENTS +.AS Tk_Window aboveBelow +.AP Tk_Window tkwin in +Token for window to restack. +.AP int aboveBelow in +Indicates new position of \fItkwin\fR relative to \fIother\fR; +must be \fBAbove\fR or \fBBelow\fR. +.AP Tk_Window other in +\fITkwin\fR will be repositioned just above or below this window. +Must be a sibling of \fItkwin\fR or a descendant of a sibling. +If NULL then \fItkwin\fR is restacked above or below all siblings. +.BE +.SH DESCRIPTION +.PP +\fBTk_RestackWindow\fR changes the stacking order of \fIwindow\fR relative +to its siblings. +If \fIother\fR is specified as NULL then \fIwindow\fR is repositioned +at the top or bottom of its stacking order, depending on whether +\fIaboveBelow\fR is \fBAbove\fR or \fBBelow\fR. +If \fIother\fR has a non-NULL value then \fIwindow\fR is repositioned +just above or below \fIother\fR. +.PP +The \fIaboveBelow\fR argument must have one of the symbolic values +\fBAbove\fR or \fBBelow\fR. +Both of these values are defined by the include file . +.SH KEYWORDS +above, below, obscure, stacking order diff --git a/doc/SetCaret.3 b/doc/SetCaret.3 index 298387b..e01c89d 100644 --- a/doc/SetCaret.3 +++ b/doc/SetCaret.3 @@ -1,38 +1,38 @@ -'\" -'\" Copyright (c) 2002 ActiveState Corporation. -'\" -'\" See the file "license.terms" for information on usage and redistribution -'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: SetCaret.3,v 1.2 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_SetCaretPos \- set the display caret location -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -int -\fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR) -.SH ARGUMENTS -.AP Tk_Window tkwin in -Token for window. -.AP int x in -Window-relative x coordinate. -.AP int y in -Window-relative y coordinate. -.AP int h in -Height of the caret in the window. -.BE -.SH DESCRIPTION -.PP -\fBTk_SetCaretPos\fR sets the caret location for the display of the -specified Tk_Window \fItkwin\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. -.SH KEYWORDS -caret, cursor +'\" +'\" Copyright (c) 2002 ActiveState Corporation. +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" RCS: @(#) $Id: SetCaret.3,v 1.3 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_SetCaretPos 3 8.4 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_SetCaretPos \- set the display caret location +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +int +\fBTk_SetCaretPos\fR(\fItkwin, x, y, height\fR) +.SH ARGUMENTS +.AP Tk_Window tkwin in +Token for window. +.AP int x in +Window-relative x coordinate. +.AP int y in +Window-relative y coordinate. +.AP int h in +Height of the caret in the window. +.BE +.SH DESCRIPTION +.PP +\fBTk_SetCaretPos\fR sets the caret location for the display of the +specified Tk_Window \fItkwin\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. +.SH KEYWORDS +caret, cursor diff --git a/doc/SetClass.3 b/doc/SetClass.3 index ad3d4ce..2fb095f 100644 --- a/doc/SetClass.3 +++ b/doc/SetClass.3 @@ -1,59 +1,59 @@ -'\" -'\" Copyright (c) 1990 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: SetClass.3,v 1.3 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH Tk_SetClass 3 "" Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_SetClass, Tk_Class \- set or retrieve a window's class -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_SetClass\fR(\fItkwin, class\fR) -.sp -Tk_Uid -\fBTk_Class\fR(\fItkwin\fR) -.SH ARGUMENTS -.AS Tk_Window parent -.AP Tk_Window tkwin in -Token for window. -.AP char *class in -New class name for window. -.BE -.SH DESCRIPTION -.PP -\fBTk_SetClass\fR is called to associate a class with a particular -window. The \fIclass\fR string identifies the type of the -window; all windows with the same general class of behavior -(button, menu, etc.) should have the same class. By -convention all class names start with a capital letter, and -there exists a Tcl command with the same name as -each class (except all in lower-case) which can be used to -create and manipulate windows of that class. -A window's class string is initialized to NULL -when the window is created. -.PP -For main windows, Tk automatically propagates the name and class -to the WM_CLASS property used by window managers. This happens -either when a main window is actually created (e.g. in -\fBTk_MakeWindowExist\fR), or when \fBTk_SetClass\fR -is called, whichever occurs later. If a main window has not been -assigned a class then Tk will not set the WM_CLASS property for -the window. -.PP -\fBTk_Class\fR is a macro that returns the -current value of \fItkwin\fR's class. The value is returned -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). -If \fItkwin\fR has not yet been given a class, then -\fBTk_Class\fR will return NULL. -.SH KEYWORDS -class, unique identifier, window, window manager +'\" +'\" Copyright (c) 1990 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: SetClass.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_SetClass 3 "" Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_SetClass, Tk_Class \- set or retrieve a window's class +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_SetClass\fR(\fItkwin, class\fR) +.sp +Tk_Uid +\fBTk_Class\fR(\fItkwin\fR) +.SH ARGUMENTS +.AS Tk_Window parent +.AP Tk_Window tkwin in +Token for window. +.AP char *class in +New class name for window. +.BE +.SH DESCRIPTION +.PP +\fBTk_SetClass\fR is called to associate a class with a particular +window. The \fIclass\fR string identifies the type of the +window; all windows with the same general class of behavior +(button, menu, etc.) should have the same class. By +convention all class names start with a capital letter, and +there exists a Tcl command with the same name as +each class (except all in lower-case) which can be used to +create and manipulate windows of that class. +A window's class string is initialized to NULL +when the window is created. +.PP +For main windows, Tk automatically propagates the name and class +to the WM_CLASS property used by window managers. This happens +either when a main window is actually created (e.g. in +\fBTk_MakeWindowExist\fR), or when \fBTk_SetClass\fR +is called, whichever occurs later. If a main window has not been +assigned a class then Tk will not set the WM_CLASS property for +the window. +.PP +\fBTk_Class\fR is a macro that returns the +current value of \fItkwin\fR's class. The value is returned +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). +If \fItkwin\fR has not yet been given a class, then +\fBTk_Class\fR will return NULL. +.SH KEYWORDS +class, unique identifier, window, window manager diff --git a/doc/SetClassProcs.3 b/doc/SetClassProcs.3 index 85a98d8..70709aa 100644 --- a/doc/SetClassProcs.3 +++ b/doc/SetClassProcs.3 @@ -1,89 +1,89 @@ -'\" -'\" 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: SetClassProcs.3,v 1.4 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH Tk_SetClassProcs 3 8.4 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_SetClassProcs \- register widget specific procedures -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR) -.SH ARGUMENTS -.AS Tk_ClassProc instanceData -.AP Tk_Window tkwin in -Token for window to modify. -.AP Tk_ClassProcs *procs in -Pointer to data structure containing widget specific procedures. -The data structure pointed to by \fIprocs\fR must be static: -Tk keeps a reference to it as long as the window exists. -.AP ClientData instanceData in -Arbitrary one-word value to pass to widget callbacks. -.BE -.SH DESCRIPTION -.PP -\fBTk_SetClassProcs\fR is called to register a set of procedures that -are used as callbacks in different places. -.PP -The structure pointed to by \fIprocs\fR contains the following: -.CS -typedef struct Tk_ClassProcs { - unsigned int \fIsize\fR; - Tk_ClassWorldChangedProc *\fIworldChangedProc\fR; - Tk_ClassCreateProc *\fIcreateProc\fR; - Tk_ClassModalProc *\fImodalProc\fR; -} \fBTk_ClassProcs\fR; -.CE -The \fIsize\fR field is used to simplify future expansion of the -structure. It should always be set to (literally) \fBsizeof(Tk_ClassProcs)\fR. -.PP -\fIworldChangedProc\fR is invoked when the system has altered -in some way that requires some reaction from the widget. For example, -when a font alias (see the \fBfont\fR manual entry) is reconfigured, -widgets configured to use that font alias must update their display -accordingly. \fIworldChangedProc\fR should have arguments and results -that match the type \fBTk_ClassWorldChangedProc\fR: -.CS -typedef void \fBTk_ClassWorldChangedProc\fR( - ClientData \fIinstanceData\fR); -.CE -The \fIinstanceData\fR parameter passed to the \fIworldChangedProc\fR -will be identical to the \fIinstanceData\fR parameter passed to -\fBTk_SetClassProcs\fR. -.PP -\fIcreateProc\fR is used to create platform-dependant windows. It is -invoked by \fBTk_MakeWindowExist\fR. \fIcreateProc\fR should have -arguments and results that match the type \fBTk_ClassCreateProc\fR: -.CS -typedef Window \fBTk_ClassCreateProc\fR( - Tk_Window \fItkwin\fR, - Window \fIparent\fR, - ClientData \fIinstanceData\fR); -.CE -The \fItkwin\fR and \fIinstanceData\fR parameters will be identical to -the \fItkwin\fR and \fIinstanceData\fR parameters passed to -\fBTk_SetClassProcs\fR. The \fIparent\fR parameter will be the parent -of the window to be created. The \fIcreateProc\fR should return the -created window. -.PP -\fImodalProc\fR is invoked after all bindings on a widget have been -triggered in order to handle a modal loop. \fImodalProc\fR should -have arguments and results that match the type \fBTk_ClassModalProc\fR: -.CS -typedef void \fBTk_ClassModalProc\fR( - Tk_Window \fItkwin\fR, - XEvent *\fIeventPtr\fR); -.CE -The \fItkwin\fR parameter to \fImodalProc\fR will be identical to the -\fItkwin\fR parameter passed to \fBTk_SetClassProcs\fR. The -\fIeventPtr\fR parameter will be a pointer to an XEvent structure -describing the event being processed. -.SH KEYWORDS -callback, class +'\" +'\" 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: SetClassProcs.3,v 1.5 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_SetClassProcs 3 8.4 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_SetClassProcs \- register widget specific procedures +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_SetClassProcs\fR(\fItkwin, procs, instanceData\fR) +.SH ARGUMENTS +.AS Tk_ClassProc instanceData +.AP Tk_Window tkwin in +Token for window to modify. +.AP Tk_ClassProcs *procs in +Pointer to data structure containing widget specific procedures. +The data structure pointed to by \fIprocs\fR must be static: +Tk keeps a reference to it as long as the window exists. +.AP ClientData instanceData in +Arbitrary one-word value to pass to widget callbacks. +.BE +.SH DESCRIPTION +.PP +\fBTk_SetClassProcs\fR is called to register a set of procedures that +are used as callbacks in different places. +.PP +The structure pointed to by \fIprocs\fR contains the following: +.CS +typedef struct Tk_ClassProcs { + unsigned int \fIsize\fR; + Tk_ClassWorldChangedProc *\fIworldChangedProc\fR; + Tk_ClassCreateProc *\fIcreateProc\fR; + Tk_ClassModalProc *\fImodalProc\fR; +} \fBTk_ClassProcs\fR; +.CE +The \fIsize\fR field is used to simplify future expansion of the +structure. It should always be set to (literally) \fBsizeof(Tk_ClassProcs)\fR. +.PP +\fIworldChangedProc\fR is invoked when the system has altered +in some way that requires some reaction from the widget. For example, +when a font alias (see the \fBfont\fR manual entry) is reconfigured, +widgets configured to use that font alias must update their display +accordingly. \fIworldChangedProc\fR should have arguments and results +that match the type \fBTk_ClassWorldChangedProc\fR: +.CS +typedef void \fBTk_ClassWorldChangedProc\fR( + ClientData \fIinstanceData\fR); +.CE +The \fIinstanceData\fR parameter passed to the \fIworldChangedProc\fR +will be identical to the \fIinstanceData\fR parameter passed to +\fBTk_SetClassProcs\fR. +.PP +\fIcreateProc\fR is used to create platform-dependant windows. It is +invoked by \fBTk_MakeWindowExist\fR. \fIcreateProc\fR should have +arguments and results that match the type \fBTk_ClassCreateProc\fR: +.CS +typedef Window \fBTk_ClassCreateProc\fR( + Tk_Window \fItkwin\fR, + Window \fIparent\fR, + ClientData \fIinstanceData\fR); +.CE +The \fItkwin\fR and \fIinstanceData\fR parameters will be identical to +the \fItkwin\fR and \fIinstanceData\fR parameters passed to +\fBTk_SetClassProcs\fR. The \fIparent\fR parameter will be the parent +of the window to be created. The \fIcreateProc\fR should return the +created window. +.PP +\fImodalProc\fR is invoked after all bindings on a widget have been +triggered in order to handle a modal loop. \fImodalProc\fR should +have arguments and results that match the type \fBTk_ClassModalProc\fR: +.CS +typedef void \fBTk_ClassModalProc\fR( + Tk_Window \fItkwin\fR, + XEvent *\fIeventPtr\fR); +.CE +The \fItkwin\fR parameter to \fImodalProc\fR will be identical to the +\fItkwin\fR parameter passed to \fBTk_SetClassProcs\fR. The +\fIeventPtr\fR parameter will be a pointer to an XEvent structure +describing the event being processed. +.SH KEYWORDS +callback, class diff --git a/doc/SetGrid.3 b/doc/SetGrid.3 index ee8a231..57efb97 100644 --- a/doc/SetGrid.3 +++ b/doc/SetGrid.3 @@ -1,65 +1,65 @@ -'\" -'\" Copyright (c) 1990-1994 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: SetGrid.3,v 1.3 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures" -.BS -.SH NAME -Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing -.SH SYNOPSIS -.nf -\fB#include \fR -.sp -\fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR) -.sp -\fBTk_UnsetGrid\fR(\fItkwin\fR) -.SH ARGUMENTS -.AS Tk_Window heightInc -.AP Tk_Window tkwin in -Token for window. -.AP int reqWidth in -Width in grid units that corresponds to the pixel dimension \fItkwin\fR -has requested via \fBTk_GeometryRequest\fR. -.AP int reqHeight in -Height in grid units that corresponds to the pixel dimension \fItkwin\fR -has requested via \fBTk_GeometryRequest\fR. -.AP int widthInc in -Width of one grid unit, in pixels. -.AP int heightInc in -Height of one grid unit, in pixels. -.BE -.SH DESCRIPTION -.PP -\fBTk_SetGrid\fR turns on gridded geometry management for \fItkwin\fR's -toplevel window and specifies the geometry of the grid. -\fBTk_SetGrid\fR is typically invoked by a widget when its \fBsetGrid\fR -option is true. -It restricts interactive resizing of \fItkwin\fR's toplevel window so -that the space allocated to the toplevel is equal to its requested -size plus or minus even multiples of \fIwidthInc\fR and \fIheightInc\fR. -Furthermore, the \fIreqWidth\fR and \fIreqHeight\fR values are -passed to the window manager so that it can report the window's -size in grid units during interactive resizes. -If \fItkwin\fR's configuration changes (e.g., the size of a grid unit -changes) then the widget should invoke \fBTk_SetGrid\fR again with the new -information. -.PP -\fBTk_UnsetGrid\fR cancels gridded geometry management for -\fItkwin\fR's toplevel window. -.PP -For each toplevel window there can be at most one internal window -with gridding enabled. -If \fBTk_SetGrid\fR or \fBTk_UnsetGrid\fR is invoked when some -other window is already controlling gridding for \fItkwin\fR's -toplevel, the calls for the new window have no effect. -.PP -See the \fBwm\fR manual entry for additional information on gridded geometry -management. -.SH KEYWORDS -grid, window, window manager +'\" +'\" Copyright (c) 1990-1994 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: SetGrid.3,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH Tk_SetGrid 3 4.0 Tk "Tk Library Procedures" +.BS +.SH NAME +Tk_SetGrid, Tk_UnsetGrid \- control the grid for interactive resizing +.SH SYNOPSIS +.nf +\fB#include \fR +.sp +\fBTk_SetGrid\fR(\fItkwin, reqWidth, reqHeight, widthInc, heightInc\fR) +.sp +\fBTk_UnsetGrid\fR(\fItkwin\fR) +.SH ARGUMENTS +.AS Tk_Window heightInc +.AP Tk_Window tkwin in +Token for window. +.AP int reqWidth in +Width in grid units that corresponds to the pixel dimension \fItkwin\fR +has requested via \fBTk_GeometryRequest\fR. +.AP int reqHeight in +Height in grid units that corresponds to the pixel dimension \fItkwin\fR +has requested via \fBTk_GeometryRequest\fR. +.AP int widthInc in +Width of one grid unit, in pixels. +.AP int heightInc in +Height of one grid unit, in pixels. +.BE +.SH DESCRIPTION +.PP +\fBTk_SetGrid\fR turns on gridded geometry management for \fItkwin\fR's +toplevel window and specifies the geometry of the grid. +\fBTk_SetGrid\fR is typically invoked by a widget when its \fBsetGrid\fR +option is true. +It restricts interactive resizing of \fItkwin\fR's toplevel window so +that the space allocated to the toplevel is equal to its requested +size plus or minus even multiples of \fIwidthInc\fR and \fIheightInc\fR. +Furthermore, the \fIreqWidth\fR and \fIreqHeight\fR values are +passed to the window manager so that it can report the window's +size in grid units during interactive resizes. +If \fItkwin\fR's configuration changes (e.g., the size of a grid unit +changes) then the widget should invoke \fBTk_SetGrid\fR again with the new +information. +.PP +\fBTk_UnsetGrid\fR cancels gridded geometry management for +\fItkwin\fR's toplevel window. +.PP +For each toplevel window there can be at most one internal window +with gridding enabled. +If \fBTk_SetGrid\fR or \fBTk_UnsetGrid\fR is invoked when some +other window is already controlling gridding for \fItkwin\fR's +toplevel, the calls for the new window have no effect. +.PP +See the \fBwm\fR manual entry for additional information on gridded geometry +management. +.SH KEYWORDS +grid, window, window manager diff --git a/doc/bell.n b/doc/bell.n index a7eaa9f..b2cd708 100644 --- a/doc/bell.n +++ b/doc/bell.n @@ -1,34 +1,34 @@ -'\" -*- nroff -*- -'\" -'\" 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: bell.n,v 1.5 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH bell n 8.4 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -bell \- Ring a display's bell -.SH SYNOPSIS -\fBbell \fR?\fB\-displayof \fIwindow\fR? ?\fB\-nice\fR? -.BE -.SH DESCRIPTION -.PP -This command rings the bell on the display for \fIwindow\fR and -returns an empty string. -If the \fB\-displayof\fR option is omitted, the display of the -application's main window is used by default. -The command uses the current bell-related settings for the display, which -may be modified with programs such as \fBxset\fR. -.PP -If \fB\-nice\fR is not specified, this command also resets the screen saver -for the screen. Some screen savers will ignore this, but others will reset -so that the screen becomes visible again. -.SH KEYWORDS -beep, bell, ring +'\" -*- nroff -*- +'\" +'\" 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: bell.n,v 1.6 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH bell n 8.4 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +bell \- Ring a display's bell +.SH SYNOPSIS +\fBbell \fR?\fB\-displayof \fIwindow\fR? ?\fB\-nice\fR? +.BE +.SH DESCRIPTION +.PP +This command rings the bell on the display for \fIwindow\fR and +returns an empty string. +If the \fB\-displayof\fR option is omitted, the display of the +application's main window is used by default. +The command uses the current bell-related settings for the display, which +may be modified with programs such as \fBxset\fR. +.PP +If \fB\-nice\fR is not specified, this command also resets the screen saver +for the screen. Some screen savers will ignore this, but others will reset +so that the screen becomes visible again. +.SH KEYWORDS +beep, bell, ring diff --git a/doc/bitmap.n b/doc/bitmap.n index 065d0ad..dcb26e6 100644 --- a/doc/bitmap.n +++ b/doc/bitmap.n @@ -1,111 +1,111 @@ -'\" -*- nroff -*- -'\" -'\" Copyright (c) 1994 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: bitmap.n,v 1.3 2008/06/30 22:57:02 dkf Exp $ -'\" -.so man.macros -.TH bitmap n 4.0 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -bitmap \- Images that display two colors -.SH SYNOPSIS -\fBimage create bitmap \fR?\fIname\fR? ?\fIoptions\fR? -.BE -.SH DESCRIPTION -.PP -A bitmap is an image whose pixels can display either of two colors -or be transparent. -A bitmap image is defined by four things: a background color, -a foreground color, and two bitmaps, called the \fIsource\fR -and the \fImask\fR. -Each of the bitmaps specifies 0/1 values for a rectangular -array of pixels, and the two bitmaps must have the same -dimensions. -For pixels where the mask is zero, the image displays nothing, -producing a transparent effect. -For other pixels, the image displays the foreground color if -the source data is one and the background color if the source -data is zero. -.SH "CREATING BITMAPS" -.PP -Like all images, bitmaps are created using the \fBimage create\fR -command. -Bitmaps support the following \fIoptions\fR: -.TP -\fB\-background \fIcolor\fR -Specifies a background color for the image in any of the standard -ways accepted by Tk. If this option is set to an empty string -then the background pixels will be transparent. This effect -is achieved by using the source bitmap as the mask bitmap, ignoring -any \fB\-maskdata\fR or \fB\-maskfile\fR options. -.TP -\fB\-data \fIstring\fR -Specifies the contents of the source bitmap as a string. -The string must adhere to X11 bitmap format (e.g., as generated -by the \fBbitmap\fR program). -If both the \fB\-data\fR and \fB\-file\fR options are specified, -the \fB\-data\fR option takes precedence. -.TP -\fB\-file \fIname\fR -\fIname\fR gives the name of a file whose contents define the -source bitmap. -The file must adhere to X11 bitmap format (e.g., as generated -by the \fBbitmap\fR program). -.TP -\fB\-foreground \fIcolor\fR -Specifies a foreground color for the image in any of the standard -ways accepted by Tk. -.TP -\fB\-maskdata \fIstring\fR -Specifies the contents of the mask as a string. -The string must adhere to X11 bitmap format (e.g., as generated -by the \fBbitmap\fR program). -If both the \fB\-maskdata\fR and \fB\-maskfile\fR options are specified, -the \fB\-maskdata\fR option takes precedence. -.TP -\fB\-maskfile \fIname\fR -\fIname\fR gives the name of a file whose contents define the -mask. -The file must adhere to X11 bitmap format (e.g., as generated -by the \fBbitmap\fR program). -.SH "IMAGE COMMAND" -.PP -When a bitmap image is created, Tk also creates a new command -whose name is the same as the image. -This command may be used to invoke various operations -on the image. -It has the following general form: -.CS -\fIimageName option \fR?\fIarg arg ...\fR? -.CE -\fIOption\fR and the \fIarg\fRs -determine the exact behavior of the command. The following -commands are possible for bitmap images: -.TP -\fIimageName \fBcget\fR \fIoption\fR -Returns the current value of the configuration option given -by \fIoption\fR. -\fIOption\fR may have any of the values accepted by the -\fBimage create bitmap\fR command. -.TP -\fIimageName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? -Query or modify the configuration options for the image. -If no \fIoption\fR is specified, returns a list describing all of -the available options for \fIimageName\fR (see \fBTk_ConfigureInfo\fR for -information on the format of this list). If \fIoption\fR is specified -with no \fIvalue\fR, then the command returns a list describing the -one named option (this list will be identical to the corresponding -sublist of the value returned if no \fIoption\fR is specified). If -one or more \fIoption\-value\fR pairs are specified, then the command -modifies the given option(s) to have the given value(s); in -this case the command returns an empty string. -\fIOption\fR may have any of the values accepted by the -\fBimage create bitmap\fR command. -.SH KEYWORDS -bitmap, image +'\" -*- nroff -*- +'\" +'\" Copyright (c) 1994 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: bitmap.n,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH bitmap n 4.0 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +bitmap \- Images that display two colors +.SH SYNOPSIS +\fBimage create bitmap \fR?\fIname\fR? ?\fIoptions\fR? +.BE +.SH DESCRIPTION +.PP +A bitmap is an image whose pixels can display either of two colors +or be transparent. +A bitmap image is defined by four things: a background color, +a foreground color, and two bitmaps, called the \fIsource\fR +and the \fImask\fR. +Each of the bitmaps specifies 0/1 values for a rectangular +array of pixels, and the two bitmaps must have the same +dimensions. +For pixels where the mask is zero, the image displays nothing, +producing a transparent effect. +For other pixels, the image displays the foreground color if +the source data is one and the background color if the source +data is zero. +.SH "CREATING BITMAPS" +.PP +Like all images, bitmaps are created using the \fBimage create\fR +command. +Bitmaps support the following \fIoptions\fR: +.TP +\fB\-background \fIcolor\fR +Specifies a background color for the image in any of the standard +ways accepted by Tk. If this option is set to an empty string +then the background pixels will be transparent. This effect +is achieved by using the source bitmap as the mask bitmap, ignoring +any \fB\-maskdata\fR or \fB\-maskfile\fR options. +.TP +\fB\-data \fIstring\fR +Specifies the contents of the source bitmap as a string. +The string must adhere to X11 bitmap format (e.g., as generated +by the \fBbitmap\fR program). +If both the \fB\-data\fR and \fB\-file\fR options are specified, +the \fB\-data\fR option takes precedence. +.TP +\fB\-file \fIname\fR +\fIname\fR gives the name of a file whose contents define the +source bitmap. +The file must adhere to X11 bitmap format (e.g., as generated +by the \fBbitmap\fR program). +.TP +\fB\-foreground \fIcolor\fR +Specifies a foreground color for the image in any of the standard +ways accepted by Tk. +.TP +\fB\-maskdata \fIstring\fR +Specifies the contents of the mask as a string. +The string must adhere to X11 bitmap format (e.g., as generated +by the \fBbitmap\fR program). +If both the \fB\-maskdata\fR and \fB\-maskfile\fR options are specified, +the \fB\-maskdata\fR option takes precedence. +.TP +\fB\-maskfile \fIname\fR +\fIname\fR gives the name of a file whose contents define the +mask. +The file must adhere to X11 bitmap format (e.g., as generated +by the \fBbitmap\fR program). +.SH "IMAGE COMMAND" +.PP +When a bitmap image is created, Tk also creates a new command +whose name is the same as the image. +This command may be used to invoke various operations +on the image. +It has the following general form: +.CS +\fIimageName option \fR?\fIarg arg ...\fR? +.CE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for bitmap images: +.TP +\fIimageName \fBcget\fR \fIoption\fR +Returns the current value of the configuration option given +by \fIoption\fR. +\fIOption\fR may have any of the values accepted by the +\fBimage create bitmap\fR command. +.TP +\fIimageName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +Query or modify the configuration options for the image. +If no \fIoption\fR is specified, returns a list describing all of +the available options for \fIimageName\fR (see \fBTk_ConfigureInfo\fR for +information on the format of this list). If \fIoption\fR is specified +with no \fIvalue\fR, then the command returns a list describing the +one named option (this list will be identical to the corresponding +sublist of the value returned if no \fIoption\fR is specified). If +one or more \fIoption\-value\fR pairs are specified, then the command +modifies the given option(s) to have the given value(s); in +this case the command returns an empty string. +\fIOption\fR may have any of the values accepted by the +\fBimage create bitmap\fR command. +.SH KEYWORDS +bitmap, image diff --git a/doc/keysyms.n b/doc/keysyms.n index fdd2a5d..6cb530f 100644 --- a/doc/keysyms.n +++ b/doc/keysyms.n @@ -1,928 +1,928 @@ -'\" -*- nroff -*- -'\" -'\" Copyright (c) 1998-2000 by Scriptics Corporation. -'\" All rights reserved. -'\" -'\" RCS: @(#) $Id: keysyms.n,v 1.5 2008/06/30 22:57:02 dkf Exp $ -'\" -'\" -.so man.macros -.TH keysyms n 8.3 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -keysyms \- keysyms recognized by Tk -.BE -.SH DESCRIPTION -.PP -Tk recognizes many keysyms when specifying key bindings (e.g. -\fBbind . \fR). The following list enumerates the -keysyms that will be recognized by Tk. Note that not all keysyms will -be valid on all platforms. For example, on Unix systems, the presence -of a particular keysym is dependant on the configuration of the -keyboard modifier map. This list shows keysyms along with their -decimal and hexadecimal values. -.PP -.CS -space 32 0x0020 -exclam 33 0x0021 -quotedbl 34 0x0022 -numbersign 35 0x0023 -dollar 36 0x0024 -percent 37 0x0025 -ampersand 38 0x0026 -quoteright 39 0x0027 -parenleft 40 0x0028 -parenright 41 0x0029 -asterisk 42 0x002a -plus 43 0x002b -comma 44 0x002c -minus 45 0x002d -period 46 0x002e -slash 47 0x002f -0 48 0x0030 -1 49 0x0031 -2 50 0x0032 -3 51 0x0033 -4 52 0x0034 -5 53 0x0035 -6 54 0x0036 -7 55 0x0037 -8 56 0x0038 -9 57 0x0039 -colon 58 0x003a -semicolon 59 0x003b -less 60 0x003c -equal 61 0x003d -greater 62 0x003e -question 63 0x003f -at 64 0x0040 -A 65 0x0041 -B 66 0x0042 -C 67 0x0043 -D 68 0x0044 -E 69 0x0045 -F 70 0x0046 -G 71 0x0047 -H 72 0x0048 -I 73 0x0049 -J 74 0x004a -K 75 0x004b -L 76 0x004c -M 77 0x004d -N 78 0x004e -O 79 0x004f -P 80 0x0050 -Q 81 0x0051 -R 82 0x0052 -S 83 0x0053 -T 84 0x0054 -U 85 0x0055 -V 86 0x0056 -W 87 0x0057 -X 88 0x0058 -Y 89 0x0059 -Z 90 0x005a -bracketleft 91 0x005b -backslash 92 0x005c -bracketright 93 0x005d -asciicircum 94 0x005e -underscore 95 0x005f -quoteleft 96 0x0060 -a 97 0x0061 -b 98 0x0062 -c 99 0x0063 -d 100 0x0064 -e 101 0x0065 -f 102 0x0066 -g 103 0x0067 -h 104 0x0068 -i 105 0x0069 -j 106 0x006a -k 107 0x006b -l 108 0x006c -m 109 0x006d -n 110 0x006e -o 111 0x006f -p 112 0x0070 -q 113 0x0071 -r 114 0x0072 -s 115 0x0073 -t 116 0x0074 -u 117 0x0075 -v 118 0x0076 -w 119 0x0077 -x 120 0x0078 -y 121 0x0079 -z 122 0x007a -braceleft 123 0x007b -bar 124 0x007c -braceright 125 0x007d -asciitilde 126 0x007e -nobreakspace 160 0x00a0 -exclamdown 161 0x00a1 -cent 162 0x00a2 -sterling 163 0x00a3 -currency 164 0x00a4 -yen 165 0x00a5 -brokenbar 166 0x00a6 -section 167 0x00a7 -diaeresis 168 0x00a8 -copyright 169 0x00a9 -ordfeminine 170 0x00aa -guillemotleft 171 0x00ab -notsign 172 0x00ac -hyphen 173 0x00ad -registered 174 0x00ae -macron 175 0x00af -degree 176 0x00b0 -plusminus 177 0x00b1 -twosuperior 178 0x00b2 -threesuperior 179 0x00b3 -acute 180 0x00b4 -mu 181 0x00b5 -paragraph 182 0x00b6 -periodcentered 183 0x00b7 -cedilla 184 0x00b8 -onesuperior 185 0x00b9 -masculine 186 0x00ba -guillemotright 187 0x00bb -onequarter 188 0x00bc -onehalf 189 0x00bd -threequarters 190 0x00be -questiondown 191 0x00bf -Agrave 192 0x00c0 -Aacute 193 0x00c1 -Acircumflex 194 0x00c2 -Atilde 195 0x00c3 -Adiaeresis 196 0x00c4 -Aring 197 0x00c5 -AE 198 0x00c6 -Ccedilla 199 0x00c7 -Egrave 200 0x00c8 -Eacute 201 0x00c9 -Ecircumflex 202 0x00ca -Ediaeresis 203 0x00cb -Igrave 204 0x00cc -Iacute 205 0x00cd -Icircumflex 206 0x00ce -Idiaeresis 207 0x00cf -Eth 208 0x00d0 -Ntilde 209 0x00d1 -Ograve 210 0x00d2 -Oacute 211 0x00d3 -Ocircumflex 212 0x00d4 -Otilde 213 0x00d5 -Odiaeresis 214 0x00d6 -multiply 215 0x00d7 -Ooblique 216 0x00d8 -Ugrave 217 0x00d9 -Uacute 218 0x00da -Ucircumflex 219 0x00db -Udiaeresis 220 0x00dc -Yacute 221 0x00dd -Thorn 222 0x00de -ssharp 223 0x00df -agrave 224 0x00e0 -aacute 225 0x00e1 -acircumflex 226 0x00e2 -atilde 227 0x00e3 -adiaeresis 228 0x00e4 -aring 229 0x00e5 -ae 230 0x00e6 -ccedilla 231 0x00e7 -egrave 232 0x00e8 -eacute 233 0x00e9 -ecircumflex 234 0x00ea -ediaeresis 235 0x00eb -igrave 236 0x00ec -iacute 237 0x00ed -icircumflex 238 0x00ee -idiaeresis 239 0x00ef -eth 240 0x00f0 -ntilde 241 0x00f1 -ograve 242 0x00f2 -oacute 243 0x00f3 -ocircumflex 244 0x00f4 -otilde 245 0x00f5 -odiaeresis 246 0x00f6 -division 247 0x00f7 -oslash 248 0x00f8 -ugrave 249 0x00f9 -uacute 250 0x00fa -ucircumflex 251 0x00fb -udiaeresis 252 0x00fc -yacute 253 0x00fd -thorn 254 0x00fe -ydiaeresis 255 0x00ff -Aogonek 417 0x01a1 -breve 418 0x01a2 -Lstroke 419 0x01a3 -Lcaron 421 0x01a5 -Sacute 422 0x01a6 -Scaron 425 0x01a9 -Scedilla 426 0x01aa -Tcaron 427 0x01ab -Zacute 428 0x01ac -.CE -.CS -Zcaron 430 0x01ae -Zabovedot 431 0x01af -aogonek 433 0x01b1 -ogonek 434 0x01b2 -lstroke 435 0x01b3 -lcaron 437 0x01b5 -sacute 438 0x01b6 -caron 439 0x01b7 -scaron 441 0x01b9 -scedilla 442 0x01ba -tcaron 443 0x01bb -zacute 444 0x01bc -doubleacute 445 0x01bd -zcaron 446 0x01be -zabovedot 447 0x01bf -Racute 448 0x01c0 -Abreve 451 0x01c3 -Cacute 454 0x01c6 -Ccaron 456 0x01c8 -Eogonek 458 0x01ca -Ecaron 460 0x01cc -Dcaron 463 0x01cf -Nacute 465 0x01d1 -Ncaron 466 0x01d2 -Odoubleacute 469 0x01d5 -Rcaron 472 0x01d8 -Uring 473 0x01d9 -Udoubleacute 475 0x01db -Tcedilla 478 0x01de -racute 480 0x01e0 -abreve 483 0x01e3 -cacute 486 0x01e6 -ccaron 488 0x01e8 -eogonek 490 0x01ea -ecaron 492 0x01ec -dcaron 495 0x01ef -nacute 497 0x01f1 -ncaron 498 0x01f2 -odoubleacute 501 0x01f5 -rcaron 504 0x01f8 -uring 505 0x01f9 -udoubleacute 507 0x01fb -tcedilla 510 0x01fe -abovedot 511 0x01ff -Hstroke 673 0x02a1 -Hcircumflex 678 0x02a6 -Iabovedot 681 0x02a9 -Gbreve 683 0x02ab -Jcircumflex 684 0x02ac -hstroke 689 0x02b1 -hcircumflex 694 0x02b6 -idotless 697 0x02b9 -gbreve 699 0x02bb -jcircumflex 700 0x02bc -Cabovedot 709 0x02c5 -Ccircumflex 710 0x02c6 -Gabovedot 725 0x02d5 -Gcircumflex 728 0x02d8 -Ubreve 733 0x02dd -Scircumflex 734 0x02de -cabovedot 741 0x02e5 -ccircumflex 742 0x02e6 -gabovedot 757 0x02f5 -gcircumflex 760 0x02f8 -ubreve 765 0x02fd -scircumflex 766 0x02fe -kappa 930 0x03a2 -Rcedilla 931 0x03a3 -Itilde 933 0x03a5 -Lcedilla 934 0x03a6 -Emacron 938 0x03aa -Gcedilla 939 0x03ab -Tslash 940 0x03ac -rcedilla 947 0x03b3 -itilde 949 0x03b5 -lcedilla 950 0x03b6 -emacron 954 0x03ba -gacute 955 0x03bb -tslash 956 0x03bc -ENG 957 0x03bd -eng 959 0x03bf -Amacron 960 0x03c0 -Iogonek 967 0x03c7 -Eabovedot 972 0x03cc -Imacron 975 0x03cf -Ncedilla 977 0x03d1 -Omacron 978 0x03d2 -Kcedilla 979 0x03d3 -Uogonek 985 0x03d9 -Utilde 989 0x03dd -Umacron 990 0x03de -amacron 992 0x03e0 -iogonek 999 0x03e7 -eabovedot 1004 0x03ec -imacron 1007 0x03ef -ncedilla 1009 0x03f1 -omacron 1010 0x03f2 -kcedilla 1011 0x03f3 -uogonek 1017 0x03f9 -utilde 1021 0x03fd -umacron 1022 0x03fe -overline 1150 0x047e -kana_fullstop 1185 0x04a1 -kana_openingbracket 1186 0x04a2 -kana_closingbracket 1187 0x04a3 -kana_comma 1188 0x04a4 -kana_middledot 1189 0x04a5 -kana_WO 1190 0x04a6 -kana_a 1191 0x04a7 -kana_i 1192 0x04a8 -kana_u 1193 0x04a9 -kana_e 1194 0x04aa -kana_o 1195 0x04ab -kana_ya 1196 0x04ac -kana_yu 1197 0x04ad -kana_yo 1198 0x04ae -kana_tu 1199 0x04af -prolongedsound 1200 0x04b0 -kana_A 1201 0x04b1 -kana_I 1202 0x04b2 -kana_U 1203 0x04b3 -kana_E 1204 0x04b4 -kana_O 1205 0x04b5 -kana_KA 1206 0x04b6 -kana_KI 1207 0x04b7 -kana_KU 1208 0x04b8 -kana_KE 1209 0x04b9 -kana_KO 1210 0x04ba -kana_SA 1211 0x04bb -kana_SHI 1212 0x04bc -kana_SU 1213 0x04bd -kana_SE 1214 0x04be -kana_SO 1215 0x04bf -kana_TA 1216 0x04c0 -kana_TI 1217 0x04c1 -kana_TU 1218 0x04c2 -kana_TE 1219 0x04c3 -kana_TO 1220 0x04c4 -kana_NA 1221 0x04c5 -kana_NI 1222 0x04c6 -kana_NU 1223 0x04c7 -kana_NE 1224 0x04c8 -kana_NO 1225 0x04c9 -kana_HA 1226 0x04ca -kana_HI 1227 0x04cb -kana_HU 1228 0x04cc -kana_HE 1229 0x04cd -kana_HO 1230 0x04ce -kana_MA 1231 0x04cf -kana_MI 1232 0x04d0 -kana_MU 1233 0x04d1 -kana_ME 1234 0x04d2 -kana_MO 1235 0x04d3 -kana_YA 1236 0x04d4 -kana_YU 1237 0x04d5 -kana_YO 1238 0x04d6 -kana_RA 1239 0x04d7 -kana_RI 1240 0x04d8 -kana_RU 1241 0x04d9 -kana_RE 1242 0x04da -kana_RO 1243 0x04db -kana_WA 1244 0x04dc -kana_N 1245 0x04dd -voicedsound 1246 0x04de -semivoicedsound 1247 0x04df -Arabic_comma 1452 0x05ac -Arabic_semicolon 1467 0x05bb -Arabic_question_mark 1471 0x05bf -Arabic_hamza 1473 0x05c1 -Arabic_maddaonalef 1474 0x05c2 -Arabic_hamzaonalef 1475 0x05c3 -Arabic_hamzaonwaw 1476 0x05c4 -Arabic_hamzaunderalef 1477 0x05c5 -Arabic_hamzaonyeh 1478 0x05c6 -Arabic_alef 1479 0x05c7 -Arabic_beh 1480 0x05c8 -Arabic_tehmarbuta 1481 0x05c9 -Arabic_teh 1482 0x05ca -Arabic_theh 1483 0x05cb -Arabic_jeem 1484 0x05cc -Arabic_hah 1485 0x05cd -Arabic_khah 1486 0x05ce -Arabic_dal 1487 0x05cf -Arabic_thal 1488 0x05d0 -Arabic_ra 1489 0x05d1 -Arabic_zain 1490 0x05d2 -Arabic_seen 1491 0x05d3 -Arabic_sheen 1492 0x05d4 -Arabic_sad 1493 0x05d5 -Arabic_dad 1494 0x05d6 -Arabic_tah 1495 0x05d7 -Arabic_zah 1496 0x05d8 -Arabic_ain 1497 0x05d9 -Arabic_ghain 1498 0x05da -Arabic_tatweel 1504 0x05e0 -Arabic_feh 1505 0x05e1 -Arabic_qaf 1506 0x05e2 -Arabic_kaf 1507 0x05e3 -Arabic_lam 1508 0x05e4 -Arabic_meem 1509 0x05e5 -.CE -.CS -Arabic_noon 1510 0x05e6 -Arabic_heh 1511 0x05e7 -Arabic_waw 1512 0x05e8 -Arabic_alefmaksura 1513 0x05e9 -Arabic_yeh 1514 0x05ea -Arabic_fathatan 1515 0x05eb -Arabic_dammatan 1516 0x05ec -Arabic_kasratan 1517 0x05ed -Arabic_fatha 1518 0x05ee -Arabic_damma 1519 0x05ef -Arabic_kasra 1520 0x05f0 -Arabic_shadda 1521 0x05f1 -Arabic_sukun 1522 0x05f2 -Serbian_dje 1697 0x06a1 -Macedonia_gje 1698 0x06a2 -Cyrillic_io 1699 0x06a3 -Ukranian_je 1700 0x06a4 -Macedonia_dse 1701 0x06a5 -Ukranian_i 1702 0x06a6 -Ukranian_yi 1703 0x06a7 -Serbian_je 1704 0x06a8 -Serbian_lje 1705 0x06a9 -Serbian_nje 1706 0x06aa -Serbian_tshe 1707 0x06ab -Macedonia_kje 1708 0x06ac -Byelorussian_shortu 1710 0x06ae -Serbian_dze 1711 0x06af -numerosign 1712 0x06b0 -Serbian_DJE 1713 0x06b1 -Macedonia_GJE 1714 0x06b2 -Cyrillic_IO 1715 0x06b3 -Ukranian_JE 1716 0x06b4 -Macedonia_DSE 1717 0x06b5 -Ukranian_I 1718 0x06b6 -Ukranian_YI 1719 0x06b7 -Serbian_JE 1720 0x06b8 -Serbian_LJE 1721 0x06b9 -Serbian_NJE 1722 0x06ba -Serbian_TSHE 1723 0x06bb -Macedonia_KJE 1724 0x06bc -Byelorussian_SHORTU 1726 0x06be -Serbian_DZE 1727 0x06bf -Cyrillic_yu 1728 0x06c0 -Cyrillic_a 1729 0x06c1 -Cyrillic_be 1730 0x06c2 -Cyrillic_tse 1731 0x06c3 -Cyrillic_de 1732 0x06c4 -Cyrillic_ie 1733 0x06c5 -Cyrillic_ef 1734 0x06c6 -Cyrillic_ghe 1735 0x06c7 -Cyrillic_ha 1736 0x06c8 -Cyrillic_i 1737 0x06c9 -Cyrillic_shorti 1738 0x06ca -Cyrillic_ka 1739 0x06cb -Cyrillic_el 1740 0x06cc -Cyrillic_em 1741 0x06cd -Cyrillic_en 1742 0x06ce -Cyrillic_o 1743 0x06cf -Cyrillic_pe 1744 0x06d0 -Cyrillic_ya 1745 0x06d1 -Cyrillic_er 1746 0x06d2 -Cyrillic_es 1747 0x06d3 -Cyrillic_te 1748 0x06d4 -Cyrillic_u 1749 0x06d5 -Cyrillic_zhe 1750 0x06d6 -Cyrillic_ve 1751 0x06d7 -Cyrillic_softsign 1752 0x06d8 -Cyrillic_yeru 1753 0x06d9 -Cyrillic_ze 1754 0x06da -Cyrillic_sha 1755 0x06db -Cyrillic_e 1756 0x06dc -Cyrillic_shcha 1757 0x06dd -Cyrillic_che 1758 0x06de -Cyrillic_hardsign 1759 0x06df -Cyrillic_YU 1760 0x06e0 -Cyrillic_A 1761 0x06e1 -Cyrillic_BE 1762 0x06e2 -Cyrillic_TSE 1763 0x06e3 -Cyrillic_DE 1764 0x06e4 -Cyrillic_IE 1765 0x06e5 -Cyrillic_EF 1766 0x06e6 -Cyrillic_GHE 1767 0x06e7 -Cyrillic_HA 1768 0x06e8 -Cyrillic_I 1769 0x06e9 -Cyrillic_SHORTI 1770 0x06ea -Cyrillic_KA 1771 0x06eb -Cyrillic_EL 1772 0x06ec -Cyrillic_EM 1773 0x06ed -Cyrillic_EN 1774 0x06ee -Cyrillic_O 1775 0x06ef -Cyrillic_PE 1776 0x06f0 -Cyrillic_YA 1777 0x06f1 -Cyrillic_ER 1778 0x06f2 -Cyrillic_ES 1779 0x06f3 -Cyrillic_TE 1780 0x06f4 -Cyrillic_U 1781 0x06f5 -Cyrillic_ZHE 1782 0x06f6 -Cyrillic_VE 1783 0x06f7 -Cyrillic_SOFTSIGN 1784 0x06f8 -Cyrillic_YERU 1785 0x06f9 -Cyrillic_ZE 1786 0x06fa -Cyrillic_SHA 1787 0x06fb -Cyrillic_E 1788 0x06fc -Cyrillic_SHCHA 1789 0x06fd -Cyrillic_CHE 1790 0x06fe -Cyrillic_HARDSIGN 1791 0x06ff -Greek_ALPHAaccent 1953 0x07a1 -Greek_EPSILONaccent 1954 0x07a2 -Greek_ETAaccent 1955 0x07a3 -Greek_IOTAaccent 1956 0x07a4 -Greek_IOTAdiaeresis 1957 0x07a5 -Greek_IOTAaccentdiaeresis 1958 0x07a6 -Greek_OMICRONaccent 1959 0x07a7 -Greek_UPSILONaccent 1960 0x07a8 -Greek_UPSILONdieresis 1961 0x07a9 -Greek_UPSILONaccentdieresis 1962 0x07aa -Greek_OMEGAaccent 1963 0x07ab -Greek_alphaaccent 1969 0x07b1 -Greek_epsilonaccent 1970 0x07b2 -Greek_etaaccent 1971 0x07b3 -Greek_iotaaccent 1972 0x07b4 -Greek_iotadieresis 1973 0x07b5 -Greek_iotaaccentdieresis 1974 0x07b6 -Greek_omicronaccent 1975 0x07b7 -Greek_upsilonaccent 1976 0x07b8 -Greek_upsilondieresis 1977 0x07b9 -Greek_upsilonaccentdieresis 1978 0x07ba -Greek_omegaaccent 1979 0x07bb -Greek_ALPHA 1985 0x07c1 -Greek_BETA 1986 0x07c2 -Greek_GAMMA 1987 0x07c3 -Greek_DELTA 1988 0x07c4 -Greek_EPSILON 1989 0x07c5 -Greek_ZETA 1990 0x07c6 -Greek_ETA 1991 0x07c7 -Greek_THETA 1992 0x07c8 -Greek_IOTA 1993 0x07c9 -Greek_KAPPA 1994 0x07ca -Greek_LAMBDA 1995 0x07cb -Greek_MU 1996 0x07cc -Greek_NU 1997 0x07cd -Greek_XI 1998 0x07ce -Greek_OMICRON 1999 0x07cf -Greek_PI 2000 0x07d0 -Greek_RHO 2001 0x07d1 -Greek_SIGMA 2002 0x07d2 -Greek_TAU 2004 0x07d4 -Greek_UPSILON 2005 0x07d5 -Greek_PHI 2006 0x07d6 -Greek_CHI 2007 0x07d7 -Greek_PSI 2008 0x07d8 -Greek_OMEGA 2009 0x07d9 -Greek_alpha 2017 0x07e1 -Greek_beta 2018 0x07e2 -Greek_gamma 2019 0x07e3 -Greek_delta 2020 0x07e4 -Greek_epsilon 2021 0x07e5 -Greek_zeta 2022 0x07e6 -Greek_eta 2023 0x07e7 -Greek_theta 2024 0x07e8 -Greek_iota 2025 0x07e9 -Greek_kappa 2026 0x07ea -Greek_lambda 2027 0x07eb -Greek_mu 2028 0x07ec -Greek_nu 2029 0x07ed -Greek_xi 2030 0x07ee -Greek_omicron 2031 0x07ef -Greek_pi 2032 0x07f0 -Greek_rho 2033 0x07f1 -Greek_sigma 2034 0x07f2 -Greek_finalsmallsigma 2035 0x07f3 -Greek_tau 2036 0x07f4 -Greek_upsilon 2037 0x07f5 -Greek_phi 2038 0x07f6 -Greek_chi 2039 0x07f7 -Greek_psi 2040 0x07f8 -Greek_omega 2041 0x07f9 -leftradical 2209 0x08a1 -topleftradical 2210 0x08a2 -horizconnector 2211 0x08a3 -topintegral 2212 0x08a4 -botintegral 2213 0x08a5 -vertconnector 2214 0x08a6 -topleftsqbracket 2215 0x08a7 -botleftsqbracket 2216 0x08a8 -toprightsqbracket 2217 0x08a9 -botrightsqbracket 2218 0x08aa -topleftparens 2219 0x08ab -botleftparens 2220 0x08ac -toprightparens 2221 0x08ad -botrightparens 2222 0x08ae -leftmiddlecurlybrace 2223 0x08af -rightmiddlecurlybrace 2224 0x08b0 -topleftsummation 2225 0x08b1 -botleftsummation 2226 0x08b2 -topvertsummationconnector 2227 0x08b3 -botvertsummationconnector 2228 0x08b4 -toprightsummation 2229 0x08b5 -botrightsummation 2230 0x08b6 -rightmiddlesummation 2231 0x08b7 -.CE -.CS -lessthanequal 2236 0x08bc -notequal 2237 0x08bd -greaterthanequal 2238 0x08be -integral 2239 0x08bf -therefore 2240 0x08c0 -variation 2241 0x08c1 -infinity 2242 0x08c2 -nabla 2245 0x08c5 -approximate 2248 0x08c8 -similarequal 2249 0x08c9 -ifonlyif 2253 0x08cd -implies 2254 0x08ce -identical 2255 0x08cf -radical 2262 0x08d6 -includedin 2266 0x08da -includes 2267 0x08db -intersection 2268 0x08dc -union 2269 0x08dd -logicaland 2270 0x08de -logicalor 2271 0x08df -partialderivative 2287 0x08ef -function 2294 0x08f6 -leftarrow 2299 0x08fb -uparrow 2300 0x08fc -rightarrow 2301 0x08fd -downarrow 2302 0x08fe -blank 2527 0x09df -soliddiamond 2528 0x09e0 -checkerboard 2529 0x09e1 -ht 2530 0x09e2 -ff 2531 0x09e3 -cr 2532 0x09e4 -lf 2533 0x09e5 -nl 2536 0x09e8 -vt 2537 0x09e9 -lowrightcorner 2538 0x09ea -uprightcorner 2539 0x09eb -upleftcorner 2540 0x09ec -lowleftcorner 2541 0x09ed -crossinglines 2542 0x09ee -horizlinescan1 2543 0x09ef -horizlinescan3 2544 0x09f0 -horizlinescan5 2545 0x09f1 -horizlinescan7 2546 0x09f2 -horizlinescan9 2547 0x09f3 -leftt 2548 0x09f4 -rightt 2549 0x09f5 -bott 2550 0x09f6 -topt 2551 0x09f7 -vertbar 2552 0x09f8 -emspace 2721 0x0aa1 -enspace 2722 0x0aa2 -em3space 2723 0x0aa3 -em4space 2724 0x0aa4 -digitspace 2725 0x0aa5 -punctspace 2726 0x0aa6 -thinspace 2727 0x0aa7 -hairspace 2728 0x0aa8 -emdash 2729 0x0aa9 -endash 2730 0x0aaa -signifblank 2732 0x0aac -ellipsis 2734 0x0aae -doubbaselinedot 2735 0x0aaf -onethird 2736 0x0ab0 -twothirds 2737 0x0ab1 -onefifth 2738 0x0ab2 -twofifths 2739 0x0ab3 -threefifths 2740 0x0ab4 -fourfifths 2741 0x0ab5 -onesixth 2742 0x0ab6 -fivesixths 2743 0x0ab7 -careof 2744 0x0ab8 -figdash 2747 0x0abb -leftanglebracket 2748 0x0abc -decimalpoint 2749 0x0abd -rightanglebracket 2750 0x0abe -marker 2751 0x0abf -oneeighth 2755 0x0ac3 -threeeighths 2756 0x0ac4 -fiveeighths 2757 0x0ac5 -seveneighths 2758 0x0ac6 -trademark 2761 0x0ac9 -signaturemark 2762 0x0aca -trademarkincircle 2763 0x0acb -leftopentriangle 2764 0x0acc -rightopentriangle 2765 0x0acd -emopencircle 2766 0x0ace -emopenrectangle 2767 0x0acf -leftsinglequotemark 2768 0x0ad0 -rightsinglequotemark 2769 0x0ad1 -leftdoublequotemark 2770 0x0ad2 -rightdoublequotemark 2771 0x0ad3 -prescription 2772 0x0ad4 -minutes 2774 0x0ad6 -seconds 2775 0x0ad7 -latincross 2777 0x0ad9 -hexagram 2778 0x0ada -filledrectbullet 2779 0x0adb -filledlefttribullet 2780 0x0adc -filledrighttribullet 2781 0x0add -emfilledcircle 2782 0x0ade -emfilledrect 2783 0x0adf -enopencircbullet 2784 0x0ae0 -enopensquarebullet 2785 0x0ae1 -openrectbullet 2786 0x0ae2 -opentribulletup 2787 0x0ae3 -opentribulletdown 2788 0x0ae4 -openstar 2789 0x0ae5 -enfilledcircbullet 2790 0x0ae6 -enfilledsqbullet 2791 0x0ae7 -filledtribulletup 2792 0x0ae8 -filledtribulletdown 2793 0x0ae9 -leftpointer 2794 0x0aea -rightpointer 2795 0x0aeb -club 2796 0x0aec -diamond 2797 0x0aed -heart 2798 0x0aee -maltesecross 2800 0x0af0 -dagger 2801 0x0af1 -doubledagger 2802 0x0af2 -checkmark 2803 0x0af3 -ballotcross 2804 0x0af4 -musicalsharp 2805 0x0af5 -musicalflat 2806 0x0af6 -malesymbol 2807 0x0af7 -femalesymbol 2808 0x0af8 -telephone 2809 0x0af9 -telephonerecorder 2810 0x0afa -phonographcopyright 2811 0x0afb -caret 2812 0x0afc -singlelowquotemark 2813 0x0afd -doublelowquotemark 2814 0x0afe -cursor 2815 0x0aff -leftcaret 2979 0x0ba3 -rightcaret 2982 0x0ba6 -downcaret 2984 0x0ba8 -upcaret 2985 0x0ba9 -overbar 3008 0x0bc0 -downtack 3010 0x0bc2 -upshoe 3011 0x0bc3 -downstile 3012 0x0bc4 -underbar 3014 0x0bc6 -jot 3018 0x0bca -quad 3020 0x0bcc -uptack 3022 0x0bce -circle 3023 0x0bcf -upstile 3027 0x0bd3 -downshoe 3030 0x0bd6 -rightshoe 3032 0x0bd8 -leftshoe 3034 0x0bda -lefttack 3036 0x0bdc -righttack 3068 0x0bfc -hebrew_aleph 3296 0x0ce0 -hebrew_beth 3297 0x0ce1 -hebrew_gimmel 3298 0x0ce2 -hebrew_daleth 3299 0x0ce3 -hebrew_he 3300 0x0ce4 -hebrew_waw 3301 0x0ce5 -hebrew_zayin 3302 0x0ce6 -hebrew_het 3303 0x0ce7 -hebrew_teth 3304 0x0ce8 -hebrew_yod 3305 0x0ce9 -hebrew_finalkaph 3306 0x0cea -hebrew_kaph 3307 0x0ceb -hebrew_lamed 3308 0x0cec -hebrew_finalmem 3309 0x0ced -hebrew_mem 3310 0x0cee -hebrew_finalnun 3311 0x0cef -hebrew_nun 3312 0x0cf0 -hebrew_samekh 3313 0x0cf1 -hebrew_ayin 3314 0x0cf2 -hebrew_finalpe 3315 0x0cf3 -hebrew_pe 3316 0x0cf4 -hebrew_finalzadi 3317 0x0cf5 -hebrew_zadi 3318 0x0cf6 -hebrew_kuf 3319 0x0cf7 -hebrew_resh 3320 0x0cf8 -hebrew_shin 3321 0x0cf9 -hebrew_taf 3322 0x0cfa -BackSpace 65288 0xff08 -Tab 65289 0xff09 -Linefeed 65290 0xff0a -Clear 65291 0xff0b -Return 65293 0xff0d -Pause 65299 0xff13 -Scroll_Lock 65300 0xff14 -Sys_Req 65301 0xff15 -Escape 65307 0xff1b -Multi_key 65312 0xff20 -Kanji 65313 0xff21 -Home 65360 0xff50 -Left 65361 0xff51 -Up 65362 0xff52 -Right 65363 0xff53 -Down 65364 0xff54 -Prior 65365 0xff55 -Next 65366 0xff56 -End 65367 0xff57 -Begin 65368 0xff58 -Win_L 65371 0xff5b -Win_R 65372 0xff5c -.CE -.CS -App 65373 0xff5d -Select 65376 0xff60 -Print 65377 0xff61 -Execute 65378 0xff62 -Insert 65379 0xff63 -Undo 65381 0xff65 -Redo 65382 0xff66 -Menu 65383 0xff67 -Find 65384 0xff68 -Cancel 65385 0xff69 -Help 65386 0xff6a -Break 65387 0xff6b -Hebrew_switch 65406 0xff7e -Num_Lock 65407 0xff7f -KP_Space 65408 0xff80 -KP_Tab 65417 0xff89 -KP_Enter 65421 0xff8d -KP_F1 65425 0xff91 -KP_F2 65426 0xff92 -KP_F3 65427 0xff93 -KP_F4 65428 0xff94 -KP_Multiply 65450 0xffaa -KP_Add 65451 0xffab -KP_Separator 65452 0xffac -KP_Subtract 65453 0xffad -KP_Decimal 65454 0xffae -KP_Divide 65455 0xffaf -KP_0 65456 0xffb0 -KP_1 65457 0xffb1 -KP_2 65458 0xffb2 -KP_3 65459 0xffb3 -KP_4 65460 0xffb4 -KP_5 65461 0xffb5 -KP_6 65462 0xffb6 -KP_7 65463 0xffb7 -KP_8 65464 0xffb8 -KP_9 65465 0xffb9 -KP_Equal 65469 0xffbd -F1 65470 0xffbe -F2 65471 0xffbf -F3 65472 0xffc0 -F4 65473 0xffc1 -F5 65474 0xffc2 -F6 65475 0xffc3 -F7 65476 0xffc4 -F8 65477 0xffc5 -F9 65478 0xffc6 -F10 65479 0xffc7 -L1 65480 0xffc8 -L2 65481 0xffc9 -L3 65482 0xffca -L4 65483 0xffcb -L5 65484 0xffcc -L6 65485 0xffcd -L7 65486 0xffce -L8 65487 0xffcf -L9 65488 0xffd0 -L10 65489 0xffd1 -R1 65490 0xffd2 -R2 65491 0xffd3 -R3 65492 0xffd4 -R4 65493 0xffd5 -R5 65494 0xffd6 -R6 65495 0xffd7 -R7 65496 0xffd8 -R8 65497 0xffd9 -R9 65498 0xffda -R10 65499 0xffdb -R11 65500 0xffdc -R12 65501 0xffdd -F33 65502 0xffde -R14 65503 0xffdf -R15 65504 0xffe0 -Shift_L 65505 0xffe1 -Shift_R 65506 0xffe2 -Control_L 65507 0xffe3 -Control_R 65508 0xffe4 -Caps_Lock 65509 0xffe5 -Shift_Lock 65510 0xffe6 -Meta_L 65511 0xffe7 -Meta_R 65512 0xffe8 -Alt_L 65513 0xffe9 -Alt_R 65514 0xffea -Super_L 65515 0xffeb -Super_R 65516 0xffec -Hyper_L 65517 0xffed -Hyper_R 65518 0xffee -Delete 65535 0xffff -.CE -.SH "SEE ALSO" -bind -.SH KEYWORDS -keysym, bind, binding +'\" -*- nroff -*- +'\" +'\" Copyright (c) 1998-2000 by Scriptics Corporation. +'\" All rights reserved. +'\" +'\" RCS: @(#) $Id: keysyms.n,v 1.6 2008/07/08 22:40:51 patthoyts Exp $ +'\" +'\" +.so man.macros +.TH keysyms n 8.3 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +keysyms \- keysyms recognized by Tk +.BE +.SH DESCRIPTION +.PP +Tk recognizes many keysyms when specifying key bindings (e.g. +\fBbind . \fR). The following list enumerates the +keysyms that will be recognized by Tk. Note that not all keysyms will +be valid on all platforms. For example, on Unix systems, the presence +of a particular keysym is dependant on the configuration of the +keyboard modifier map. This list shows keysyms along with their +decimal and hexadecimal values. +.PP +.CS +space 32 0x0020 +exclam 33 0x0021 +quotedbl 34 0x0022 +numbersign 35 0x0023 +dollar 36 0x0024 +percent 37 0x0025 +ampersand 38 0x0026 +quoteright 39 0x0027 +parenleft 40 0x0028 +parenright 41 0x0029 +asterisk 42 0x002a +plus 43 0x002b +comma 44 0x002c +minus 45 0x002d +period 46 0x002e +slash 47 0x002f +0 48 0x0030 +1 49 0x0031 +2 50 0x0032 +3 51 0x0033 +4 52 0x0034 +5 53 0x0035 +6 54 0x0036 +7 55 0x0037 +8 56 0x0038 +9 57 0x0039 +colon 58 0x003a +semicolon 59 0x003b +less 60 0x003c +equal 61 0x003d +greater 62 0x003e +question 63 0x003f +at 64 0x0040 +A 65 0x0041 +B 66 0x0042 +C 67 0x0043 +D 68 0x0044 +E 69 0x0045 +F 70 0x0046 +G 71 0x0047 +H 72 0x0048 +I 73 0x0049 +J 74 0x004a +K 75 0x004b +L 76 0x004c +M 77 0x004d +N 78 0x004e +O 79 0x004f +P 80 0x0050 +Q 81 0x0051 +R 82 0x0052 +S 83 0x0053 +T 84 0x0054 +U 85 0x0055 +V 86 0x0056 +W 87 0x0057 +X 88 0x0058 +Y 89 0x0059 +Z 90 0x005a +bracketleft 91 0x005b +backslash 92 0x005c +bracketright 93 0x005d +asciicircum 94 0x005e +underscore 95 0x005f +quoteleft 96 0x0060 +a 97 0x0061 +b 98 0x0062 +c 99 0x0063 +d 100 0x0064 +e 101 0x0065 +f 102 0x0066 +g 103 0x0067 +h 104 0x0068 +i 105 0x0069 +j 106 0x006a +k 107 0x006b +l 108 0x006c +m 109 0x006d +n 110 0x006e +o 111 0x006f +p 112 0x0070 +q 113 0x0071 +r 114 0x0072 +s 115 0x0073 +t 116 0x0074 +u 117 0x0075 +v 118 0x0076 +w 119 0x0077 +x 120 0x0078 +y 121 0x0079 +z 122 0x007a +braceleft 123 0x007b +bar 124 0x007c +braceright 125 0x007d +asciitilde 126 0x007e +nobreakspace 160 0x00a0 +exclamdown 161 0x00a1 +cent 162 0x00a2 +sterling 163 0x00a3 +currency 164 0x00a4 +yen 165 0x00a5 +brokenbar 166 0x00a6 +section 167 0x00a7 +diaeresis 168 0x00a8 +copyright 169 0x00a9 +ordfeminine 170 0x00aa +guillemotleft 171 0x00ab +notsign 172 0x00ac +hyphen 173 0x00ad +registered 174 0x00ae +macron 175 0x00af +degree 176 0x00b0 +plusminus 177 0x00b1 +twosuperior 178 0x00b2 +threesuperior 179 0x00b3 +acute 180 0x00b4 +mu 181 0x00b5 +paragraph 182 0x00b6 +periodcentered 183 0x00b7 +cedilla 184 0x00b8 +onesuperior 185 0x00b9 +masculine 186 0x00ba +guillemotright 187 0x00bb +onequarter 188 0x00bc +onehalf 189 0x00bd +threequarters 190 0x00be +questiondown 191 0x00bf +Agrave 192 0x00c0 +Aacute 193 0x00c1 +Acircumflex 194 0x00c2 +Atilde 195 0x00c3 +Adiaeresis 196 0x00c4 +Aring 197 0x00c5 +AE 198 0x00c6 +Ccedilla 199 0x00c7 +Egrave 200 0x00c8 +Eacute 201 0x00c9 +Ecircumflex 202 0x00ca +Ediaeresis 203 0x00cb +Igrave 204 0x00cc +Iacute 205 0x00cd +Icircumflex 206 0x00ce +Idiaeresis 207 0x00cf +Eth 208 0x00d0 +Ntilde 209 0x00d1 +Ograve 210 0x00d2 +Oacute 211 0x00d3 +Ocircumflex 212 0x00d4 +Otilde 213 0x00d5 +Odiaeresis 214 0x00d6 +multiply 215 0x00d7 +Ooblique 216 0x00d8 +Ugrave 217 0x00d9 +Uacute 218 0x00da +Ucircumflex 219 0x00db +Udiaeresis 220 0x00dc +Yacute 221 0x00dd +Thorn 222 0x00de +ssharp 223 0x00df +agrave 224 0x00e0 +aacute 225 0x00e1 +acircumflex 226 0x00e2 +atilde 227 0x00e3 +adiaeresis 228 0x00e4 +aring 229 0x00e5 +ae 230 0x00e6 +ccedilla 231 0x00e7 +egrave 232 0x00e8 +eacute 233 0x00e9 +ecircumflex 234 0x00ea +ediaeresis 235 0x00eb +igrave 236 0x00ec +iacute 237 0x00ed +icircumflex 238 0x00ee +idiaeresis 239 0x00ef +eth 240 0x00f0 +ntilde 241 0x00f1 +ograve 242 0x00f2 +oacute 243 0x00f3 +ocircumflex 244 0x00f4 +otilde 245 0x00f5 +odiaeresis 246 0x00f6 +division 247 0x00f7 +oslash 248 0x00f8 +ugrave 249 0x00f9 +uacute 250 0x00fa +ucircumflex 251 0x00fb +udiaeresis 252 0x00fc +yacute 253 0x00fd +thorn 254 0x00fe +ydiaeresis 255 0x00ff +Aogonek 417 0x01a1 +breve 418 0x01a2 +Lstroke 419 0x01a3 +Lcaron 421 0x01a5 +Sacute 422 0x01a6 +Scaron 425 0x01a9 +Scedilla 426 0x01aa +Tcaron 427 0x01ab +Zacute 428 0x01ac +.CE +.CS +Zcaron 430 0x01ae +Zabovedot 431 0x01af +aogonek 433 0x01b1 +ogonek 434 0x01b2 +lstroke 435 0x01b3 +lcaron 437 0x01b5 +sacute 438 0x01b6 +caron 439 0x01b7 +scaron 441 0x01b9 +scedilla 442 0x01ba +tcaron 443 0x01bb +zacute 444 0x01bc +doubleacute 445 0x01bd +zcaron 446 0x01be +zabovedot 447 0x01bf +Racute 448 0x01c0 +Abreve 451 0x01c3 +Cacute 454 0x01c6 +Ccaron 456 0x01c8 +Eogonek 458 0x01ca +Ecaron 460 0x01cc +Dcaron 463 0x01cf +Nacute 465 0x01d1 +Ncaron 466 0x01d2 +Odoubleacute 469 0x01d5 +Rcaron 472 0x01d8 +Uring 473 0x01d9 +Udoubleacute 475 0x01db +Tcedilla 478 0x01de +racute 480 0x01e0 +abreve 483 0x01e3 +cacute 486 0x01e6 +ccaron 488 0x01e8 +eogonek 490 0x01ea +ecaron 492 0x01ec +dcaron 495 0x01ef +nacute 497 0x01f1 +ncaron 498 0x01f2 +odoubleacute 501 0x01f5 +rcaron 504 0x01f8 +uring 505 0x01f9 +udoubleacute 507 0x01fb +tcedilla 510 0x01fe +abovedot 511 0x01ff +Hstroke 673 0x02a1 +Hcircumflex 678 0x02a6 +Iabovedot 681 0x02a9 +Gbreve 683 0x02ab +Jcircumflex 684 0x02ac +hstroke 689 0x02b1 +hcircumflex 694 0x02b6 +idotless 697 0x02b9 +gbreve 699 0x02bb +jcircumflex 700 0x02bc +Cabovedot 709 0x02c5 +Ccircumflex 710 0x02c6 +Gabovedot 725 0x02d5 +Gcircumflex 728 0x02d8 +Ubreve 733 0x02dd +Scircumflex 734 0x02de +cabovedot 741 0x02e5 +ccircumflex 742 0x02e6 +gabovedot 757 0x02f5 +gcircumflex 760 0x02f8 +ubreve 765 0x02fd +scircumflex 766 0x02fe +kappa 930 0x03a2 +Rcedilla 931 0x03a3 +Itilde 933 0x03a5 +Lcedilla 934 0x03a6 +Emacron 938 0x03aa +Gcedilla 939 0x03ab +Tslash 940 0x03ac +rcedilla 947 0x03b3 +itilde 949 0x03b5 +lcedilla 950 0x03b6 +emacron 954 0x03ba +gacute 955 0x03bb +tslash 956 0x03bc +ENG 957 0x03bd +eng 959 0x03bf +Amacron 960 0x03c0 +Iogonek 967 0x03c7 +Eabovedot 972 0x03cc +Imacron 975 0x03cf +Ncedilla 977 0x03d1 +Omacron 978 0x03d2 +Kcedilla 979 0x03d3 +Uogonek 985 0x03d9 +Utilde 989 0x03dd +Umacron 990 0x03de +amacron 992 0x03e0 +iogonek 999 0x03e7 +eabovedot 1004 0x03ec +imacron 1007 0x03ef +ncedilla 1009 0x03f1 +omacron 1010 0x03f2 +kcedilla 1011 0x03f3 +uogonek 1017 0x03f9 +utilde 1021 0x03fd +umacron 1022 0x03fe +overline 1150 0x047e +kana_fullstop 1185 0x04a1 +kana_openingbracket 1186 0x04a2 +kana_closingbracket 1187 0x04a3 +kana_comma 1188 0x04a4 +kana_middledot 1189 0x04a5 +kana_WO 1190 0x04a6 +kana_a 1191 0x04a7 +kana_i 1192 0x04a8 +kana_u 1193 0x04a9 +kana_e 1194 0x04aa +kana_o 1195 0x04ab +kana_ya 1196 0x04ac +kana_yu 1197 0x04ad +kana_yo 1198 0x04ae +kana_tu 1199 0x04af +prolongedsound 1200 0x04b0 +kana_A 1201 0x04b1 +kana_I 1202 0x04b2 +kana_U 1203 0x04b3 +kana_E 1204 0x04b4 +kana_O 1205 0x04b5 +kana_KA 1206 0x04b6 +kana_KI 1207 0x04b7 +kana_KU 1208 0x04b8 +kana_KE 1209 0x04b9 +kana_KO 1210 0x04ba +kana_SA 1211 0x04bb +kana_SHI 1212 0x04bc +kana_SU 1213 0x04bd +kana_SE 1214 0x04be +kana_SO 1215 0x04bf +kana_TA 1216 0x04c0 +kana_TI 1217 0x04c1 +kana_TU 1218 0x04c2 +kana_TE 1219 0x04c3 +kana_TO 1220 0x04c4 +kana_NA 1221 0x04c5 +kana_NI 1222 0x04c6 +kana_NU 1223 0x04c7 +kana_NE 1224 0x04c8 +kana_NO 1225 0x04c9 +kana_HA 1226 0x04ca +kana_HI 1227 0x04cb +kana_HU 1228 0x04cc +kana_HE 1229 0x04cd +kana_HO 1230 0x04ce +kana_MA 1231 0x04cf +kana_MI 1232 0x04d0 +kana_MU 1233 0x04d1 +kana_ME 1234 0x04d2 +kana_MO 1235 0x04d3 +kana_YA 1236 0x04d4 +kana_YU 1237 0x04d5 +kana_YO 1238 0x04d6 +kana_RA 1239 0x04d7 +kana_RI 1240 0x04d8 +kana_RU 1241 0x04d9 +kana_RE 1242 0x04da +kana_RO 1243 0x04db +kana_WA 1244 0x04dc +kana_N 1245 0x04dd +voicedsound 1246 0x04de +semivoicedsound 1247 0x04df +Arabic_comma 1452 0x05ac +Arabic_semicolon 1467 0x05bb +Arabic_question_mark 1471 0x05bf +Arabic_hamza 1473 0x05c1 +Arabic_maddaonalef 1474 0x05c2 +Arabic_hamzaonalef 1475 0x05c3 +Arabic_hamzaonwaw 1476 0x05c4 +Arabic_hamzaunderalef 1477 0x05c5 +Arabic_hamzaonyeh 1478 0x05c6 +Arabic_alef 1479 0x05c7 +Arabic_beh 1480 0x05c8 +Arabic_tehmarbuta 1481 0x05c9 +Arabic_teh 1482 0x05ca +Arabic_theh 1483 0x05cb +Arabic_jeem 1484 0x05cc +Arabic_hah 1485 0x05cd +Arabic_khah 1486 0x05ce +Arabic_dal 1487 0x05cf +Arabic_thal 1488 0x05d0 +Arabic_ra 1489 0x05d1 +Arabic_zain 1490 0x05d2 +Arabic_seen 1491 0x05d3 +Arabic_sheen 1492 0x05d4 +Arabic_sad 1493 0x05d5 +Arabic_dad 1494 0x05d6 +Arabic_tah 1495 0x05d7 +Arabic_zah 1496 0x05d8 +Arabic_ain 1497 0x05d9 +Arabic_ghain 1498 0x05da +Arabic_tatweel 1504 0x05e0 +Arabic_feh 1505 0x05e1 +Arabic_qaf 1506 0x05e2 +Arabic_kaf 1507 0x05e3 +Arabic_lam 1508 0x05e4 +Arabic_meem 1509 0x05e5 +.CE +.CS +Arabic_noon 1510 0x05e6 +Arabic_heh 1511 0x05e7 +Arabic_waw 1512 0x05e8 +Arabic_alefmaksura 1513 0x05e9 +Arabic_yeh 1514 0x05ea +Arabic_fathatan 1515 0x05eb +Arabic_dammatan 1516 0x05ec +Arabic_kasratan 1517 0x05ed +Arabic_fatha 1518 0x05ee +Arabic_damma 1519 0x05ef +Arabic_kasra 1520 0x05f0 +Arabic_shadda 1521 0x05f1 +Arabic_sukun 1522 0x05f2 +Serbian_dje 1697 0x06a1 +Macedonia_gje 1698 0x06a2 +Cyrillic_io 1699 0x06a3 +Ukranian_je 1700 0x06a4 +Macedonia_dse 1701 0x06a5 +Ukranian_i 1702 0x06a6 +Ukranian_yi 1703 0x06a7 +Serbian_je 1704 0x06a8 +Serbian_lje 1705 0x06a9 +Serbian_nje 1706 0x06aa +Serbian_tshe 1707 0x06ab +Macedonia_kje 1708 0x06ac +Byelorussian_shortu 1710 0x06ae +Serbian_dze 1711 0x06af +numerosign 1712 0x06b0 +Serbian_DJE 1713 0x06b1 +Macedonia_GJE 1714 0x06b2 +Cyrillic_IO 1715 0x06b3 +Ukranian_JE 1716 0x06b4 +Macedonia_DSE 1717 0x06b5 +Ukranian_I 1718 0x06b6 +Ukranian_YI 1719 0x06b7 +Serbian_JE 1720 0x06b8 +Serbian_LJE 1721 0x06b9 +Serbian_NJE 1722 0x06ba +Serbian_TSHE 1723 0x06bb +Macedonia_KJE 1724 0x06bc +Byelorussian_SHORTU 1726 0x06be +Serbian_DZE 1727 0x06bf +Cyrillic_yu 1728 0x06c0 +Cyrillic_a 1729 0x06c1 +Cyrillic_be 1730 0x06c2 +Cyrillic_tse 1731 0x06c3 +Cyrillic_de 1732 0x06c4 +Cyrillic_ie 1733 0x06c5 +Cyrillic_ef 1734 0x06c6 +Cyrillic_ghe 1735 0x06c7 +Cyrillic_ha 1736 0x06c8 +Cyrillic_i 1737 0x06c9 +Cyrillic_shorti 1738 0x06ca +Cyrillic_ka 1739 0x06cb +Cyrillic_el 1740 0x06cc +Cyrillic_em 1741 0x06cd +Cyrillic_en 1742 0x06ce +Cyrillic_o 1743 0x06cf +Cyrillic_pe 1744 0x06d0 +Cyrillic_ya 1745 0x06d1 +Cyrillic_er 1746 0x06d2 +Cyrillic_es 1747 0x06d3 +Cyrillic_te 1748 0x06d4 +Cyrillic_u 1749 0x06d5 +Cyrillic_zhe 1750 0x06d6 +Cyrillic_ve 1751 0x06d7 +Cyrillic_softsign 1752 0x06d8 +Cyrillic_yeru 1753 0x06d9 +Cyrillic_ze 1754 0x06da +Cyrillic_sha 1755 0x06db +Cyrillic_e 1756 0x06dc +Cyrillic_shcha 1757 0x06dd +Cyrillic_che 1758 0x06de +Cyrillic_hardsign 1759 0x06df +Cyrillic_YU 1760 0x06e0 +Cyrillic_A 1761 0x06e1 +Cyrillic_BE 1762 0x06e2 +Cyrillic_TSE 1763 0x06e3 +Cyrillic_DE 1764 0x06e4 +Cyrillic_IE 1765 0x06e5 +Cyrillic_EF 1766 0x06e6 +Cyrillic_GHE 1767 0x06e7 +Cyrillic_HA 1768 0x06e8 +Cyrillic_I 1769 0x06e9 +Cyrillic_SHORTI 1770 0x06ea +Cyrillic_KA 1771 0x06eb +Cyrillic_EL 1772 0x06ec +Cyrillic_EM 1773 0x06ed +Cyrillic_EN 1774 0x06ee +Cyrillic_O 1775 0x06ef +Cyrillic_PE 1776 0x06f0 +Cyrillic_YA 1777 0x06f1 +Cyrillic_ER 1778 0x06f2 +Cyrillic_ES 1779 0x06f3 +Cyrillic_TE 1780 0x06f4 +Cyrillic_U 1781 0x06f5 +Cyrillic_ZHE 1782 0x06f6 +Cyrillic_VE 1783 0x06f7 +Cyrillic_SOFTSIGN 1784 0x06f8 +Cyrillic_YERU 1785 0x06f9 +Cyrillic_ZE 1786 0x06fa +Cyrillic_SHA 1787 0x06fb +Cyrillic_E 1788 0x06fc +Cyrillic_SHCHA 1789 0x06fd +Cyrillic_CHE 1790 0x06fe +Cyrillic_HARDSIGN 1791 0x06ff +Greek_ALPHAaccent 1953 0x07a1 +Greek_EPSILONaccent 1954 0x07a2 +Greek_ETAaccent 1955 0x07a3 +Greek_IOTAaccent 1956 0x07a4 +Greek_IOTAdiaeresis 1957 0x07a5 +Greek_IOTAaccentdiaeresis 1958 0x07a6 +Greek_OMICRONaccent 1959 0x07a7 +Greek_UPSILONaccent 1960 0x07a8 +Greek_UPSILONdieresis 1961 0x07a9 +Greek_UPSILONaccentdieresis 1962 0x07aa +Greek_OMEGAaccent 1963 0x07ab +Greek_alphaaccent 1969 0x07b1 +Greek_epsilonaccent 1970 0x07b2 +Greek_etaaccent 1971 0x07b3 +Greek_iotaaccent 1972 0x07b4 +Greek_iotadieresis 1973 0x07b5 +Greek_iotaaccentdieresis 1974 0x07b6 +Greek_omicronaccent 1975 0x07b7 +Greek_upsilonaccent 1976 0x07b8 +Greek_upsilondieresis 1977 0x07b9 +Greek_upsilonaccentdieresis 1978 0x07ba +Greek_omegaaccent 1979 0x07bb +Greek_ALPHA 1985 0x07c1 +Greek_BETA 1986 0x07c2 +Greek_GAMMA 1987 0x07c3 +Greek_DELTA 1988 0x07c4 +Greek_EPSILON 1989 0x07c5 +Greek_ZETA 1990 0x07c6 +Greek_ETA 1991 0x07c7 +Greek_THETA 1992 0x07c8 +Greek_IOTA 1993 0x07c9 +Greek_KAPPA 1994 0x07ca +Greek_LAMBDA 1995 0x07cb +Greek_MU 1996 0x07cc +Greek_NU 1997 0x07cd +Greek_XI 1998 0x07ce +Greek_OMICRON 1999 0x07cf +Greek_PI 2000 0x07d0 +Greek_RHO 2001 0x07d1 +Greek_SIGMA 2002 0x07d2 +Greek_TAU 2004 0x07d4 +Greek_UPSILON 2005 0x07d5 +Greek_PHI 2006 0x07d6 +Greek_CHI 2007 0x07d7 +Greek_PSI 2008 0x07d8 +Greek_OMEGA 2009 0x07d9 +Greek_alpha 2017 0x07e1 +Greek_beta 2018 0x07e2 +Greek_gamma 2019 0x07e3 +Greek_delta 2020 0x07e4 +Greek_epsilon 2021 0x07e5 +Greek_zeta 2022 0x07e6 +Greek_eta 2023 0x07e7 +Greek_theta 2024 0x07e8 +Greek_iota 2025 0x07e9 +Greek_kappa 2026 0x07ea +Greek_lambda 2027 0x07eb +Greek_mu 2028 0x07ec +Greek_nu 2029 0x07ed +Greek_xi 2030 0x07ee +Greek_omicron 2031 0x07ef +Greek_pi 2032 0x07f0 +Greek_rho 2033 0x07f1 +Greek_sigma 2034 0x07f2 +Greek_finalsmallsigma 2035 0x07f3 +Greek_tau 2036 0x07f4 +Greek_upsilon 2037 0x07f5 +Greek_phi 2038 0x07f6 +Greek_chi 2039 0x07f7 +Greek_psi 2040 0x07f8 +Greek_omega 2041 0x07f9 +leftradical 2209 0x08a1 +topleftradical 2210 0x08a2 +horizconnector 2211 0x08a3 +topintegral 2212 0x08a4 +botintegral 2213 0x08a5 +vertconnector 2214 0x08a6 +topleftsqbracket 2215 0x08a7 +botleftsqbracket 2216 0x08a8 +toprightsqbracket 2217 0x08a9 +botrightsqbracket 2218 0x08aa +topleftparens 2219 0x08ab +botleftparens 2220 0x08ac +toprightparens 2221 0x08ad +botrightparens 2222 0x08ae +leftmiddlecurlybrace 2223 0x08af +rightmiddlecurlybrace 2224 0x08b0 +topleftsummation 2225 0x08b1 +botleftsummation 2226 0x08b2 +topvertsummationconnector 2227 0x08b3 +botvertsummationconnector 2228 0x08b4 +toprightsummation 2229 0x08b5 +botrightsummation 2230 0x08b6 +rightmiddlesummation 2231 0x08b7 +.CE +.CS +lessthanequal 2236 0x08bc +notequal 2237 0x08bd +greaterthanequal 2238 0x08be +integral 2239 0x08bf +therefore 2240 0x08c0 +variation 2241 0x08c1 +infinity 2242 0x08c2 +nabla 2245 0x08c5 +approximate 2248 0x08c8 +similarequal 2249 0x08c9 +ifonlyif 2253 0x08cd +implies 2254 0x08ce +identical 2255 0x08cf +radical 2262 0x08d6 +includedin 2266 0x08da +includes 2267 0x08db +intersection 2268 0x08dc +union 2269 0x08dd +logicaland 2270 0x08de +logicalor 2271 0x08df +partialderivative 2287 0x08ef +function 2294 0x08f6 +leftarrow 2299 0x08fb +uparrow 2300 0x08fc +rightarrow 2301 0x08fd +downarrow 2302 0x08fe +blank 2527 0x09df +soliddiamond 2528 0x09e0 +checkerboard 2529 0x09e1 +ht 2530 0x09e2 +ff 2531 0x09e3 +cr 2532 0x09e4 +lf 2533 0x09e5 +nl 2536 0x09e8 +vt 2537 0x09e9 +lowrightcorner 2538 0x09ea +uprightcorner 2539 0x09eb +upleftcorner 2540 0x09ec +lowleftcorner 2541 0x09ed +crossinglines 2542 0x09ee +horizlinescan1 2543 0x09ef +horizlinescan3 2544 0x09f0 +horizlinescan5 2545 0x09f1 +horizlinescan7 2546 0x09f2 +horizlinescan9 2547 0x09f3 +leftt 2548 0x09f4 +rightt 2549 0x09f5 +bott 2550 0x09f6 +topt 2551 0x09f7 +vertbar 2552 0x09f8 +emspace 2721 0x0aa1 +enspace 2722 0x0aa2 +em3space 2723 0x0aa3 +em4space 2724 0x0aa4 +digitspace 2725 0x0aa5 +punctspace 2726 0x0aa6 +thinspace 2727 0x0aa7 +hairspace 2728 0x0aa8 +emdash 2729 0x0aa9 +endash 2730 0x0aaa +signifblank 2732 0x0aac +ellipsis 2734 0x0aae +doubbaselinedot 2735 0x0aaf +onethird 2736 0x0ab0 +twothirds 2737 0x0ab1 +onefifth 2738 0x0ab2 +twofifths 2739 0x0ab3 +threefifths 2740 0x0ab4 +fourfifths 2741 0x0ab5 +onesixth 2742 0x0ab6 +fivesixths 2743 0x0ab7 +careof 2744 0x0ab8 +figdash 2747 0x0abb +leftanglebracket 2748 0x0abc +decimalpoint 2749 0x0abd +rightanglebracket 2750 0x0abe +marker 2751 0x0abf +oneeighth 2755 0x0ac3 +threeeighths 2756 0x0ac4 +fiveeighths 2757 0x0ac5 +seveneighths 2758 0x0ac6 +trademark 2761 0x0ac9 +signaturemark 2762 0x0aca +trademarkincircle 2763 0x0acb +leftopentriangle 2764 0x0acc +rightopentriangle 2765 0x0acd +emopencircle 2766 0x0ace +emopenrectangle 2767 0x0acf +leftsinglequotemark 2768 0x0ad0 +rightsinglequotemark 2769 0x0ad1 +leftdoublequotemark 2770 0x0ad2 +rightdoublequotemark 2771 0x0ad3 +prescription 2772 0x0ad4 +minutes 2774 0x0ad6 +seconds 2775 0x0ad7 +latincross 2777 0x0ad9 +hexagram 2778 0x0ada +filledrectbullet 2779 0x0adb +filledlefttribullet 2780 0x0adc +filledrighttribullet 2781 0x0add +emfilledcircle 2782 0x0ade +emfilledrect 2783 0x0adf +enopencircbullet 2784 0x0ae0 +enopensquarebullet 2785 0x0ae1 +openrectbullet 2786 0x0ae2 +opentribulletup 2787 0x0ae3 +opentribulletdown 2788 0x0ae4 +openstar 2789 0x0ae5 +enfilledcircbullet 2790 0x0ae6 +enfilledsqbullet 2791 0x0ae7 +filledtribulletup 2792 0x0ae8 +filledtribulletdown 2793 0x0ae9 +leftpointer 2794 0x0aea +rightpointer 2795 0x0aeb +club 2796 0x0aec +diamond 2797 0x0aed +heart 2798 0x0aee +maltesecross 2800 0x0af0 +dagger 2801 0x0af1 +doubledagger 2802 0x0af2 +checkmark 2803 0x0af3 +ballotcross 2804 0x0af4 +musicalsharp 2805 0x0af5 +musicalflat 2806 0x0af6 +malesymbol 2807 0x0af7 +femalesymbol 2808 0x0af8 +telephone 2809 0x0af9 +telephonerecorder 2810 0x0afa +phonographcopyright 2811 0x0afb +caret 2812 0x0afc +singlelowquotemark 2813 0x0afd +doublelowquotemark 2814 0x0afe +cursor 2815 0x0aff +leftcaret 2979 0x0ba3 +rightcaret 2982 0x0ba6 +downcaret 2984 0x0ba8 +upcaret 2985 0x0ba9 +overbar 3008 0x0bc0 +downtack 3010 0x0bc2 +upshoe 3011 0x0bc3 +downstile 3012 0x0bc4 +underbar 3014 0x0bc6 +jot 3018 0x0bca +quad 3020 0x0bcc +uptack 3022 0x0bce +circle 3023 0x0bcf +upstile 3027 0x0bd3 +downshoe 3030 0x0bd6 +rightshoe 3032 0x0bd8 +leftshoe 3034 0x0bda +lefttack 3036 0x0bdc +righttack 3068 0x0bfc +hebrew_aleph 3296 0x0ce0 +hebrew_beth 3297 0x0ce1 +hebrew_gimmel 3298 0x0ce2 +hebrew_daleth 3299 0x0ce3 +hebrew_he 3300 0x0ce4 +hebrew_waw 3301 0x0ce5 +hebrew_zayin 3302 0x0ce6 +hebrew_het 3303 0x0ce7 +hebrew_teth 3304 0x0ce8 +hebrew_yod 3305 0x0ce9 +hebrew_finalkaph 3306 0x0cea +hebrew_kaph 3307 0x0ceb +hebrew_lamed 3308 0x0cec +hebrew_finalmem 3309 0x0ced +hebrew_mem 3310 0x0cee +hebrew_finalnun 3311 0x0cef +hebrew_nun 3312 0x0cf0 +hebrew_samekh 3313 0x0cf1 +hebrew_ayin 3314 0x0cf2 +hebrew_finalpe 3315 0x0cf3 +hebrew_pe 3316 0x0cf4 +hebrew_finalzadi 3317 0x0cf5 +hebrew_zadi 3318 0x0cf6 +hebrew_kuf 3319 0x0cf7 +hebrew_resh 3320 0x0cf8 +hebrew_shin 3321 0x0cf9 +hebrew_taf 3322 0x0cfa +BackSpace 65288 0xff08 +Tab 65289 0xff09 +Linefeed 65290 0xff0a +Clear 65291 0xff0b +Return 65293 0xff0d +Pause 65299 0xff13 +Scroll_Lock 65300 0xff14 +Sys_Req 65301 0xff15 +Escape 65307 0xff1b +Multi_key 65312 0xff20 +Kanji 65313 0xff21 +Home 65360 0xff50 +Left 65361 0xff51 +Up 65362 0xff52 +Right 65363 0xff53 +Down 65364 0xff54 +Prior 65365 0xff55 +Next 65366 0xff56 +End 65367 0xff57 +Begin 65368 0xff58 +Win_L 65371 0xff5b +Win_R 65372 0xff5c +.CE +.CS +App 65373 0xff5d +Select 65376 0xff60 +Print 65377 0xff61 +Execute 65378 0xff62 +Insert 65379 0xff63 +Undo 65381 0xff65 +Redo 65382 0xff66 +Menu 65383 0xff67 +Find 65384 0xff68 +Cancel 65385 0xff69 +Help 65386 0xff6a +Break 65387 0xff6b +Hebrew_switch 65406 0xff7e +Num_Lock 65407 0xff7f +KP_Space 65408 0xff80 +KP_Tab 65417 0xff89 +KP_Enter 65421 0xff8d +KP_F1 65425 0xff91 +KP_F2 65426 0xff92 +KP_F3 65427 0xff93 +KP_F4 65428 0xff94 +KP_Multiply 65450 0xffaa +KP_Add 65451 0xffab +KP_Separator 65452 0xffac +KP_Subtract 65453 0xffad +KP_Decimal 65454 0xffae +KP_Divide 65455 0xffaf +KP_0 65456 0xffb0 +KP_1 65457 0xffb1 +KP_2 65458 0xffb2 +KP_3 65459 0xffb3 +KP_4 65460 0xffb4 +KP_5 65461 0xffb5 +KP_6 65462 0xffb6 +KP_7 65463 0xffb7 +KP_8 65464 0xffb8 +KP_9 65465 0xffb9 +KP_Equal 65469 0xffbd +F1 65470 0xffbe +F2 65471 0xffbf +F3 65472 0xffc0 +F4 65473 0xffc1 +F5 65474 0xffc2 +F6 65475 0xffc3 +F7 65476 0xffc4 +F8 65477 0xffc5 +F9 65478 0xffc6 +F10 65479 0xffc7 +L1 65480 0xffc8 +L2 65481 0xffc9 +L3 65482 0xffca +L4 65483 0xffcb +L5 65484 0xffcc +L6 65485 0xffcd +L7 65486 0xffce +L8 65487 0xffcf +L9 65488 0xffd0 +L10 65489 0xffd1 +R1 65490 0xffd2 +R2 65491 0xffd3 +R3 65492 0xffd4 +R4 65493 0xffd5 +R5 65494 0xffd6 +R6 65495 0xffd7 +R7 65496 0xffd8 +R8 65497 0xffd9 +R9 65498 0xffda +R10 65499 0xffdb +R11 65500 0xffdc +R12 65501 0xffdd +F33 65502 0xffde +R14 65503 0xffdf +R15 65504 0xffe0 +Shift_L 65505 0xffe1 +Shift_R 65506 0xffe2 +Control_L 65507 0xffe3 +Control_R 65508 0xffe4 +Caps_Lock 65509 0xffe5 +Shift_Lock 65510 0xffe6 +Meta_L 65511 0xffe7 +Meta_R 65512 0xffe8 +Alt_L 65513 0xffe9 +Alt_R 65514 0xffea +Super_L 65515 0xffeb +Super_R 65516 0xffec +Hyper_L 65517 0xffed +Hyper_R 65518 0xffee +Delete 65535 0xffff +.CE +.SH "SEE ALSO" +bind +.SH KEYWORDS +keysym, bind, binding diff --git a/doc/lower.n b/doc/lower.n index 6e77207..4c404cc 100644 --- a/doc/lower.n +++ b/doc/lower.n @@ -1,36 +1,36 @@ -'\" -*- nroff -*- -'\" -'\" Copyright (c) 1990 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: lower.n,v 1.3 2008/06/30 22:57:03 dkf Exp $ -'\" -.so man.macros -.TH lower n 3.3 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -lower \- Change a window's position in the stacking order -.SH SYNOPSIS -\fBlower \fIwindow \fR?\fIbelowThis\fR? -.BE -.SH DESCRIPTION -.PP -If the \fIbelowThis\fR argument is omitted then the command lowers -\fIwindow\fR so that it is below all of its siblings in the stacking -order (it will be obscured by any siblings that overlap it and -will not obscure any siblings). -If \fIbelowThis\fR is specified then it must be the path name of -a window that is either a sibling of \fIwindow\fR or the descendant -of a sibling of \fIwindow\fR. -In this case the \fBlower\fR command will insert -\fIwindow\fR into the stacking order just below \fIbelowThis\fR -(or the ancestor of \fIbelowThis\fR that is a sibling of \fIwindow\fR); -this could end up either raising or lowering \fIwindow\fR. -.SH "SEE ALSO" -raise -.SH KEYWORDS -lower, obscure, stacking order +'\" -*- nroff -*- +'\" +'\" Copyright (c) 1990 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: lower.n,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH lower n 3.3 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +lower \- Change a window's position in the stacking order +.SH SYNOPSIS +\fBlower \fIwindow \fR?\fIbelowThis\fR? +.BE +.SH DESCRIPTION +.PP +If the \fIbelowThis\fR argument is omitted then the command lowers +\fIwindow\fR so that it is below all of its siblings in the stacking +order (it will be obscured by any siblings that overlap it and +will not obscure any siblings). +If \fIbelowThis\fR is specified then it must be the path name of +a window that is either a sibling of \fIwindow\fR or the descendant +of a sibling of \fIwindow\fR. +In this case the \fBlower\fR command will insert +\fIwindow\fR into the stacking order just below \fIbelowThis\fR +(or the ancestor of \fIbelowThis\fR that is a sibling of \fIwindow\fR); +this could end up either raising or lowering \fIwindow\fR. +.SH "SEE ALSO" +raise +.SH KEYWORDS +lower, obscure, stacking order diff --git a/doc/menubar.n b/doc/menubar.n index bb7c1a8..f7ca645 100644 --- a/doc/menubar.n +++ b/doc/menubar.n @@ -1,38 +1,38 @@ -'\" -*- nroff -*- -'\" -'\" 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: menubar.n,v 1.4 2008/06/30 22:57:03 dkf Exp $ -'\" -.so man.macros -.TH tk_menuBar n "" Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tk_menuBar, tk_bindForTraversal \- Obsolete support for menu bars -.SH SYNOPSIS -\fBtk_menuBar \fIframe \fR?\fImenu menu ...\fR? -.sp -\fBtk_bindForTraversal \fIarg arg ... \fR -.BE -.SH DESCRIPTION -.PP -These procedures were used in Tk 3.6 and earlier releases to help -manage pulldown menus and to implement keyboard traversal of menus. -In Tk 4.0 and later releases they are no -longer needed. Stubs for these procedures have been retained for -backward compatibility, but they have no effect. You should remove -calls to these procedures from your code, since eventually the -procedures will go away. -.PP -From Tk 8.0 onwards, you should instead construct your menubar as a -normal \fBmenu\fR and then attach it to the \fBtoplevel\fR of your -choice using the \fB\-menu\fR option of that widget. -.SH "SEE ALSO" -menu(n), toplevel(n) -.SH KEYWORDS -keyboard traversal, menu, menu bar, post +'\" -*- nroff -*- +'\" +'\" 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: menubar.n,v 1.5 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH tk_menuBar n "" Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +tk_menuBar, tk_bindForTraversal \- Obsolete support for menu bars +.SH SYNOPSIS +\fBtk_menuBar \fIframe \fR?\fImenu menu ...\fR? +.sp +\fBtk_bindForTraversal \fIarg arg ... \fR +.BE +.SH DESCRIPTION +.PP +These procedures were used in Tk 3.6 and earlier releases to help +manage pulldown menus and to implement keyboard traversal of menus. +In Tk 4.0 and later releases they are no +longer needed. Stubs for these procedures have been retained for +backward compatibility, but they have no effect. You should remove +calls to these procedures from your code, since eventually the +procedures will go away. +.PP +From Tk 8.0 onwards, you should instead construct your menubar as a +normal \fBmenu\fR and then attach it to the \fBtoplevel\fR of your +choice using the \fB\-menu\fR option of that widget. +.SH "SEE ALSO" +menu(n), toplevel(n) +.SH KEYWORDS +keyboard traversal, menu, menu bar, post diff --git a/doc/popup.n b/doc/popup.n index a44917c..a59492c 100644 --- a/doc/popup.n +++ b/doc/popup.n @@ -1,49 +1,49 @@ -'\" -*- nroff -*- -'\" -'\" 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: popup.n,v 1.5 2008/06/30 22:57:03 dkf Exp $ -'\" -.so man.macros -.TH tk_popup n 4.0 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tk_popup \- Post a popup menu -.SH SYNOPSIS -\fBtk_popup \fImenu x y \fR?\fIentry\fR? -.BE -.SH DESCRIPTION -.PP -This procedure posts a menu at a given position on the screen and -configures Tk so that the menu and its cascaded children can be -traversed with the mouse or the keyboard. -\fIMenu\fR is the name of a menu widget and \fIx\fR and \fIy\fR -are the root coordinates at which to display the menu. -If \fIentry\fR is omitted or an empty string, the -menu's upper left corner is positioned at the given point. -Otherwise \fIentry\fR gives the index of an entry in \fImenu\fR and -the menu will be positioned so that the entry is positioned over -the given point. -.SH EXAMPLE -.PP -How to attach a simple popup menu to a widget. -.CS -# Create a menu -set m [menu .popupMenu] -$m add command \-label "Example 1" \-command bell -$m add command \-label "Example 2" \-command bell - -# Create something to attach it to -pack [label .l \-text "Click me!"] - -# Arrange for the menu to pop up when the label is clicked -bind .l <1> {\fBtk_popup\fR .popupMenu %X %Y} -.CE -.SH "SEE ALSO" -bind(n), menu(n), tk_optionMenu(n) -.SH KEYWORDS -menu, popup +'\" -*- nroff -*- +'\" +'\" 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: popup.n,v 1.6 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH tk_popup n 4.0 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +tk_popup \- Post a popup menu +.SH SYNOPSIS +\fBtk_popup \fImenu x y \fR?\fIentry\fR? +.BE +.SH DESCRIPTION +.PP +This procedure posts a menu at a given position on the screen and +configures Tk so that the menu and its cascaded children can be +traversed with the mouse or the keyboard. +\fIMenu\fR is the name of a menu widget and \fIx\fR and \fIy\fR +are the root coordinates at which to display the menu. +If \fIentry\fR is omitted or an empty string, the +menu's upper left corner is positioned at the given point. +Otherwise \fIentry\fR gives the index of an entry in \fImenu\fR and +the menu will be positioned so that the entry is positioned over +the given point. +.SH EXAMPLE +.PP +How to attach a simple popup menu to a widget. +.CS +# Create a menu +set m [menu .popupMenu] +$m add command \-label "Example 1" \-command bell +$m add command \-label "Example 2" \-command bell + +# Create something to attach it to +pack [label .l \-text "Click me!"] + +# Arrange for the menu to pop up when the label is clicked +bind .l <1> {\fBtk_popup\fR .popupMenu %X %Y} +.CE +.SH "SEE ALSO" +bind(n), menu(n), tk_optionMenu(n) +.SH KEYWORDS +menu, popup diff --git a/doc/tkerror.n b/doc/tkerror.n index d57acc9..392aaf9 100644 --- a/doc/tkerror.n +++ b/doc/tkerror.n @@ -1,37 +1,37 @@ -'\" -*- nroff -*- -'\" -'\" Copyright (c) 1990-1994 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: tkerror.n,v 1.3 2008/06/30 22:57:03 dkf Exp $ -'\" -.so man.macros -.TH tkerror n 4.1 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tkerror \- Command invoked to process background errors -.SH SYNOPSIS -\fBtkerror \fImessage\fR -.BE -.SH DESCRIPTION -.PP -Note: as of Tk 4.1 the \fBtkerror\fR command has been renamed to -\fBbgerror\fR because the event loop (which is what usually invokes -it) is now part of Tcl. For backward compatibility -the \fBbgerror\fR provided by the current Tk version still -tries to call \fBtkerror\fR if there is one (or an auto loadable one), -so old script defining that error handler should still work, but you -should anyhow modify your scripts to use \fBbgerror\fR instead -of \fBtkerror\fR because that support for the old name might vanish -in the near future. If that call fails, \fBbgerror\fR -posts a dialog showing the error and offering to see the stack trace -to the user. If you want your own error management you should -directly override \fBbgerror\fR instead of \fBtkerror\fR. -Documentation for \fBbgerror\fR is available as part of Tcl's -documentation. -.SH KEYWORDS -background error, reporting +'\" -*- nroff -*- +'\" +'\" Copyright (c) 1990-1994 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: tkerror.n,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH tkerror n 4.1 Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +tkerror \- Command invoked to process background errors +.SH SYNOPSIS +\fBtkerror \fImessage\fR +.BE +.SH DESCRIPTION +.PP +Note: as of Tk 4.1 the \fBtkerror\fR command has been renamed to +\fBbgerror\fR because the event loop (which is what usually invokes +it) is now part of Tcl. For backward compatibility +the \fBbgerror\fR provided by the current Tk version still +tries to call \fBtkerror\fR if there is one (or an auto loadable one), +so old script defining that error handler should still work, but you +should anyhow modify your scripts to use \fBbgerror\fR instead +of \fBtkerror\fR because that support for the old name might vanish +in the near future. If that call fails, \fBbgerror\fR +posts a dialog showing the error and offering to see the stack trace +to the user. If you want your own error management you should +directly override \fBbgerror\fR instead of \fBtkerror\fR. +Documentation for \fBbgerror\fR is available as part of Tcl's +documentation. +.SH KEYWORDS +background error, reporting diff --git a/doc/tkwait.n b/doc/tkwait.n index 33d6426..0ca751c 100644 --- a/doc/tkwait.n +++ b/doc/tkwait.n @@ -1,50 +1,50 @@ -'\" -*- nroff -*- -'\" -'\" 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: tkwait.n,v 1.3 2008/06/30 22:57:03 dkf Exp $ -'\" -.so man.macros -.TH tkwait n "" Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -tkwait \- Wait for variable to change or window to be destroyed -.SH SYNOPSIS -\fBtkwait variable \fIname\fR -.sp -\fBtkwait visibility \fIname\fR -.sp -\fBtkwait window \fIname\fR -.BE -.SH DESCRIPTION -.PP -The \fBtkwait\fR command waits for one of several things to happen, -then it returns without taking any other actions. -The return value is always an empty string. -If the first argument is \fBvariable\fR (or any abbreviation of -it) then the second argument is the name of a global variable and the -command waits for that variable to be modified. -If the first argument is \fBvisibility\fR (or any abbreviation -of it) then the second argument is the name of a window and the -\fBtkwait\fR command waits for a change in its -visibility state (as indicated by the arrival of a VisibilityNotify -event). This form is typically used to wait for a newly-created -window to appear on the screen before taking some action. -If the first argument is \fBwindow\fR (or any abbreviation -of it) then the second argument is the name of a window and the -\fBtkwait\fR command waits for that window to be destroyed. -This form is typically used to wait for a user to finish interacting -with a dialog box before using the result of that interaction. -.PP -While the \fBtkwait\fR command is waiting it processes events in -the normal fashion, so the application will continue to respond -to user interactions. -If an event handler invokes \fBtkwait\fR again, the nested call -to \fBtkwait\fR must complete before the outer call can complete. -.SH KEYWORDS -variable, visibility, wait, window +'\" -*- nroff -*- +'\" +'\" 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: tkwait.n,v 1.4 2008/07/08 22:40:51 patthoyts Exp $ +'\" +.so man.macros +.TH tkwait n "" Tk "Tk Built-In Commands" +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +tkwait \- Wait for variable to change or window to be destroyed +.SH SYNOPSIS +\fBtkwait variable \fIname\fR +.sp +\fBtkwait visibility \fIname\fR +.sp +\fBtkwait window \fIname\fR +.BE +.SH DESCRIPTION +.PP +The \fBtkwait\fR command waits for one of several things to happen, +then it returns without taking any other actions. +The return value is always an empty string. +If the first argument is \fBvariable\fR (or any abbreviation of +it) then the second argument is the name of a global variable and the +command waits for that variable to be modified. +If the first argument is \fBvisibility\fR (or any abbreviation +of it) then the second argument is the name of a window and the +\fBtkwait\fR command waits for a change in its +visibility state (as indicated by the arrival of a VisibilityNotify +event). This form is typically used to wait for a newly-created +window to appear on the screen before taking some action. +If the first argument is \fBwindow\fR (or any abbreviation +of it) then the second argument is the name of a window and the +\fBtkwait\fR command waits for that window to be destroyed. +This form is typically used to wait for a user to finish interacting +with a dialog box before using the result of that interaction. +.PP +While the \fBtkwait\fR command is waiting it processes events in +the normal fashion, so the application will continue to respond +to user interactions. +If an event handler invokes \fBtkwait\fR again, the nested call +to \fBtkwait\fR must complete before the outer call can complete. +.SH KEYWORDS +variable, visibility, wait, window -- cgit v0.12