'\"
'\" Generated from file '' by tcllib/doctools with format 'nroff'
'\"
.TH "tklib" n 0\&.9  "Tk Standard Library"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
.SH NAME
tklib \- Tk Standard Library
.SH DESCRIPTION
A collection of pure-Tcl utility modules and widgets for Tk that provide
a wide variety of functionality\&. The intent is to collect commonly used
functions into a single library, which users can rely on to be available
and stable\&.
.SH MODULES
.TP
\fBautoscroll\fR 1\&.1
Automatic mapping of scrollbars - Provides for a scrollbar to automatically mapped and unmapped as needed
.TP
\fBbitmap-editor\fR 1\&.0
Bitmap handling - Editor for XBM images
.TP
\fBcanvas::drag\fR 0\&.1
Variations on a canvas - Manage the dragging of canvas items or item groups
.TP
\fBcanvas::edit::circle\fR 0\&.1
Variations on a canvas - Editing a circle on a canvas
.TP
\fBcanvas::edit::points\fR 0\&.3
Variations on a canvas - Editing a cloud of points on a canvas
.TP
\fBcanvas::edit::polyline\fR 0\&.2
Variations on a canvas - Editing a polyline on a canvas
.TP
\fBcanvas::edit::quadrilateral\fR 0\&.2
Variations on a canvas - Editing a quadrilateral on a canvas
.TP
\fBcanvas::edit::rectangle\fR 0\&.1
Variations on a canvas - Editing a rectangle on a canvas
.TP
\fBcanvas::gradient\fR 0\&.2
Variations on a canvas - Canvas with a gradient background
.TP
\fBcanvas::highlight\fR 0\&.1
Variations on a canvas - Manage the highlighting of canvas items or item groups
.TP
\fBcanvas::mvg\fR 1\&.0\&.1
Variations on a canvas - Canvas to ImageMagick MVG vector format
.TP
\fBcanvas::pdf\fR 1
Variations on a canvas - Canvas to PDF
.TP
\fBcanvas::snap\fR 1\&.0\&.1
Variations on a canvas - Canvas snapshot to Tk photo image
.TP
\fBcanvas::sqmap\fR 0\&.3\&.1
Variations on a canvas - Canvas with map background based on square tiles
.TP
\fBcanvas::tag\fR 0\&.1
Variations on a canvas - Easier management of the tags on canvas items or item groups
.TP
\fBcanvas::track::lines\fR 0\&.1
Variations on a canvas - Manage a group of rubber band lines
.TP
\fBcanvas::zoom\fR 0\&.2\&.1
Variations on a canvas - Zoom control for canvas::sqmap
.TP
\fBcanvasLabel\fR 6\&.6
canvasLabel class - tkpiechart canvas label class
.TP
\fBchatwidget\fR 1\&.1\&.4
Composite widget for chat applications - Provides a multi-paned view suitable for display of chat room or irc channel information
.TP
\fBcontrolwidget\fR 0\&.1
controlwidget - Collection of widgets for displaying and controlling numerical values
.TP
\fBcrosshair\fR 1\&.2\&.1
Crosshairs - Crosshairs for Tk canvas
.TP
\fBctext\fR 3\&.3
Ctext a text widget with highlighting support - Ctext a text widget with highlighting support
.TP
\fBcursor\fR 0\&.3\&.1
Tk cursor routines - Procedures to handle CURSOR data
.TP
\fBdatefield\fR 0\&.3
Tk datefield widget - Tk datefield widget
.TP
\fBdiagram\fR 0\&.3
Documentation toolbox - Diagram drawing
.TP
\fBdiagram-viewer\fR 1\&.0
Documentation toolbox - Lightweight Diagram Processor
.TP
\fBgetstring\fR 0\&.1
A dialog which prompts for a string input - A string dialog
.TP
\fBhistory\fR 0\&.3
Provides a history for Entry widgets - Provides a history for Entry widgets
.TP
\fBico\fR 1\&.1\&.3
Windows ICO handling - Reading and writing windows icons
.TP
\fBipentry\fR 0\&.3\&.2
An IP address entry widget - An IP address entry widget
.TP
\fBkhim\fR 1\&.0\&.3
Kevin's Hacky Input Method - Provides key bindings for entering international characters on a keyboard that does not support them
.TP
\fBmenubar\fR 0\&.5\&.1
Create and manipulate menubars - Creates an instance of the menubar Class\&.
.TP
\fBnotifywindow\fR 1\&.0\&.1
notifywindow - Provides unobtrusive window for alerts/notifications from Tk applications
.TP
\fBntext\fR 1\&.0
Alternative Bindings for the Text Widget - Alternative Bindings for the Text Widget
.TP
\fBntextBindings\fR 1\&.0
Alternative Bindings for the Text Widget - Alternative Bindings for the Text Widget
.TP
\fBntextIndent\fR 1\&.0
ntext Indentation for the Text Widget - ntext Indentation for the Text Widget
.TP
\fBntextWordBreak\fR 1\&.0
ntext Word Boundary Detection for the Text Widget - ntext Word Boundary Detection for the Text Widget
.TP
\fBpersistentSelection\fR 1\&.0
Enhanced PRIMARY selection - Enhanced PRIMARY selection
.TP
\fBpie\fR 6\&.6
tkpiechart pie class - 2D or 3D pie chart object in a canvas
.TP
\fBpieBoxLabeler\fR 6\&.6
pieBoxLabeler class - tkpiechart pie box style labeler class
.TP
\fBpiePeripheralLabeler\fR 6\&.6
piePeripheralLabeler class - tkpiechart pie peripheral style labeler class
.TP
\fBPlotchart\fR 2\&.6\&.2
Plotchart - Simple plotting and charting package
.TP
\fBshtmlview\fR 1\&.1\&.2
Basic HTML and Markdown viewer widget - Extended Tcl/Tk text widget with basic support for rendering of HTML and Markdown
.TP
\fBshtmlview\fR 1\&.1\&.0
Basic HTML and Markdown viewer - Basic HTML and Markdown viewer application
.TP
\fBshtmlview_doctools\fR 0\&.1
Basic HTML and Markdown viewer widget - shtmlview extension adding support for doctools markup
.TP
\fBshtmlview_mkdoc\fR 0\&.1
Basic HTML and Markdown viewer widget - shtmlview extension adding support for mkdoc markup
.TP
\fBswaplist\fR 0\&.1
A dialog which allows a user to move options between two lists - A dialog which allows a user to move options between two lists
.TP
\fBtipstack\fR 1\&.0\&.1
Tooltip management - Stacked tooltips
.TP
\fBtooltip\fR 2\&.0\&.1
Tooltip management - Tooltip management
.TP
\fBwidget\fR 3\&.2
Various megawidgets - Megawidget bundle
.TP
\fBwidget_calendar\fR 1\&.0\&.2
Various megawidgets - Calendar Megawidget
.TP
\fBwidget_dateentry\fR 0\&.98
Various megawidgets - Date Entry Megawidget
.TP
\fBwidget_listentry\fR 0\&.1\&.2
widget::listentry widget - widget::listentry widget
.TP
\fBwidget_listsimple\fR 0\&.1\&.2
widget::listsimple widget - widget::listsimple widget
.TP
\fBwidget_toolbar\fR 3\&.0
Various megawidgets - Toolbar Megawidget
.TP
\fBwidget_validator\fR 0\&.1
widget::validator behaviour - widget::validator behaviour
.TP
\fBwidgetPlus\fR 1\&.0
Enhanced Entry, Spinbox, and Combobox Widgets with Undo/Redo and other useful features - Enhanced Entry, Spinbox, and Combobox Widgets with Undo/Redo and other useful features
.PP
