Tk Library Source Code

2013-03-25  Andreas Kupries  <[email protected]>

	*
	* Released and tagged Tklib 0.6 ========================
	* 

2012-08-27  Andreas Kupries  <[email protected]>

	* support/installation/modules.tcl: Added the new widgetl module.
	* support/installation/modules.tcl: Added the new widgetv module.

2012-06-21  Andreas Kupries  <[email protected]>

Identifier: tklib
Title:  Tk Standard Library
Description: This package is intended to be a collection of
    Tcl packages that provide utility functions useful to a
    large collection of Tk programmers.
Rights: BSD
Version: 0.6
URL: http://core.tcl.tk/tklib/
Architecture: tcl
Contributor: Aaron Faupell <afaupell at users dot sourceforge dot net>
Contributor: Andreas Kupries <andreas_kupries at users dot sourceforge dot net>
Contributor: Arjen Markus <arjenmarkus at users dot sourceforge dot net>
Contributor: Csaba Nemethi <csaba dot nemethi at t-online dot de>
Contributor: David N. Welton <davidw at dedasys dot com>
Contributor: George Peter Staplin <georgeps at users dot sourceforge dot net>
Contributor: Jean-Luc Fontaine <jfontain at free dot fr>
Contributor: Jeff Hobbs <jeffh at ActiveState dot com>
Contributor: Keith Nash <kjnash at users dot sourceforge dot net>
Contributor: Keith Vetter <keith at ebook dot gemstar dot com>
Contributor: Kevin B. Kenny <kennykb at acm dot org>
Contributor: Kevin Kenny <kennykb at acm dot org>
Contributor: Marty Backe <marty at lucidway dot org>
Contributor: Nemethi <csaba dot nemethi at t-online dot de>
Contributor: Pat Thoyts <patthoyts at users dot sourceforge dot net>
Contributor: Ruediger Haertel <r_haertel at gmx dot de>
Contributor: Rüdiger Härtel <r_haertel at gmx dot de>
Contributor: Torsten Berg <berg at marilim dot de>

RCS: @(#) $Id: README,v 1.3 2003/11/28 22:42:03 andreas_kupries Exp $

Welcome to the tklib, the Tk Standard Library.  This package is
intended to be a collection of Tcl packages that provide utility
functions useful to a large collection of Tcl programmers.

The home web site for this code is http://core.tcl.tk/tklib/ .
At this web site, you will find mailing lists, web forums, databases
for bug reports and feature requests, the CVS repository (browsable on
the web, or read-only accessible via CVS ), and more.

Please note that tklib depends on tcllib, the Tcl Standard Library.
This is true for both installation and runtime.

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/apps/bitmap-editor\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c)
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "bitmap-editor" n 1\&.0 tklib "Bitmap handling"
.BS
.SH NAME
bitmap-editor \- Editor for XBM images
.SH SYNOPSIS
\fBbitmap-editor\fR ?\fIxbmfile\fR?
.sp
.BE
.SH DESCRIPTION
.PP
The application described by this document, \fBbitmap-editor\fR, is
a simple editor for XBM based bitmap images\&.
Written by Keith Vetter the original code can be found at
\fIhttp://wiki\&.tcl\&.tk/6298\fR\&.
.SS "COMMAND LINE"
.TP
\fBbitmap-editor\fR ?\fIxbmfile\fR?
Invoked without argument the editor GUI will be opened and show a
standard bitmap to edit\&. Invoked with an argument it is expected to be
the path to a bitmap file in XBM format, and the contained bitmap is
shown\&.
.RS
.TP
path \fIxbmfile\fR (in/out)
This argument specifies the path to a bitmap file in XBM format, whose
contents is to shown and edited by the application\&.
.RE
.sp
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the application it describes, will undoubtedly
contain bugs and other problems\&.
Please report such in the category \fIbitmap\fR of the
\fITcllib SF Trackers\fR [http://sourceforge\&.net/tracker/?group_id=12883]\&.
Please also report any ideas for enhancements you may have for either
application and/or documentation\&.
.SH KEYWORDS
bitmap, editor, image, pixel, xbm
.SH CATEGORY
Image processing
.SH COPYRIGHT
.nf
Copyright (c)

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/apps/dia\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2010 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "dia" n 1\&.0 tklib "Documentation toolbox"
.BS
.SH NAME
dia \- Lightweight Diagram Processor
.SH SYNOPSIS
\fBdia\fR \fBshow\fR \fIinputfile\fR\&.\&.\&.
.sp
\fBdia\fR \fBconvert\fR \fB-o\fR \fIoutput\fR \fIformat\fR \fIinputfile\fR\&.\&.\&.
.sp
.BE
.SH DESCRIPTION
.PP
The application described by this document, \fBdia\fR, is a
lightweight processor for tklib diagram files
.PP
\fBdia\fR is based upon the package \fBdiagram\fR\&.
See it for examples and language reference\&.
.SS "USE CASES"
\fBdia\fR was written with the following two use cases in
mind\&.
.PP
.IP [1]
Processing and display of one or more diagram files\&.
.IP [2]
Batch conversion of one or more diagram files into raster image files\&.
.PP
.PP
.SS "COMMAND LINE"
.TP
\fBdia\fR \fBshow\fR \fIinputfile\fR\&.\&.\&.
This is the form for use case [1]\&. The application opens a gui
showing the list of input files to the left, allowing the user to
choose which of them to render to the canvas on the right\&.
.TP
\fBdia\fR \fBconvert\fR \fB-o\fR \fIoutput\fR \fIformat\fR \fIinputfile\fR\&.\&.\&.
This is the form for use case [2]\&. The application converts
the input files into raster image of the specified \fIformat\fR\&.
.RS
.TP
path \fIoutput\fR (in)
This argument specifies where to write the generated image\&. It can
be the path to a file or directory\&.
.sp
If the \fIoutput\fR does not exist then [file dirname $output]
has to exist and must be a writable directory\&.
.sp
In case of multiple input files the generated image will be written to
a file in the directory, and the name of that file will be derived
from the \fIinputfile\fR, and \fIformat\fR\&.
.sp
In case of a single input file the generated image will be written to
the file\&.
.TP
(handle) \fIformat\fR (in)
This argument specifies the image format to convert the diagrams into
when processing the input\&. The application recognizes all formats
supported by the \fBImg\fR package, i\&.e\&. for which it can load a
package \fBimg::\fBformat\fR\fR
.TP
path \fIinputfile\fR (in)
This argument specifies the path to the diagram file to process\&. It
has to exist, must be readable, and written in \fIdiagram\fR format\&.
.RE
.sp
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the application it describes, will undoubtedly
contain bugs and other problems\&.
Please report such in the category \fIdiagram\fR of the
\fITcllib SF Trackers\fR [http://sourceforge\&.net/tracker/?group_id=12883]\&.
Please also report any ideas for enhancements you may have for either
application and/or documentation\&.
.SH KEYWORDS
canvas, conversion, diagram, vector
.SH CATEGORY
Documentation tools
.SH COPYRIGHT
.nf
Copyright (c) 2010 Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/autoscroll/autoscroll\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "autoscroll" n 1\&.1 tklib "Automatic mapping of scrollbars"
.BS
.SH NAME
autoscroll \- Provides for a scrollbar to automatically mapped and unmapped as needed
.SH SYNOPSIS
package require \fBTcl \fR
.sp
package require \fBautoscroll  ?1\&.1?\fR
.sp
\fB::autoscroll::autoscroll\fR \fIscrollbar\fR
.sp
\fB::autoscroll::unautoscroll\fR \fIscrollbar\fR
.sp
\fB::autoscroll::wrap\fR
.sp
\fB::autoscroll::unwrap\fR
.sp
.BE
.SH DESCRIPTION
This package allows scrollbars to be mapped and
unmapped as needed depending on the size and
content of the scrollbars scrolled widget\&. The
scrollbar must be managed by either pack or grid,
other geometry managers are not supported\&.
.PP
When managed by pack, any geometry changes made in the
scrollbars parent between the time a scrollbar is
unmapped, and when it is mapped will be lost\&. It is
an error to destroy any of the scrollbars siblings while the
scrollbar is unmapped\&. When managed by grid, if anything
becomes gridded in the same row and column the scrollbar
occupied it will be replaced by the scrollbar when remapped\&.
.PP
This package may be used on any scrollbar-like widget
as long as it supports the \fBset\fR subcommand in the same
style as scrollbar\&. If the \fBset\fR subcommand is not used
then this package will have no effect\&.
.PP
.TP
\fB::autoscroll::autoscroll\fR \fIscrollbar\fR
Arranges for the already existing scrollbar \fBscrollbar\fR
to be mapped and unmapped as needed\&.
.TP
\fB::autoscroll::unautoscroll\fR \fIscrollbar\fR
Returns the named scrollbar to its original static state\&.
.TP
\fB::autoscroll::wrap\fR
Arranges for all scrollbars created after this command is run
to be automatically mapped and unmapped as needed\&.
.TP
\fB::autoscroll::unwrap\fR
Turns off the automatic autoscrolling of all new scrollbars\&.
Does not effect existing scrollbars
.PP
.CS


text \&.t -yscrollcommand "\&.scrolly set"
scrollbar \&.scrolly -orient v -command "\&.t yview"
pack \&.scrolly -side right -fill y
pack \&.t -side left -fill both -expand 1
::autoscroll::autoscroll \&.scrolly

.CE
.SH KEYWORDS
scroll, scrollbar

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_drag\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::drag" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::drag \- Manage the dragging of canvas items or item groups
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::drag  ?0\&.1?\fR
.sp
\fB::canvas::drag\fR \fBon\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR \fIoption\fR\&.\&.\&.
.sp
\fB::canvas::drag\fR \fBoff\fR \fIcanvas\fR \fItagOrId\fR
.sp
\fB::canvas::drag\fR \fBitem\fR \fIcanvas\fR \fItagOrId\fR \fIoption\fR\&.\&.\&.
.sp
\fB::canvas::drag\fR \fBgroup\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR \fIoption\fR\&.\&.\&.
.sp
\fB{*}cmd\fR \fBstart\fR \fIcanvas\fR \fIitem\fR
.sp
\fB{*}cmd\fR \fBmove\fR \fIcanvas\fR \fIclientdata\fR \fIdx\fR \fIdy\fR
.sp
\fB{*}cmd\fR \fBdone\fR \fIcanvas\fR \fIclientdata\fR
.sp
.BE
.SH DESCRIPTION
This package provides utility commands to setup and rmeove dragging of
items or item groups on a canvas, hiding all complexity regarding
bindings from the user\&.
.SH API
.TP
\fB::canvas::drag\fR \fBon\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR \fIoption\fR\&.\&.\&.
This command initializes item dragging on the \fIcanvas\fR widget,
with the items used as drag handles identified by \fItagOrId\fR\&.
The command prefix \fIcmd\fR, invoked for drag start and movement, is
responsible for the initialization and actual execution of the drag
operation\&.
.sp
The signature of the command prefix is described later, in
section \fBDrag callback\fR\&.
.sp
Similarly, the accepted options and their values are described
in section \fBOptions\fR
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::drag\fR \fBoff\fR \fIcanvas\fR \fItagOrId\fR
This command removes any drag operation set on the items of canvas
\fIcanvas\fR identified by \fItagOrId\fR\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::drag\fR \fBitem\fR \fIcanvas\fR \fItagOrId\fR \fIoption\fR\&.\&.\&.
This is a convenience command wrapped around method \fBon\fR (see above)
to drag single items of the \fIcanvas\fR widget, identified by \fItagOrId\fR\&.
.sp
It uses an internal standard callback for this\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::drag\fR \fBgroup\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR \fIoption\fR\&.\&.\&.
This is a convenience command wrapped around method \fBon\fR (see above)
to drag single items of the \fIcanvas\fR widget, identified by \fItagOrId\fR\&.
.sp
It uses an internal standard callback for this\&. The callback
\fIcmd\fR specified has the same signature as the \fBDrag callback\fR,
except that
.RS
.IP [1]
The \fBmove\fR method is not invoked\&.
.IP [2]
The result of the \fBstart\fR method \fIhas to be\fR a
canvas tag refering to the whole group of items to move\&. In other words,
it must convert from drag handle (item id) to dragged groupt (tag)\&.
.RE
.sp
The result of the command is the empty string\&.
.PP
.SS "DRAG CALLBACK"
The drag callback is a command prefix invoked in the following two
ways:
.TP
\fB{*}cmd\fR \fBstart\fR \fIcanvas\fR \fIitem\fR
This form is invoked when has initiated dragging using drag handle
identified by the canvas \fIitem\fR id\&.
The callback now has to perform anything necessary for its type of
drag operation\&.
.sp
The result of the command can be anything\&. It is stored by the
system as client information and passed unchanged to the movement
callback for its use\&. In this manner the drag callback is able to
maintain custom state from start to movement\&.
.TP
\fB{*}cmd\fR \fBmove\fR \fIcanvas\fR \fIclientdata\fR \fIdx\fR \fIdy\fR
This form is invoked when the mouse moved during a drag operation\&.
It is invoked with the client data from the start callback (or the
previous move callback) and the distances the mouse has traveled in
horizontal and vertical directions\&.
.sp
The result of the command can be anything\&. It is stored by the
system as client information and passed unchanged to the next movement
callback for its use\&. In this manner the drag callback is able to
maintain custom state from movement to movement\&.
.TP
\fB{*}cmd\fR \fBdone\fR \fIcanvas\fR \fIclientdata\fR
This form is invoked when the drag operation ends\&.
It is invoked with the client data from the last movement callback (or
start callback if there had been no motion)\&.
.sp
The result of the command is ignored\&.
.PP
.SS OPTIONS
The commands to create drag operations (\fBon\fR, \fBitem\fR,
and \fBgroup\fR) all accept the following options to configure the
new drag\&.
.TP
\fB-event\fR \fIspec\fR
The value of this option specifies the mouse button used to initiate
the drag operation, and the keyboard modifier, if any\&. Examples of
specifications:
.sp
To initiate a drag operation by pressing mouse button 3 on a
drag handle, use:
.CS

 -event 3
.CE
.IP
This is the default as well, if the option is not specified\&.
.sp
To initiate a drag operation by pressing mouse button 2 on a
drag handle while holding down the Control key, use:
.CS

 -event Control-2
.CE
.PP
.SH KEYWORDS
canvas, dragging

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_epoints\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::edit::points" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::edit::points \- Editing a cloud of points on a canvas
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::edit::points  ?0\&.1?\fR
.sp
\fB::canvas::edit\fR \fBpoints\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
.sp
\fBobjectName\fR \fBdestroy\fR
.sp
\fBobjectName\fR \fBenable\fR
.sp
\fBobjectName\fR \fBdisable\fR
.sp

\fBdataCmd\fR \fBmove delta\fR \fIeditorObj\fR \fIid\fR \fIx\fR \fIy\fR \fIdx\fR \fIdy\fR
.sp
\fBdataCmd\fR \fBmove done\fR \fIeditorObj\fR \fIid\fR
.sp
.BE
.SH DESCRIPTION
This package provides a class whose instances handle editing a cloud
of point markers on a canvas\&. Instances can be configured with regard
to the visual appearance of markers (regular, and highlighted)\&. Note
that instances do not store the edited points themselves, but delegate
this to a configurable object\&.
.SH "CLASS API"
.TP
\fB::canvas::edit\fR \fBpoints\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
This, the class command, creates and configures a new instance of a
point cloud editor, named \fIobjectName\fR\&. The instance will be
connected to the specified \fIcanvas\fR widget\&.
.sp
The result of the command is the fully qualified name of the
instance command\&.
.sp
The options accepted here, and their values, are explained in
the section \fBOptions\fR\&.
.PP
.SH "INSTANCE API"
Instances of the point cloud editors provide the following API:
.TP
\fBobjectName\fR \fBdestroy\fR
This method destroys the point cloud editor and releases all its
internal resources\&.
.sp
Note that this operation does not destroy the items of the
point markers the editor managed on the attached canvas, nor the
canvas itself\&.
.sp
The result of the method is an empty string\&.
.TP
\fBobjectName\fR \fBenable\fR
This method activates editing of the point cloud on the canvas\&. This
is the default after instance creation\&. A call is ignored if the
editor is already active\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBdisable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBdisable\fR
This method disables editing of the point cloud on the canvas\&. A call
is ignored if the editor is already disabled\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBenable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBactive\fR
This method queries the editor state\&.
.sp
The result of the method is a boolean value, \fBtrue\fR if
the editor is active, and \fBfalse\fR otherwise, i\&.e\&. disabled\&.
.sp
The methods to change the state are \fBenable\fR and
\fBdisable\fR\&.
.TP
\fBobjectName\fR \fBadd\fR \fIx\fR \fIy\fR
This method programmatically creates a point at the specified location\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the whole set of callbacks
invoked when the user interactively creates a point, i\&.e\&.
\fB-create-cmd\fR, and, more importantly, \fB-data-cmd\fR\&.
.sp
This is the method through which to load pre-existing points
into an editor instance\&.
.TP
\fBobjectName\fR \fBclear\fR
This method programmatically removes all points from the editor\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the same callback invoked
when the user interactively removes a point, i\&.e\&. \fB-data-cmd\fR\&.
.PP
.SH OPTIONS
The class command accepts the following options
.TP
\fB-tag\fR \fIstring\fR
The value of this option is the name of the canvas tag with which to
identify all items of all points managed by the editor\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to \fBPOINT\fR
.TP
\fB-create-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to create a new point\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will create a
black-bordered blue circle of radius 3 centered on the location of the
new point\&.
.sp
The signature of this command prefix is
.RS
.TP
\fBcreateCmd\fR \fIcanvas\fR \fIx\fR \fIy\fR
The result of the command prefix \fImust\fR be a list of the canvas
items it created to represent the marker\&. Note here that the visual
representation of a "point" may consist of multiple canvas items in an
arbitrary shape\&.
.sp
The returned list of items is allowed to be empty, and such is
taken as signal that the callback vetoed the creation of the point\&.
.RE
.TP
\fB-highlight-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to (un)highlight a point\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will re-color
the item to highlight in red (and restores the color for
unhighlighting)\&.
.sp
The two signatures of this command prefix are
.RS
.TP
\fBhighlightCmd\fR \fBon\fR \fIcanvas\fR \fIitem\fR
.sp
This method of the command prefix has to perform whatever is
needed to highlight the point the \fIitem\fR is a part of (remember
the note above about points allowed to be constructed from multiple
canvas items)\&.
.sp
The result of the command can be anything and will be passed as
is as argument \fIstate\fR to the \fBoff\fR method\&.
.TP
\fBhighlightCmd\fR \fBoff\fR \fIcanvas\fR \fIstate\fR
.sp
This method is invoked to unhighlight a point described by the
\fIstate\fR, which is the unchanged result of the \fBon\fR method
of the command prefix\&. The result of this method is ignored\&.
.sp
Note any interaction between dragging and highlighting of
points is handled within the editor, and that the callback bears no
responsibility for doing such\&.
.RE
.TP
\fB-data-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when a point was edited in some way\&. This is how the editor delegates
the actual storage of point information to an outside object\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to an empty string and is ignored
by the editor, i\&.e\&. not invoked\&.
.sp
The signatures of this command prefix are
.RS
.TP
\fBdataCmd\fR \fBadd\fR \fIeditorObj\fR \fIid\fR \fIx\fR \fIy\fR
This callback is invoked when a new point was added to the instance,
either interactively, or programmatically\&.
See instance method \fBadd\fR for the latter\&.
.sp
The \fIid\fR identifies the point within the editor and will be
used by the two other callbacks to specify which point to modify\&.
.sp
The last two arguments \fIx\fR and \fIy\fR specify the location
of the new point in canvas coordinates\&.
.sp
The result of this method is ignored\&.
.TP
\fBdataCmd\fR \fBremove\fR \fIeditorObj\fR \fIid\fR
This callback is invoked when a point removed from the editor
instance\&.
.sp
The \fIid\fR identifies the removed point within the editor\&.
.sp
The result of this method is ignored\&.
.TP
\fBdataCmd\fR \fBmove start\fR \fIeditorObj\fR \fIid\fR
This callback is invoked when the movement of a point in the editor
instance has started\&.
.sp
The \fIid\fR identifies the point within the editor about to be
moved\&.
.sp
The result of this method is ignored\&.
.TP
\fBdataCmd\fR \fBmove delta\fR \fIeditorObj\fR \fIid\fR \fIx\fR \fIy\fR \fIdx\fR \fIdy\fR
This callback is invoked when the point moved in the editor instance\&.
.sp
The \fIid\fR identifies the moved point within the editor, and
the remaining arguments \fIx\fR, \fIy\fR, \fIdx\fR, and \fIdy\fR
provide the new absolute location of the point, and full delta to the
original location\&.
.sp
At the time of the calls the system is \fInot\fR committed to
the move yet\&. Only after method \fBmove done\fR was invoked and
has accepted or rejected the last position will the editor update its
internal data structures, either committing to the new location, or
rolling the move back to the original one\&.
.sp
Given this the location data provided here should be saved only
in temporary storage until then\&.
.sp
The result of this method is ignored\&.
.TP
\fBdataCmd\fR \fBmove done\fR \fIeditorObj\fR \fIid\fR
This callback is invoked when the movement of a point in the editor
instance is complete\&.
.sp
The \fIid\fR identifies the moved point within the editor\&.
.sp
The result of this method must be a boolean value\&. If the
method returns \fBfalse\fR the move is vetoed and rollbed back\&.
.RE
.PP
.SH KEYWORDS
canvas, editing, point cloud, points

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_epolyline\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::edit::polyline" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::edit::polyline \- Editing a polyline on a canvas
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::edit::points  ?0\&.1?\fR
.sp
package require \fBcanvas::edit::polyline  ?0\&.1?\fR
.sp
\fB::canvas::edit\fR \fBpolyline\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
.sp
\fBobjectName\fR \fBdestroy\fR
.sp
\fBobjectName\fR \fBenable\fR
.sp
\fBobjectName\fR \fBdisable\fR
.sp

\fBhighlightCmd\fR \fBoff\fR \fIcanvas\fR \fIstate\fR
.sp
\fBdataCmd\fR \fIeditorObj\fR \fIcoordinates\fR
.sp
.BE
.SH DESCRIPTION
This package provides a class whose instances handle editing a single
poly-line on a canvas\&. Instances can be configured with regard to the
visual appearance (regular, and highlighted) of the markers denoting
the line's vertices\&. Note that instances do not store the edited
polyline themselves, but delegate this to a configurable object\&.
.SH "CLASS API"
.TP
\fB::canvas::edit\fR \fBpolyline\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
This, the class command, creates and configures a new instance of a
polyline editor, named \fIobjectName\fR\&. The instance will be
connected to the specified \fIcanvas\fR widget\&.
.sp
The result of the command is the fully qualified name of the
instance command\&.
.sp
The options accepted here, and their values, are explained in
the section \fBOptions\fR\&.
.PP
.SH "INSTANCE API"
Instances of the polyline editors provide the following API:
.TP
\fBobjectName\fR \fBdestroy\fR
This method destroys the polyline editor and releases all its
internal resources\&.
.sp
Note that this operation does not destroy the items the editor
managed on the attached canvas, nor the canvas itself\&.
.sp
The result of the method is an empty string\&.
.TP
\fBobjectName\fR \fBenable\fR
This method activates editing of the polyline on the canvas\&. This
is the default after instance creation\&. A call is ignored if the
editor is already active\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBdisable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBdisable\fR
This method disables editing of the polyline on the canvas\&. A call
is ignored if the editor is already disabled\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBenable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBactive\fR
This method queries the editor state\&.
.sp
The result of the method is a boolean value, \fBtrue\fR if
the editor is active, and \fBfalse\fR otherwise, i\&.e\&. disabled\&.
.sp
The methods to change the state are \fBenable\fR and
\fBdisable\fR\&.
.TP
\fBobjectName\fR \fBadd\fR \fIx\fR \fIy\fR
This method programmatically adds a vertex at the specified location to the line\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the whole set of callbacks
invoked when the user interactively creates a vertex, i\&.e\&.
\fB-create-cmd\fR, and, more importantly, \fB-data-cmd\fR\&.
.sp
One important difference however\&. The new vertex is always added
at the end of the line, whereas interactive creation uses heuristics
to splice it into the line at a suitable location\&.
.sp
This is the method through which to load the vertices of a
pre-existing line into an editor instance\&.
.TP
\fBobjectName\fR \fBclear\fR
This method programmatically removes all vertices from the editor,
essentially removing the whole line\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the same callbacks invoked
when the user interactively removes a vertex, i\&.e\&. \fB-data-cmd\fR\&.
.PP
.SH OPTIONS
The class command accepts the following options
.TP
\fB-tag\fR \fIstring\fR
The value of this option is the name of the canvas tag with which to
identify all items of all vertices managed by the editor\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to \fBPOLYLINE\fR
.TP
\fB-create-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to create a new vertex\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will create a
black-bordered blue circle of radius 3 centered on the location of the
new point\&.
.sp
The signature of this command prefix is
.RS
.TP
\fBcreateCmd\fR \fIcanvas\fR \fIx\fR \fIy\fR
The result of the command prefix \fImust\fR be a list of the canvas
items it created to represent the marker\&. Note here that the visual
representation of a "vertex" may consist of multiple canvas items in
an arbitrary shape\&.
.sp
The returned list of items is allowed to be empty, and such is
taken as signal that the callback vetoed the creation of the vertex\&.
.RE
.TP
\fB-highlight-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to (un)highlight a vertex\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will re-color
the item to highlight in red (and restores the color for
unhighlighting)\&.
.sp
The two signatures of this command prefix are
.RS
.TP
\fBhighlightCmd\fR \fBon\fR \fIcanvas\fR \fIitem\fR
.sp
This method of the command prefix has to perform whatever is
needed to highlight the vertex the \fIitem\fR is a part of (remember
the note above about points allowed to be constructed from multiple
canvas items)\&.
.sp
The result of the command can be anything and will be passed as
is as argument \fIstate\fR to the \fBoff\fR method\&.
.TP
\fBhighlightCmd\fR \fBoff\fR \fIcanvas\fR \fIstate\fR
.sp
This method is invoked to unhighlight a vertex described by the
\fIstate\fR, which is the unchanged result of the \fBon\fR method
of the command prefix\&. The result of this method is ignored\&.
.sp
Note any interaction between dragging and highlighting of
vertices is handled within the editor, and that the callback bears no
responsibility for doing such\&.
.RE
.TP
\fB-data-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when the line was edited in some way (vertex added, removed,
moved)\&. This is how the editor delegates the actual storage of the
line information to an outside object\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to an empty string and is ignored
by the editor, i\&.e\&. not invoked\&.
.sp
The signature of this command prefix is
.RS
.TP
\fBdataCmd\fR \fIeditorObj\fR \fIcoordinates\fR
This callback is invoked when the line was changed either interactively,
or programmatically\&.
See instance method \fBadd\fR for the latter\&.
.sp
The \fIeditorObj\fR identifies the instance invoking the
callback, whereas \fIcoordinates\fR is a list of vertex locations,
with each location a pair of x- and y-coordinates\&.
.sp
The result of this method is ignored\&.
.RE
.PP
.SH KEYWORDS
canvas, editing, polyline

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_equad\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::edit::quadrilateral" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::edit::quadrilateral \- Editing a quadrilateral on a canvas
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::edit::points  ?0\&.1?\fR
.sp
package require \fBcanvas::edit::quadrilateral  ?0\&.1?\fR
.sp
\fB::canvas::edit\fR \fBquadrilateral\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
.sp
\fBobjectName\fR \fBdestroy\fR
.sp
\fBobjectName\fR \fBenable\fR
.sp
\fBobjectName\fR \fBdisable\fR
.sp

\fBhighlightCmd\fR \fBoff\fR \fIcanvas\fR \fIstate\fR
.sp
\fBdataCmd\fR \fIeditorObj\fR \fIcoordinates\fR
.sp
.BE
.SH DESCRIPTION
This package provides a class whose instances handle the editing of a
quadrilateral on a canvas\&. Instances can be configured with regard to
the visual appearance (regular, and highlighted) of vertex
markers\&. Note that instances do not store the edited quadrilateral
themselves, but delegate this to a configurable object\&.
.SH "CLASS API"
.TP
\fB::canvas::edit\fR \fBquadrilateral\fR \fIobjectName\fR \fIcanvas\fR \fIoptions\fR\&.\&.\&.
This, the class command, creates and configures a new instance of a
quadrilateral editor, named \fIobjectName\fR\&. The instance will be
connected to the specified \fIcanvas\fR widget\&.
.sp
The result of the command is the fully qualified name of the
instance command\&.
.sp
The options accepted here, and their values, are explained in
the section \fBOptions\fR\&.
.PP
.SH "INSTANCE API"
Instances of the quadrilateral editors provide the following API:
.TP
\fBobjectName\fR \fBdestroy\fR
This method destroys the quadrilateral editor and releases all its
internal resources\&.
.sp
Note that this operation does not destroy the items the editor
managed on the attached canvas, nor the canvas itself\&.
.sp
The result of the method is an empty string\&.
.TP
\fBobjectName\fR \fBenable\fR
This method activates editing of the quadrilateral on the canvas\&. This
is the default after instance creation\&. A call is ignored if the
editor is already active\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBdisable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBdisable\fR
This method disables editing of the quadrilateral on the canvas\&. A call
is ignored if the editor is already disabled\&.
.sp
The result of the method is an empty string\&.
.sp
The complementary method is \fBenable\fR\&. The interogatory
method for the current state is \fBactive\fR\&.
.TP
\fBobjectName\fR \fBactive\fR
This method queries the editor state\&.
.sp
The result of the method is a boolean value, \fBtrue\fR if
the editor is active, and \fBfalse\fR otherwise, i\&.e\&. disabled\&.
.sp
The methods to change the state are \fBenable\fR and
\fBdisable\fR\&.
.TP
\fBobjectName\fR \fBadd\fR \fIx\fR \fIy\fR
This method programmatically adds a vertex at the specified location
to the quadrilateral\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the whole set of callbacks
invoked when the user interactively creates a vertex, i\&.e\&.
\fB-create-cmd\fR, and, more importantly, \fB-data-cmd\fR\&.
.sp
This is the method through which to load the vertices of a
pre-existing quadrilateral into an editor instance\&.
.sp
Note that at most 4 vertices can be specified, and at least 4
must be specified for the quadrilateral to be complete\&.
.TP
\fBobjectName\fR \fBclear\fR
This method programmatically unset the quadrilateral in the editor\&.
.sp
The result of the method is an empty string\&.
.sp
Note that this method goes through the same callback invoked
when the user interactively removes a vertex, i\&.e\&. \fB-data-cmd\fR\&.
.PP
.SH OPTIONS
The class command accepts the following options
.TP
\fB-convex\fR \fIboolean\fR
The value of this option is a boolean flag\&. When the flag is set the
editor will accept only convex quadrilaterals and reject all
operations which would result in a violation of convexity\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to \fBfalse\fR, i\&.e\&. acceptance
of any quadrilateral\&.
.TP
\fB-tag\fR \fIstring\fR
The value of this option is the name of the canvas tag with which to
identify all items of all quadrilateral managed by the editor\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to \fBQUADRILATERAL\fR
.TP
\fB-create-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to create a new vertex\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will create a
black-bordered blue circle of radius 3 centered on the location of the
new point\&.
.sp
The signature of this command prefix is
.RS
.TP
\fBcreateCmd\fR \fIcanvas\fR \fIx\fR \fIy\fR
The result of the command prefix \fImust\fR be a list of the canvas
items it created to represent the marker\&. Note here that the visual
representation of a "vertex" may consist of multiple canvas items in an
arbitrary shape\&.
.RE
.TP
\fB-highlight-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when it has to (un)highlight a vertex\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to a command which will re-color
the item to highlight in red (and restores the color for
unhighlighting)\&.
.sp
The two signatures of this command prefix are
.RS
.TP
\fBhighlightCmd\fR \fBon\fR \fIcanvas\fR \fIitem\fR
.sp
This method of the command prefix has to perform whatever is
needed to highlight the vertex the \fIitem\fR is a part of (remember
the note above about quadrilateral allowed to be constructed from multiple
canvas items)\&.
.sp
The result of the command can be anything and will be passed as
is as argument \fIstate\fR to the \fBoff\fR method\&.
.TP
\fBhighlightCmd\fR \fBoff\fR \fIcanvas\fR \fIstate\fR
.sp
This method is invoked to unhighlight a vertex described by the
\fIstate\fR, which is the unchanged result of the \fBon\fR method
of the command prefix\&. The result of this method is ignored\&.
.sp
Note any interaction between dragging and highlighting of
quadrilateral is handled within the editor, and that the callback bears no
responsibility for doing such\&.
.RE
.TP
\fB-data-cmd\fR \fIcommand-prefix\fR
The value of this option is a command prefix the editor will invoke
when the quadrilateral was edited in some way\&. This is how the editor
delegates the actual storage of quadrilateral information to an
outside object\&.
.sp
This option can only be set at construction time\&.
.sp
If not specified it defaults to an empty string and is ignored
by the editor, i\&.e\&. not invoked\&.
.sp
The signatures of this command prefix are
.RS
.TP
\fBdataCmd\fR \fIeditorObj\fR \fIcoordinates\fR
This callback is invoked when the quarilateral was changed either
interactively, or programmatically\&.
See instance method \fBadd\fR for the latter\&.
.sp
The \fIeditorObj\fR identifies the instance invoking the
callback, whereas \fIcoordinates\fR is a list of vertex locations,
with each location a pair of x- and y-coordinates\&.
.sp
The result of this method is ignored\&.
.RE
.PP
.SH KEYWORDS
canvas, concave, convex, editing, non-convex, quadrilateral

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_highlight\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::highlight" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::highlight \- Manage the highlighting of canvas items or item groups
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::highlight  ?0\&.1?\fR
.sp
\fB::canvas::highlight\fR \fBon\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR
.sp
\fB::canvas::highlight\fR \fBoff\fR \fIcanvas\fR \fItagOrId\fR
.sp
\fB{*}cmd\fR \fBon\fR \fIcanvas\fR \fIitem\fR
.sp
\fB{*}cmd\fR \fBoff\fR \fIcanvas\fR \fIclientdata\fR
.sp
.BE
.SH DESCRIPTION
This package provides utility commands for setting up and tearing down
of highlights for canvas items or item groups, the latter identified
by a tag\&.
.SH API
.TP
\fB::canvas::highlight\fR \fBon\fR \fIcanvas\fR \fItagOrId\fR \fIcmd\fR
This command sets up a general highlight, with the items of canvas
\fIcanvas\fR to highlight in this manner identified by \fItagOrId\fR
and the \fIcmd\fR prefix providing the implementation, i\&.e\&. the how to
perform the highlight\&.
.sp
The signature of the command prefix is described later, in
section \fBHighlight callback\fR\&.
.sp
The result of the command is the empty string\&.
.sp
Limitations:
.RS
.IP [1]
When a highlight is active no other highlight can be activated\&.
This means that nested highlights are not possible\&.
.IP [2]
The system may break if a highlight is removed from within its
highlight callback\&.
.RE
.TP
\fB::canvas::highlight\fR \fBoff\fR \fIcanvas\fR \fItagOrId\fR
This command removes any highlight set on the items of canvas
\fIcanvas\fR identified by \fItagOrId\fR\&.
.sp
The result of the command is the empty string\&.
.PP
.SS "HIGHLIGHT CALLBACK"
The highlight callback is a command prefix invoked in the following
two ways:
.TP
\fB{*}cmd\fR \fBon\fR \fIcanvas\fR \fIitem\fR
This form is invoked when the mouse has entered (one of) the item(s)
the highlight was set up for\&. The callback now has to perform any
reconfiguration necessary to highlight the item (group)\&.
.sp
The result of the command can be anything\&. It is stored by the
system as client information and passed unchanged to the un-highlight
callback for its use\&. In this manner the highlight callback is able to
maintain custom state from highlighting to un-highlighting\&.
.sp
Note that the callback does not have to maintain state, nor
does it have to actually reconfigure the item (group)\&. In the latter
case the callback simply serves as easy enter/leave notification\&.
.TP
\fB{*}cmd\fR \fBoff\fR \fIcanvas\fR \fIclientdata\fR
This form is invoked when the mouse has left (one of) the item(s) of
the currently active the highlight\&. The callback now has to perform
any reconfiguration necessary to un-highlight the item (group)\&.
.sp
The result of the command must be a boolean value with the
usual value to be \fBtrue\fR\&. By returning \fBfalse\fR instead the
callback can veto the removal of the highlight\&.
.PP
.SH KEYWORDS
canvas, enter callback, highlighting, leave callback

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_mvg\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2010 Wolf-Dieter Busch (http://wiki\&.tcl\&.tk/15505)
'\" Copyright (c) 2010 Documentation, Andreas Kupries
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::mvg" n 1\&.0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::mvg \- Canvas to ImageMagick MVG vector format
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::mvg  ?1?\fR
.sp
\fB::canvas::mvg\fR \fIpathName\fR
.sp
.BE
.SH DESCRIPTION
This package provides a command to convert a canvas' contents to
ImageMagick's MVG vector format\&.
.SH API
.TP
\fB::canvas::mvg\fR \fIpathName\fR
Dump the contents of the canvas \fIpathName\fR\&. The result is a string
in ImageMagick's MVG vector format\&.
.PP
.SH KEYWORDS
canvas, graphics, imagemagick, magick vector graphics, mvg, print screen, serialization, vector graphics
.SH COPYRIGHT
.nf
Copyright (c) 2010 Wolf-Dieter Busch (http://wiki\&.tcl\&.tk/15505)
Copyright (c) 2010 Documentation, Andreas Kupries

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_snap\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2004 George Petasis (http://wiki\&.tcl\&.tk/1404)
'\" Copyright (c) 2010 Documentation, Andreas Kupries
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::snap" n 1\&.0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::snap \- Canvas snapshot to Tk photo image
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::snap  ?1\&.0\&.1?\fR
.sp
package require \fBimg::window \fR
.sp
\fB::canvas::snap\fR \fIpathName\fR
.sp
.BE
.SH DESCRIPTION
This package provides a command to take snapshots of arbitrary
canvases\&.
.SH API
.TP
\fB::canvas::snap\fR \fIpathName\fR
Takes a snapshot of the canvas \fIpathName\fR\&. The result is the name
of a new Tk photo image containing the snapshot\&.
.sp
\fINote\fR that this command has a side-effect\&. To avoid having white
rectangles where other windows may overlap the canvas this command
forces the toplevel window the canvas is in to the top of the stacking
order\&.
.PP
.SH KEYWORDS
canvas, image, photo, print screen, snapshot
.SH COPYRIGHT
.nf
Copyright (c) 2004 George Petasis (http://wiki\&.tcl\&.tk/1404)
Copyright (c) 2010 Documentation, Andreas Kupries

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_sqmap\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::sqmap" n 0\&.3\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::sqmap \- Canvas with map background based on square tiles
.SH SYNOPSIS
package require \fBTcl  8\&.4\fR
.sp
package require \fBTk  8\&.4\fR
.sp
package require \fBsnit \fR
.sp
package require \fBuevent::onidle \fR
.sp
package require \fBcache::async \fR
.sp
package require \fBcanvas::sqmap  ?0\&.3\&.1?\fR
.sp
\fB::canvas::sqmap\fR \fIpathName\fR ?options?
.sp
\fIcanvasName\fR \fBimage set\fR \fIcell\fR \fIimage\fR
.sp
\fIcanvasName\fR \fBimage unset\fR \fIcell\fR
.sp
\fIcanvasName\fR \fBflush\fR
.sp
.BE
.SH DESCRIPTION
This package provides an extended canvas widget for the display of
maps based on a set of square image tiles\&. The tiles are the
background of the canvas, with all other canvas items added always
shown in front of them\&. The number of tiles shown, tile size, and
where to get the images to show are all configurable\&.
.SH API
.TP
\fB::canvas::sqmap\fR \fIpathName\fR ?options?
Creates the canvas \fIpathName\fR and configures it\&. The new widget
supports all of the options and methods of a regular canvas, plus the
options and methods described below\&.
.sp
The result of the command is \fIpathName\fR\&.
.PP
.SS OPTIONS
.TP
\fB-grid-cell-width\fR
The value for this option is a non-negative integer\&. It specifies the
width of the cells the background is made up of\&.
.TP
\fB-grid-cell-height\fR
The value for this option is a non-negative integer\&. It specifies the
height of the cells the background is made up of\&.
.TP
\fB-grid-cell-command\fR
The value for this option is a command prefix\&. It is invoked whenever
the canvas needs the image for a specific cell of the background, with
two additional arguments, the id of the cell, and a command prefix to
invoke when the image is ready, or known to not exist\&.
.sp
The id of the cell is a 2-element list containing the row and column
number of the cell, in this order\&. The result command prefix (named
"$result" in the example below) has to be invoked with either two or
three arguments, i\&.e\&.
.CS


    $result set   $cellid $image ; # image is known and ready
    $result unset $cellid        ; # image does not exist

.CE
.IP
This option may be left undefined, i\&.e\&. the canvas can operate without
it\&. In that case the only images shown in grid cells are those
explicitly set with the method \fBimage set\fR, see the next
section\&. All other grid cells will simply be empty\&.
.TP
\fB-viewport-command\fR
This option specifies a command prefix to invoke when the viewport of
the canvas is changed, to allow users keep track of where in the
scroll-region we are at all times\&. This can be used, for example, to
drive derivate displays, or to keep items in view by moving them as
the viewport moves\&.
.TP
\fB-image-on-load\fR
The value for this option is an image\&. If specified the image is shown
in a cell while the actual image for that cell is getting loaded
through the callback specified by the \fB-grid-cell-command\fR\&.
.TP
\fB-image-on-unset\fR
The value for this option is an image\&. If specified the image is shown
in a cell for which the callback specified by the \fB-grid-cell-command\fR
reported that there is no actual image to be shown\&.
.PP
.SS METHODS
.TP
\fIcanvasName\fR \fBimage set\fR \fIcell\fR \fIimage\fR
Invoking this method places the \fIimage\fR into the specified
\fIcell\fR of the background\&. The cell is given as a 2-element list
containing row and column number, in this order\&.
.sp
Note that an image is allowed to be associated with and displayed in
multiple cells of the canvas\&.
.TP
\fIcanvasName\fR \fBimage unset\fR \fIcell\fR
Invoking this method declares the specified \fIcell\fR of the
background as empty, an existing image shown by this cell will be
forgotten\&.  The cell is given as a 2-element list containing row and
column number, in this order\&.
.TP
\fIcanvasName\fR \fBflush\fR
Invoking this method forces the canvas to completely reload the images
for all cells\&. Do not use this method if the canvas is operated
without a \fB-grid-cell-command\fR, as in that case the canvas will
simply forget all images without being able to reload them\&.
.PP
.SH "IMAGE OWNERSHIP"
Note that the canvas \fIdoes not\fR take ownership of the images it
shows in the background\&. In other words, when we say that the canvas
forgets an image this means only that the association between a grid
cell and shown image is broken\&. The image is \fInot\fR
deleted\&. Managing the lifecycle of the images shown by the canvas is
responsibility of the user of the canvas\&.
.SH KEYWORDS
canvas, cell, grid, image, map, square map, tile

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_tags\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::tag" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::tag \- Easier management of the tags on canvas items or item groups
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::tag  ?0\&.1?\fR
.sp
\fB::canvas::tag\fR \fBappend\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
.sp
\fB::canvas::tag\fR \fBprepend\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
.sp
\fB::canvas::tag\fR \fBappend\fR \fIcanvas\fR \fItagOrId\fR \fIindex\fR \fItag\fR\&.\&.\&.
.sp
\fB::canvas::tag\fR \fBremove\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
.sp
\fB::canvas::tag\fR \fBmatch\fR \fIcanvas\fR \fItagOrId\fR \fIpattern\fR
.sp
.BE
.SH DESCRIPTION
This package provides utility commands for easier management of the
tag lists associated with canvas items or item groups\&.
.PP
The problem with the existing canvas API is that a tag list can
only be set as a whole, making adding and removing of tags from such
lists relatively complex operations reading the current tag list,
modifying it, and then writing the changed list back\&.
.PP
The commands provided by this package hide all this complexity
from the user\&.
.SH API
.TP
\fB::canvas::tag\fR \fBappend\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
This command adds the tags \fItag\fR\&.\&.\&. to the tag list for the items
identified by the \fItagOrId\fR in the \fIcanvas\fR widget\&. The new
tags are added at the end of the list\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::tag\fR \fBprepend\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
This command adds the tags \fItag\fR\&.\&.\&. to the tag list for the items
identified by the \fItagOrId\fR in the \fIcanvas\fR widget\&. The new
tags are added at the beginning of the list\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::tag\fR \fBappend\fR \fIcanvas\fR \fItagOrId\fR \fIindex\fR \fItag\fR\&.\&.\&.
This command adds the tags \fItag\fR\&.\&.\&. to the tag list for the items
identified by the \fItagOrId\fR in the \fIcanvas\fR widget\&. The new
tags are inserted before the element at \fIindex\fR\&.
.sp
\fIindex\fR \fB0\fR refers to the beginning of the list\&.
.sp
\fIindex\fR \fBend\fR refers to after the end of the list\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::tag\fR \fBremove\fR \fIcanvas\fR \fItagOrId\fR \fItag\fR\&.\&.\&.
This command removes the named tags \fItag\fR\&.\&.\&. from the tag list for the items
identified by the \fItagOrId\fR in the \fIcanvas\fR widget\&.
.sp
The result of the command is the empty string\&.
.TP
\fB::canvas::tag\fR \fBmatch\fR \fIcanvas\fR \fItagOrId\fR \fIpattern\fR
This command finds all tags for the items identified by the
\fItagOrId\fR in the \fIcanvas\fR widget which match the glob
\fIpattern\fR\&.
.sp
The result of the command is a list of the matching tags\&. Which
may be empty\&.
.PP
.SH KEYWORDS
append tag, canvas, insert tag, remove tag, tags

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_trlines\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::track::lines" n 0\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::track::lines \- Manage a group of rubber band lines
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBcanvas::tag  ?0\&.1?\fR
.sp
\fB::canvas::track\fR \fBlines\fR \fIobjectName\fR \fIcanvas\fR
.sp
\fBobjectName\fR \fBdestroy\fR
.sp
\fBobjectName\fR \fBstart\fR \fIcurrent\fR \fIp\fR\&.\&.\&.
.sp
\fBobjectName\fR \fBmove\fR \fIcurrent\fR
.sp
\fBobjectName\fR \fBdone\fR
.sp
.BE
.SH DESCRIPTION
This package provides a utility class managing the drawing of set of semi-crosshair (rubberband) lines\&.
.SH "CLASS API"
.TP
\fB::canvas::track\fR \fBlines\fR \fIobjectName\fR \fIcanvas\fR
This, the class command, creates and configures a new instance of the
tracker, named \fIobjectName\fR\&. The instance will be
connected to the specified \fIcanvas\fR widget\&.
.sp
The result of the command is the fully qualified name of the
instance command\&.
.PP
.SH "INSTANCE API"
Instances of this class provide the following API:
.TP
\fBobjectName\fR \fBdestroy\fR
This method destroys the instance and releases all its
internal resources\&.
.sp
This operation does destroy the items representing the
tracked lines\&. It does not destroy the attached canvas\&.
.sp
The result of the method is an empty string\&.
.TP
\fBobjectName\fR \fBstart\fR \fIcurrent\fR \fIp\fR\&.\&.\&.
This method starts the tracking of a set of lines, one line per
point \fIp\fR, which specifies the destination end-point of each
line\&. All lines will have \fIcurrent\fR as a common end-point\&.
.sp
Note that a previously tracked set of lines is removed\&.
.sp
The result of the method is an empty string\&.
.sp
Each point is specified through a 2-element list containing its
x- and y-coordinates, in this order\&.
.TP
\fBobjectName\fR \fBmove\fR \fIcurrent\fR
This method updates the shared end-point of all rubberbands and redraws
them\&.
.sp
The result of the method is an empty string\&.
.sp
The point is specified through a 2-element list containing its
x- and y-coordinates, in this order\&.
.TP
\fBobjectName\fR \fBdone\fR
This method ends the tracking of the current set of lines and removes
them from the canvas\&.
.PP
.SH KEYWORDS
canvas, crosshair, rubberband, tracking

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/canvas/canvas_zoom\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "canvas::zoom" n 0\&.2\&.1 tklib "Variations on a canvas"
.BS
.SH NAME
canvas::zoom \- Zoom control for canvas::sqmap
.SH SYNOPSIS
package require \fBTcl  8\&.4\fR
.sp
package require \fBTk  8\&.4\fR
.sp
package require \fBsnit \fR
.sp
package require \fBuevent::onidle \fR
.sp
package require \fBcanvas::zoom  ?0\&.2\&.1?\fR
.sp
\fB::canvas::zoom\fR \fIpathName\fR ?options?
.sp
.BE
.SH DESCRIPTION
This package provides a widget to enable the user of a map display to
control the zoom level\&.
.SH API
.TP
\fB::canvas::zoom\fR \fIpathName\fR ?options?
Creates the zoom control widget \fIpathName\fR and configures it\&. The
methods and options supported by the new widget are described in the
following sections\&.
.sp
The result of the command is \fIpathName\fR\&.
.PP
.SS OPTIONS
.TP
\fB-orient\fR
The value for this option is either \fBvertical\fR, or
\fBhorizontal\fR, specifying the orientation of the major axis of
the widget\&. The default is \fBvertical\fR\&.
.TP
\fB-levels\fR
The value for this option is a non-negative integer\&. It specifies the
number of zoom levels to support\&.
.TP
\fB-variable\fR
The value for this option is the name of a global or namespaced
variable which is connected with the widget\&. changes to the zoom level
made the widget are propagated to this variable, and in turn changes
to the variable are imported into the widget\&.
.TP
\fB-command\fR
This option specifies a command prefix\&. This callback will be invoked
whenever the zoom level is changed\&. It is called with two additional
arguments, the zoom control widget, and the new zoom level, in this
order\&.
.PP
.SS METHODS
The widget supports no methods beyond the standard (\fBconfigure\fR,
\fBcget\fR, etc\&.)\&.
.SH KEYWORDS
zoom

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/chatwidget/chatwidget\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "chatwidget" n 1\&.0\&.0 tklib "Composite widget for chat applications"
.BS
.SH NAME
chatwidget \- Provides a multi-paned view suitable for display of chat room or irc channel information
.SH SYNOPSIS
package require \fBTk  8\&.5\fR
.sp
package require \fBchatwidget  ?1\&.0\&.0?\fR
.sp
\fB::chatwidget::chatwidget\fR \fIpath\fR ?\fIoptions\fR?
.sp
\fB$widget\fR topic \fIcommand\fR \fIargs\fR
.sp
\fB$widget\fR name \fInick\fR \fIargs\fR
.sp
\fB$widget\fR message \fItext\fR \fIargs\fR
.sp
\fB$widget\fR hook \fIcommand\fR \fIargs\fR
.sp
\fB$widget\fR names \fIargs\fR
.sp
\fB$widget\fR entry \fIargs\fR
.sp
\fB$widget\fR chat \fIargs\fR
.sp
.BE
.SH DESCRIPTION
This is a composite widget designed to simplify the construction of
chat applications\&. The widget contains display areas for chat
messages, user names and topic and an entry area\&. It automatically
handles colourization of messages per nick and manages nick
completion\&. A system of hooks permit the application author to adjust
display features\&. The main chat display area may be split for use
displaying history or for searching\&.
.PP
The widget is made up of a number of text widget and panedwindow
widgets so that the size of each part of the display may be adjusted
by the user\&. All the text widgets may be accessed via widget
passthrough commands if fine adjustment is required\&. The topic and
names sections can also be hidden if desired\&.
.SH COMMANDS
.TP
\fB::chatwidget::chatwidget\fR \fIpath\fR ?\fIoptions\fR?
Create a new chatwidget using the Tk window id \fIpath\fR\&. Any options
provided are currently passed directly to the main chat text widget\&.
.PP
.SH "WIDGET COMMANDS"
.TP
\fB$widget\fR topic \fIcommand\fR \fIargs\fR
The chat widget can display a topic string, for instance the topic or
name given to a multi-user chatroom or irc channel\&.
.RS
.TP
\fBshow\fR
Enable display of the topic\&.
.TP
\fBhide\fR
Disable display of the topic
.TP
\fBset \fItopic\fR\fR
Set the topic text to \fItopic\fR\&.
.RE
.TP
\fB$widget\fR name \fInick\fR \fIargs\fR
Control the names and tags associated with names\&.
.RS
.TP
\fBlist ?\fI-full\fR?\fR
Returns a list of all the user names from the names view\&. If ?-full? is given then the list returned is a list of lists where each
sublist is made up of the nick followed by any options that have been
set on this nick entry\&. This may be used to examine any application
specific options that may be applied to a nick when using the
\fBadd\fR command\&.
.TP
\fBadd \fInick\fR ?\fIoptions\fR?\fR
.TP
\fBdelete \fInick\fR\fR
.RE
.TP
\fB$widget\fR message \fItext\fR \fIargs\fR
Add messages to the display\&. options are -nick, -time, -type, -mark
-tags
.TP
\fB$widget\fR hook \fIcommand\fR \fIargs\fR
Manage hooks\&. add (message, post names_group, names_nick, chatstate), remove, run
.TP
\fB$widget\fR names \fIargs\fR
Passthrough to the name display text widget\&. See the \fBtext\fR widget manual
for all available commands\&. The chatwidget provides two additional
commands \fBshow\fR and \fBhide\fR which are used to control the
display of this element in the widget\&.
.TP
\fB$widget\fR entry \fIargs\fR
Passthrough to the entry text widget\&. See the \fBtext\fR widget manual
for all available commands\&.
.TP
\fB$widget\fR chat \fIargs\fR
Passthrough to the chat text widget\&. See the \fBtext\fR widget manual for
all available commands\&.
.PP
.SH EXAMPLE
.CS


chatwidget::chatwidget \&.chat
proc speak {w msg} {$w message $msg -nick user}
\&.chat hook add post [list speak \&.chat]
pack \&.chat -side top -fill both -expand 1
\&.chat topic show
\&.chat topic set "Chat widget demo"
\&.chat name add "admin" -group admin
\&.chat name add "user" -group users -color tomato
\&.chat message "Chatwidget ready" -type system
\&.chat message "Hello, user" -nick admin
\&.chat message "Hello, admin" -nick user

.CE
.PP
A more extensive example is available by examining the code for the picoirc
program in the tclapps repository which ties the tcllib \fBpicoirc\fR package to this
\fBchatwidget\fR package to create a simple irc client\&.
.SH "SEE ALSO"
text(n)
.SH KEYWORDS
chat, chatwidget, composite widget, irc, mega-widget, widget

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/controlwidget/controlwidget\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2010 Ron Fox <rfox@\&.\&.\&.>
'\" Copyright (c) 2010 Gerhard Reithofer <\&.\&.\&.@\&.\&.\&.>
'\" Copyright (c) 2010 Marco Maggi <\&.\&.\&.@\&.\&.\&.>
'\" Copyright (c) 2010 Arjen Markus <arjenmarkus@users\&.sourceforge\&.net>
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "controlwidget" n 0\&.1 tklib "controlwidget"
.BS
.SH NAME
controlwidget \- Collection of widgets for displaying and controlling numerical values
.SH SYNOPSIS
package require \fBTcl  ?8\&.5?\fR
.sp
package require \fBTk  ?8\&.5?\fR
.sp
package require \fBsnit  ?2\&.0?\fR
.sp
package require \fBcontrolwidget  ?0\&.1?\fR
.sp
\fB::controlwidget::meter\fR \fIw\fR \fIargs\fR
.sp
\fB::controlwidget::slider\fR \fIw\fR \fIargs\fR
.sp
\fB::controlwidget::equalizerBar\fR \fIw\fR \fIargs\fR
.sp

\fB$matrix\fR get
.sp
\fB$matrix\fR set \fIindex\fR
.sp
.BE
.SH DESCRIPTION
.PP
The controlwidget package focuses on the display and interactive control of numerical values\&.
It mimicks several of the meters and controls found in laboratory settings but also
daily life: volt meters, equalizers and tachometers to name a few\&. They can be seen as alternatives
for the \fIscale widget\fR\&.
.PP
\fINote:\fR The package has not sofar been tested extensively, and that may result in
an unexpected appearance if you use sizes that are different than the defaults\&. Also
not all options for the coloring of the various parts and fonts and so on have been tested, so that
may be another source of bugs\&.
.PP
A last note: some parts have not been included in any option, most notably the colors of
parts that require lighter and darker shades to cooperate\&.
.SH "TYPES OF WIDGETS"
The package distinguishes several typed of widgets:
.IP \(bu
Vertical meters: the value of the variable is translated into a vertical position, like with
the coloured bars you find on your stereo installation\&.
.IP \(bu
Angle displays: the value of the variable is related to the angle of a needle, like with tachometers\&.
.IP \(bu
Interactive widgets: most widgets allow you to change the value of the variable by pressing the mouse button
on the needle and shifting it up and down or left and right\&.
.IP \(bu
Non-interactive widgets: some widgets, like the thermometer widget, do not allow such interaction\&.
.IP \(bu
Logical or choice widgets: some widgets display the values as either on/off (or true/false) or as
one of a set of discrete choices\&.
.PP
All widgets have in common, however, that you can connect them to a variable and that changing the variable
changes the display\&. Forthermore, all widgets have the set and get methods to interact with the value that
the widget displays (whether that is stored in a global variable or not)\&.
.PP
They also have in common that their appearance and behaviour is determined by one or more options that
you can set at creation time and often later on as well\&. The widgets are all based on the \fIsnit\fR
package, so that the methods \fBconfigure\fR and \fBcget\fR are available to set and get these options\&.
.SH COMMANDS
Currently the package contains these widgets of the \fIvertical meter\fR type:
.TP
\fB::controlwidget::meter\fR \fIw\fR \fIargs\fR
Create a vertical meter consisting of an axis and a moveable arrow\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the meter

.TP
\fBreadonly\fR boolean
Whether the arrow can be moved interactively or not
.RE
.RE
.TP
\fB::controlwidget::slider\fR \fIw\fR \fIargs\fR
Create a widget containing one or more vertical sliders and an axis\&. You can shift the slider handles
interactively via the mouse\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the (list) variable to be associated with the widget

.TP
\fBtroughwidth\fR color
Width of the troughs holding the sliders
.RE
.RE
.TP
\fB::controlwidget::equalizerBar\fR \fIw\fR \fIargs\fR
Create a widget containing one or more vertical bars resembling those found on hifi graphical equalizers\&.
Note that it is a read-only widget\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the (list) variable to be associated with the widget

.RE
.TP
\fB::controlwidget::thermometer\fR \fIw\fR \fIargs\fR
Create a thermometer widget (read-only)
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the (list) variable to be associated with the widget

.TP
\fBlog\fR boolean
Use a logarithmic axis (true) or a linear axis (false)
.PP
The package contains the following widget based on angle displays:
.TP
\fB::controlwidget::voltmeter\fR \fIw\fR \fIargs\fR
Create a voltmeter-like widget\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the meter
.TP
\fBvalue\fR value
Value for the meter (if not associated with a variable)
.TP
\fBmin\fR value
The minimum value for data in the display
.TP
\fBmax\fR value
The maximum value for data in the display
.TP
\fBlabels\fR list
The labels to be shown along the scale\&. (These are simply considered texts, so no
relation with the minimum and maximum perse)
.TP
\fBtitle\fR string
String to be shown below the dial
.TP
\fBwidth\fR pixels
The width of the widget

.TP
\fBtitlecolor\fR color
Color of the title below the dial
.RE
.RE
.TP
\fB::controlwidget::tachometer\fR \fIw\fR \fIargs\fR
Create a tachometer-like widget\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget\&. In addition
to the ones given for the voltmeter widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the meter
.TP
\fBvalue\fR value

.TP
\fBpincolor\fR color
Color for the needle and the pin
.RE
.RE
.TP
\fB::controlwidget::rdial\fR \fIw\fR \fIargs\fR
Create a rotating dial\&. You can drag the dial to change the value\&. With the shift button
depressed the value changes slowly, with the control button depressed it changes fast\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the dial

.PP
All these widgets have the following methods:
.TP
\fB$widget\fR get
Return the current value or values shown in the widget
.TP
\fB$widget\fR set \fIvalue\fR
Reset the value or values shown in the widget\&. If the widget is associated with
a variable, that variable is set as well\&.
.RS
.TP
value \fIdouble/list\fR
New value or values for the widget
.RE
.PP
Two further widgets are available, meant to display logical values:
.TP
\fB::controlwidget::led\fR \fIw\fR \fIargs\fR
Create a LED-like widget\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget\&. In addition
to the ones given for the voltmeter widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the LED
.TP
\fBsize\fR pixels
Diameter of the LED widget
.TP
\fBon\fR color
Color to use for the "on" state
.TP
\fBoff\fR color
Color to use for the "off" state
.RE
.RE
.TP
\fB::controlwidget::radioMatrix\fR \fIw\fR \fIargs\fR
Create a matrix of radio buttons that behaves as a single widget\&.
.RS
.TP
widget \fIw\fR (in)
Name of the widget to be created\&.
.TP
arguments \fIargs\fR (in)
List of key-value pairs, controlling the appearance and behaviour of the widget\&. In addition
to the ones given for the voltmeter widget:
.RS
.TP
\fBvariable\fR name
Name of the variable to be associated with the matrix
.TP
\fBorient\fR string
The way the radio buttons are to be arranged (horizontal or vertical first)
.TP
\fBrows\fR integer
Number of rows in the matrix
.TP
\fBcolumns\fR integer
Number of columns in the matrix
.TP
\fBcommand\fR list
Command associated with the radio buttons\&. Invoked when the active radio button changes\&.
.RE
.RE
.PP
The LED widget has the following public methods:
.TP
\fB$led\fR on
Set the state to "on"

.RS
.TP
index \fIinteger\fR
Index of the radio button to be set
.RE
.PP
.SH ACKNOWLEDGMENTS
The code for most of these widgets first appeared on the Wiki\&. In many cases, Arjen Markus merely
refactored the code a bit and "snitified" some of them\&. The original code was developed by the following people:
.IP \(bu
Vertical meter, LED display, radio matrix: Ron Fox
.IP \(bu
Rotating dials: Gerhard Reithofer
.IP \(bu
Voltmeter and tachometer: Marco Maggi
.IP \(bu
Code for moving the needle: ?
.PP
.SH KEYWORDS
controlling, displaying, numerical values, scale widget
.SH COPYRIGHT
.nf
Copyright (c) 2010 Ron Fox <rfox@\&.\&.\&.>
Copyright (c) 2010 Gerhard Reithofer <\&.\&.\&.@\&.\&.\&.>
Copyright (c) 2010 Marco Maggi <\&.\&.\&.@\&.\&.\&.>
Copyright (c) 2010 Arjen Markus <arjenmarkus@users\&.sourceforge\&.net>

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/crosshair/crosshair\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) 2003 Kevin Kenny
'\" Copyright (c) 2008 (docs) Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
'\" Copyright (c) 2013 Frank Gover, Andreas Kupries
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "crosshair" n 1\&.1 tklib "Crosshairs"
.BS
.SH NAME
crosshair \- Crosshairs for Tk canvas
.SH SYNOPSIS
package require \fBTcl  ?8\&.4?\fR
.sp
package require \fBTk  ?8\&.4?\fR
.sp
package require \fBcrosshair  ?1\&.1?\fR
.sp
\fBcrosshair::crosshair\fR \fIw\fR ?\fIarg\fR\&.\&.\&.?
.sp
\fBcrosshair::off\fR \fIw\fR
.sp
\fBcrosshair::configure\fR \fIw\fR ?\fIarg\fR\&.\&.\&.?
.sp
\fBcrosshair::track\fR \fBon\fR \fIw\fR \fIcmdprefix\fR
.sp
\fBcrosshair::track\fR \fBoff\fR \fIw\fR
.sp
\fBcrosshair::bbox_add\fR \fIw\fR \fIbbox\fR
.sp
\fBcrosshair::bbox_remove\fR \fItoken\fR
.sp
.BE
.SH DESCRIPTION
The \fBcrosshair\fR package provides commands to (de)activate and
track crosshairs on canvas widgets\&.
.SH API
The following commands are exported to the public:
.TP
\fBcrosshair::crosshair\fR \fIw\fR ?\fIarg\fR\&.\&.\&.?
This command activates the display of a pair of cross-hairs for the
canvas widget \fIw\fR\&. The cross-hairs track the pointing device\&. The
result of the command is the empty string\&.
.sp
All arguments after the widget \fIw\fR are treated as options as for a
canvas line item in \fIw\fR\&. Of particular interest are \fB-fill\fR
and \fB-dash\fR\&.
.TP
\fBcrosshair::off\fR \fIw\fR
This command removes the cross-hairs from the canvas widget \fIw\fR\&.
Nothing is done if the widget had no cross-hairs\&. The result of the
command is the empty string\&.
.TP
\fBcrosshair::configure\fR \fIw\fR ?\fIarg\fR\&.\&.\&.?
This command changes the appearance of the cross-hairs in the canvas
widget \fIw\fR\&. It is an error to call it for a canvas which has no
cross-hairs\&.
.sp
All arguments after the widget \fIw\fR are treated as options as for a
canvas line item in \fIw\fR\&. Of particular interest are \fB-fill\fR
and \fB-dash\fR\&.
.sp
The result of the command are the current configuration settings\&.
.TP
\fBcrosshair::track\fR \fBon\fR \fIw\fR \fIcmdprefix\fR
This command activates reporting of the location of the cross-hairs in
the canvas widget \fIw\fR\&. It is an error to use this command for a
canvas which has no cross-hairs\&. The result of the command is the
empty string\&.
.sp
After the invokation of this command the specified command prefix
\fIcmdprefix\fR will be called whenever the mouse moves within the
canvas, with 7 arguments\&. These are, in order:
.RS
.IP [1]
The widget \fIw\fR
.IP [2]
The x-location of the cross-hairs, in pixels\&.
.IP [3]
The y-location of the cross-hairs, in pixels\&.
.IP [4]
The x-location of the top-left corner of the viewport, in pixels\&.
.IP [5]
The y-location of the top-left corner of the viewport, in pixels\&.
.IP [6]
The x-location of the bottom-right corner of the viewport, in pixels\&.
.IP [7]
The y-location of the bottom-right corner of the viewport, in pixels\&.
.RE
.IP
A previously existing callback for \fIw\fR will be disabled\&. I\&.e\&. per
canvas widget with cross-hairs only one callback reporting their
location is possible\&.
.TP
\fBcrosshair::track\fR \fBoff\fR \fIw\fR
This command disables the reporting of the location of the cross-hairs
in the canvas widget \fIw\fR\&. It is an error to use this command for a
canvas which has no cross-hairs\&. The result of the command is the
empty string\&.
.TP
\fBcrosshair::bbox_add\fR \fIw\fR \fIbbox\fR
This command adds a bounding box to the crosshairs for canvas \fIw\fR\&.
The crosshairs will only be active within that area\&.
.sp
The result of the command is a token with which the bounding
box can be removed again, see \fBcrosshair::bbox_remove\fR below\&.
.sp
The bounding box \fIbbox\fR is specified thorugh a list of 4
values, the lower left and upper right corners of the box\&. The order
of values in the list is:
.CS

llx lly urx ury
.CE
.sp
Note that this command can be used multiple times, each call
adding one more bounding box\&. In such a case the visible area is the
\fIunion\fR of all the specified bounding boxes\&.
.TP
\fBcrosshair::bbox_remove\fR \fItoken\fR
This command removes the bounding box specified by the \fItoken\fR (a
result of \fBcrosshair::bbox_add\fR) from the crosshairs for its
canvas widget\&.
.PP
.SH "BUGS, IDEAS, FEEDBACK"
This document, and the package it describes, will undoubtedly contain
bugs and other problems\&.
Please report such in the category \fItklib :: crosshair\fR of the
\fITcllib SF Trackers\fR [http://sourceforge\&.net/tracker/?group_id=12883]\&.
Please also report any ideas for enhancements you may have for either
package and/or documentation\&.
.SH KEYWORDS
canvas, cross-hairs, location, tracking, viewport
.SH COPYRIGHT
.nf
Copyright (c) 2003 Kevin Kenny
Copyright (c) 2008 (docs) Andreas Kupries <andreas_kupries@users\&.sourceforge\&.net>
Copyright (c) 2013 Frank Gover, Andreas Kupries

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/ctext/ctext\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) George Peter Staplin <GeorgePS@XMission\&.com>
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "ctext" n 3\&.3 tklib "Ctext a text widget with highlighting support"
.BS
.SH NAME
ctext \- Ctext a text widget with highlighting support
.SH SYNOPSIS
package require \fBTk \fR
.sp
package require \fBctext  ?3\&.3?\fR
.sp
\fBctext\fR \fIpathName\fR ?\fIoptions\fR?
.sp
\fB::ctext::addHighlightClass\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIkeywordlist\fR
.sp
\fB::ctext::addHighlightClassWithOnlyCharStart\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIchar\fR
.sp

.sp
\fIpathName\fR \fBcut\fR
.sp
\fIpathName\fR \fBpaste\fR
.sp
\fIpathName\fR \fBappend\fR
.sp
\fIpathName\fR \fBconfigure\fR \fIoption\fR \fIvalue\fR ?\&.\&.\&.?
.sp
.BE
.SH DESCRIPTION
The \fBctext\fR package provides the ctext widget which
is an enhanced text widget with support for configurable syntax
highlighting and some extra commands\&.
.PP
Ctext overloads the text widget and provides
new commands, named \fBhighlight\fR, \fBcopy\fR, \fBpaste\fR,\fBcut\fR,
\fBappend\fR, and \fBedit\fR\&.  It also provides several
commands that allow you to define classes\&.
Each class corresponds to a tag in the widget\&.
.SH COMMANDS
.TP
\fBctext\fR \fIpathName\fR ?\fIoptions\fR?
Creates and configures a ctext widget\&.
.PP
.SH HIGHLIGHTING
Highlighting is controlled with text widget tags, that are called highlight classes\&.
The \fIclass\fR is a tag name and can be configured like any text widget tag\&.
Four types of highlight classes are supported\&. All highlight classes are automatically used
by the \fBhighlight\fR method of the widget\&.
.TP
\fB::ctext::addHighlightClass\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIkeywordlist\fR
Add a highlighting class \fIclass\fR to the ctext widget \fIpathName\fR\&.
The highligthing will be done with the color \fIcolor\fR\&. All words in the \fIkeywordlist\fR will be
highlighted\&.
.CS


	# highlight some tcl keywords
	::ctext::addHighlightClass \&.t tclkeywords red [list set info interp uplevel upvar]]

.CE
.TP
\fB::ctext::addHighlightClassWithOnlyCharStart\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIchar\fR
Add a highlighting class \fIclass\fR to the ctext widget \fIpathName\fR\&.
The highligthing will be done with the color \fIcolor\fR\&. All words starting with \fIchar\fR will be
highlighted\&.
.CS


	::ctext::addHighlightClassWithOnlyCharStart \&.t vars blue \\$

.CE
.TP
\fB::ctext::addHighlightClassForSpecialChars\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIcharstring\fR
Add a highlighting class \fIclass\fR to the ctext widget \fIpathName\fR\&.
The highligthing will be done with the color \fIcolor\fR\&. All chars in \fIcharstring\fR will be
highlighted\&.
.TP
\fB::ctext::addHighlightClassForRegexp\fR \fIpathName\fR \fIclass\fR \fIcolor\fR \fIpattern\fR
Add a highlighting class \fIclass\fR to the ctext widget \fIpathName\fR\&.
The highligthing will be done with the color \fIcolor\fR\&. All text parts matching the regexp \fIpattern\fR
will be highligthed\&.
.TP
\fB::ctext::clearHighlightClasses\fR \fIpathName\fR
Remove all highlight classes from the widget \fIpathName\fR\&.
.TP
\fB::ctext::getHighlightClasses\fR \fIpathName\fR
List all highlight classes for the widget \fIpathName\fR\&.
.TP
\fB::ctext::deleteHighlightClass\fR \fIpathName\fR \fIclass\fR
Delete the highlight class \fIclass\fR from the widget \fIpathName\fR
.TP
\fB::ctext::enableComments\fR \fIenable\fR
Enable C comment highlighting\&. The \fIclass\fR for c-style comments is \fB_cComment\fR\&.
The C comment highlighting is disabled by default\&.
.TP
\fB::ctext::disableComments\fR \fIenable\fR
Disable C comment highlighting\&.
.PP
.SH "WIDGET COMMANDS"
Each ctext widget created with the above command supports the following
commands and options in addition to the standard text widget commands and
options\&.
.TP
\fIpathName\fR \fBhighlight\fR \fIstartIndex\fR \fIendIndex\fR
Highlight the text between \fIstartIndex\fR and \fIendIndex\fR\&.
.TP
\fIpathName\fR \fBfastdelete\fR \fIindex1\fR ?\fIindex2\fR?
Delete text range without updating the highlighting\&. Arguments
are identical to the \fIpathName\fR \fBdelete\fR command inherited from
the standard text widget\&.
.TP
\fIpathName\fR \fBfastinsert\fR
Insert text without updating the highlighting\&. Arguments
are identical to the \fIpathName\fR \fBinsert\fR command inherited from
the standard text widget\&.
.TP
\fIpathName\fR \fBcopy\fR
Call \fBtk_textCopy\fR for the ctext instance\&.
.TP
\fIpathName\fR \fBcut\fR
Call \fBtk_textCut\fR for the ctext instance\&.
.TP
\fIpathName\fR \fBpaste\fR
Call \fBtk_textPaste\fR for the ctext instance\&.
.TP
\fIpathName\fR \fBappend\fR
Append the current selection to the clipboard\&.
.TP
\fIpathName\fR \fBconfigure\fR \fIoption\fR \fIvalue\fR ?\&.\&.\&.?
Set the options for the ctext widget\&. Each option name must be followed
the new value\&.
.PP
.SH "WIDGET OPTIONS"
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemap\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Creates (-linemap 1) or deletes (-linemap 0) a line number list on the
left of the widget\&. The default is to have a linemap displayed\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemapfg\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Changes the foreground of the linemap\&.
The default is the same color as the main text
widget\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemapbg\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Changes the background of the linemap\&.
The default is the same color as the main text
widget\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemap_select_fg\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Changes the selected
line foreground\&.  The default is black\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemap_select_bg\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Changes the selected line
background\&.  The default is yellow\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemap_mark_command\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Calls a procedure or command
with the \fIpathName\fR of the ctext window, the \fItype\fR which is
either \fBmarked\fR or \fBunmarked\fR, and finally the line
number selected\&.
The proc prototype is:
.CS


proc linemark_cmd {win type line}\&.

.CE
.IP
See also
ctext_test_interactive\&.tcl
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-highlight\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Takes a boolean value which defines
whether or not to highlight text which is inserted
or deleted\&.  The default is 1\&.
.LP
.nf
.ta 6c
Command-Line Switch:	\fB-linemap_markable\fR
Database Name:	\fB\fR
Database Class:	\fB\fR

.fi
.IP
Takes a boolean value which
specifies whether or not lines in the linemap
are markable with the mouse\&.  The default is 1\&.
.PP
.SH EXAMPLE
.CS


	package require Tk
	package require ctext

	proc main {} {
	pack [frame \&.f] -fill both -expand 1
	pack [scrollbar \&.f\&.s -command {\&.f\&.t yview}] -side right -fill y

	pack [ctext \&.f\&.t -bg black -fg white -insertbackground yellow  -yscrollcommand {\&.f\&.s set}] -fill both -expand 1

	ctext::addHighlightClass \&.f\&.t widgets purple  [list ctext button label text frame toplevel  scrollbar checkbutton canvas listbox menu menubar menubutton  radiobutton scale entry message tk_chooseDir tk_getSaveFile  tk_getOpenFile tk_chooseColor tk_optionMenu]

	ctext::addHighlightClass \&.f\&.t flags orange  [list -text -command -yscrollcommand  -xscrollcommand -background -foreground -fg -bg  -highlightbackground -y -x -highlightcolor -relief -width  -height -wrap -font -fill -side -outline -style -insertwidth  -textvariable -activebackground -activeforeground -insertbackground  -anchor -orient -troughcolor -nonewline -expand -type -message  -title -offset -in -after -yscroll -xscroll -forward -regexp -count  -exact -padx -ipadx -filetypes -all -from -to -label -value -variable  -regexp -backwards -forwards -bd -pady -ipady -state -row -column  -cursor -highlightcolors -linemap -menu -tearoff -displayof -cursor  -underline -tags -tag]

	ctext::addHighlightClass \&.f\&.t stackControl red  {proc uplevel namespace while for foreach if else}
	ctext::addHighlightClassWithOnlyCharStart \&.f\&.t vars mediumspringgreen "\\$"
	ctext::addHighlightClass \&.f\&.t variable_funcs gold {set global variable unset}
	ctext::addHighlightClassForSpecialChars \&.f\&.t brackets green {[]{}}
	ctext::addHighlightClassForRegexp \&.f\&.t paths lightblue {\\\&.[a-zA-Z0-9\\_\\-]+}
	ctext::addHighlightClassForRegexp \&.f\&.t comments khaki {#[^\\n\\r]*}
	\&.f\&.t fastinsert end [info body main]

	pack [frame \&.f1] -fill x

	\&.f\&.t highlight 1\&.0 end

	pack [button \&.f1\&.exit -text Exit -command exit] -side left

	pack [entry \&.e] -side bottom -fill x
	\&.e insert end "ctext::deleteHighlightClass \&.f\&.t "
	bind \&.e <Return> {eval [\&.e get]}
	}
	main


.CE
Further examples are in the source package for ctext\&.
.SH THANKS
Kevin Kenny, Neil Madden, Jeffrey Hobbs, Richard Suchenwirth,
Johan Bengtsson, Mac Cody, Günther, Andreas Sievers, and Michael Schlenker\&.
.SH "SEE ALSO"
re_syntax, text
.SH KEYWORDS
syntax highlighting, text, widget
.SH COPYRIGHT
.nf
Copyright (c) George Peter Staplin <GeorgePS@XMission\&.com>

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/cursor/cursor\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) Jeffrey Hobbs <jeff@hobbs\&.org>
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "cursor" n 0\&.3\&.1 tklib "Tk cursor routines"
.BS
.SH NAME
cursor \- Procedures to handle CURSOR data
.SH SYNOPSIS
package require \fBTk \fR
.sp
package require \fBcursor  ?0\&.3\&.1?\fR
.sp
\fB::cursor::propagate\fR \fIwidget\fR \fIcursor\fR
.sp
\fB::cursor::restore\fR \fIwidget\fR ?\fIcursor\fR?
.sp
\fB::cursor::display\fR ?\fIparent\fR?
.sp
.BE
.SH DESCRIPTION
The \fBcursor\fR package provides commands to handle Tk cursors\&.
.SH COMMANDS
The following commands are available:
.TP
\fB::cursor::propagate\fR \fIwidget\fR \fIcursor\fR
Sets the cursor for the specified \fIwidget\fR and all its descendants
to \fIcursor\fR\&.
.TP
\fB::cursor::restore\fR \fIwidget\fR ?\fIcursor\fR?
Restore the original or previously set cursor for the specified
\fIwidget\fR and all its descendants\&.  If \fIcursor\fR is specified,
that will be used if on any widget that did not have a preset cursor
(set by a previous call to \fB::cursor::propagate\fR)\&.
.TP
\fB::cursor::display\fR ?\fIparent\fR?
Pops up a dialog with a listbox containing all the cursor names\&.
Selecting a cursor name will display it in that dialog\&.  This is
simply for viewing any available cursors on the platform\&.
.PP
.SH "SEE ALSO"
Tk_GetCursor(3), cursors(n), options(n)
.SH KEYWORDS
cursor
.SH COPYRIGHT
.nf
Copyright (c) Jeffrey Hobbs <jeff@hobbs\&.org>

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/datefield/datefield\&.n' by tcllib/doctools with format 'nroff'
'\" Copyright (c) Keith Vetter <keith@ebook\&.gemstar\&.com>
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "datefield" n 0\&.2 tklib "Tk datefield widget"
.BS
.SH NAME
datefield \- Tk datefield widget
.SH SYNOPSIS
package require \fBTk \fR
.sp
package require \fBdatefield  ?0\&.2?\fR
.sp
\fB::datefield::datefield\fR \fIwidgetpath\fR ?\fIoptions\fR?
.sp
.BE
.SH DESCRIPTION
The \fBdatefield\fR package provides the datefield widget which
is an enhanced text entry widget for the purpose of date entry\&. Only
valid dates of the form MM/DD/YYYY can be entered\&.
.PP
The datefield widget is, in fact, just an entry widget with
specialized bindings\&. This means all the command and options for an
entry widget apply equally here\&.
.SH COMMANDS
.TP
\fB::datefield::datefield\fR \fIwidgetpath\fR ?\fIoptions\fR?
Creates and configures a date field widget\&.
.PP
.SH OPTIONS
See the \fBentry\fR manual entry for details on all available options\&.
.SH EXAMPLE
.CS


 package require datefield

 wm title \&. "Datefield example"
 proc DayOfWeek {args} {
     set now [clock scan $::myDate]
     set ::myDate2 [clock format $now -format %A]
 }
 trace variable myDate w DayOfWeek

 ::datefield::datefield \&.df -textvariable myDate
 label \&.l1 -text "Enter a date:"   -anchor e
 label \&.l2 -text "That date is a:" -anchor e
 label \&.l3 -textvariable myDate2 -relief sunken -width 12

 grid \&.l1 \&.df -sticky ew
 grid \&.l2 \&.l3 -sticky ew
 focus \&.df

.CE
.SH "SEE ALSO"
clock(n), entry(n)
.SH KEYWORDS
clock, date, dateentry, entry, widget
.SH CATEGORY
Widget
.SH COPYRIGHT
.nf
Copyright (c) Keith Vetter <keith@ebook\&.gemstar\&.com>

.fi

'\"
'\" Generated from file '/home/aku/Projects/Tcllib/tklib/embedded/man/files/modules/diagrams/diagram\&.n' by tcllib/doctools with format 'nroff'
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\"	Start paragraph describing an argument to a library procedure.
'\"	type is type of argument (int, etc.), in/out is either "in", "out",

.de CE
.fi
.RE
..
.de UL
\\$1\l'|0\(ul'\\$2
..
.TH "diagram" n 0\&.3 tklib "Documentation toolbox"
.BS
.SH NAME
diagram \- Diagram drawing
.SH SYNOPSIS
package require \fBTcl  8\&.5\fR
.sp
package require \fBTk  8\&.5\fR
.sp
package require \fBdiagram  1\fR
.sp
\fB::diagram\fR \fIobjectName\fR \fIcanvas\fR ?\fIscript\fR?
.sp
\fIdiagramObject\fR \fBnew direction\fR \fIname\fR ?\fIkey\fR \fIvalue\fR\&.\&.\&.?
.sp
\fIdiagramObject\fR \fBnew element\fR \fIname\fR \fIattributes\fR \fIcmdprefix\fR
.sp
\fIdiagramObject\fR \fBnew alias\fR \fIname\fR \fIcmdprefix\fR
.sp
\fIdiagramObject\fR \fBnew command\fR \fIname\fR \fIarguments\fR \fIbody\fR
.sp
\fIdiagramObject\fR \fBnew attribute\fR \fIname\fR ?\fIkey\fR \fIvalue\fR\&.\&.\&.?
.sp
\fIdiagramObject\fR \fBunknown attribute\fR \fIcmdprefix\fR
.sp
\fIdiagramObject\fR \fBdraw\fR \fIscript\fR
.sp
\fBarc\fR \fIattr\fR\&.\&.\&.
.sp
\fBarrow\fR \fIattr\fR\&.\&.\&.
.sp
\fB-->\fR \fIattr\fR\&.\&.\&.
.sp
\fB<-->\fR \fIattr\fR\&.\&.\&.
.sp
\fB<-->\fR \fIattr\fR\&.\&.\&.
.sp
\fBblock\fR \fIscript\fR \fIattr\fR\&.\&.\&.
.sp
\fBbox\fR \fIattr\fR\&.\&.\&.
.sp
\fBcircle\fR \fIattr\fR\&.\&.\&.
.sp
\fBO\fR \fIattr\fR\&.\&.\&.
.sp
\fBdiamond\fR \fIattr\fR\&.\&.\&.
.sp
\fB<>\fR \fIattr\fR\&.\&.\&.
.sp
\fBdrum\fR \fIattr\fR\&.\&.\&.
.sp
\fBellipse\fR \fIattr\fR\&.\&.\&.
.sp
\fBline\fR \fIattr\fR\&.\&.\&.
.sp
\fB--\fR \fIattr\fR\&.\&.\&.
.sp
\fBmove\fR \fIattr\fR
.sp
\fBspline\fR \fIattr\fR\&.\&.\&.
.sp
\fBtext\fR \fIattr\fR\&.\&.\&.
.sp
\fBwest\fR
.sp
\fBw\fR
.sp
\fBleft\fR
.sp

.sp
\fBintersect\fR \fIelem1\fR \fIelem2\fR
.sp
\fIelement\fR \fBnames\fR ?\fIpattern\fR?
.sp
\fIelement\fR \fIcorner\fR
.sp
\fIelement\fR \fIcorner1\fR \fIcorner2\fR\&.\&.\&.
.sp
\fIelement\fR ?\fIcorner1\fR\&.\&.\&. ?\fBnames\fR ?\fIpattern\fR??]?
.sp
\fB\fBn\fRth\fR ?\fIcorner\fR?
.sp
\fB\fBn\fRth\fR \fBlast\fR ?\fIcorner\fR?
.sp
\fB\fBn\fRth\fR \fIshape\fR ?\fIcorner\fR?
.sp

\fB2nd\fR
.sp
\fB3rd\fR
.sp
.BE
.SH DESCRIPTION
Welcome to \fBdiagram\fR, a package for the easy construction of
diagrams (sic), i\&.e\&. 2D vector graphics, sometimes also called \fIpictures\fR\&.
Note that this package is not a replacement for \fBTk\fR's canvas,
but rather a layer sitting on top of it, to make it easier to use\&.
In other words, using the canvas as the core graphics engine \fBdiagram\fR abstracts away from the minutiae of handling coordinates to
position and size the drawn elements, allowing the user to concentrate
on the content of the diagram instead\&.
.PP
This is similar to Brian Kernighan's PIC language for troff, which is
the spiritual ancestor of this package\&.
.PP
This document contains the reference to the API and drawing (language)
commands\&. Its intended audience are users of the package wishing to
refresh their memory\&.
Newcomers should read the \fIDiagram Language Tutorial\fR first\&.
Developers wishing to work on the internals of the package and its
supporting packages should look at section
\fBDiagram Classes\fR
first, and then the comments in the sources of the packages itself\&.
.PP
In the remainder of the document we first describe the APIs of the
diagram class and its instances, followed by the language reference
for the drawing language itself\&.
.SH API
.SS "CLASS API"
The package exports the API described here\&.
.TP
\fB::diagram\fR \fIobjectName\fR \fIcanvas\fR ?\fIscript\fR?
The command creates a new instance of a diagram
controller and returns the fully qualified name of the
object command as its result\&.
The new instance is connected to the specified
\fIcanvas\fR object, which is used as the diagrams
graphics engine\&. This is usually an instance of Tk's
canvas, however any object which is API compatible to
Tk's canvas can be used here\&.
.sp
The API of this object command is described in the
following section, \fBObject API\fR\&. It may be
used to invoke various operations on the object\&.
.sp
If the \fIscript\fR argument is specified then method
\fBdraw\fR will be invoked on it\&.
.PP
.SS "OBJECT API"
Instances of the diagram class support the following
methods:
.TP
\fIdiagramObject\fR \fBnew direction\fR \fIname\fR ?\fIkey\fR \fIvalue\fR\&.\&.\&.?
This method defines a new named direction and its
attributes\&. The latter is given through the
\fIkey\fR/\fIvalue\fR pairs coming after the \fIname\fR\&.
.sp
Users are mostly free to specify arbitrary attributes
with whatever meaning they desire\&. The exception are
the names \fIangle\fR and \fIopposite\fR\&. They are
special to the diagram package and have a fixed meaning\&.
.RS
.TP
angle
This attribute specifies the angle of the direction in
degrees, where 0 points east (to the right) and 90 points
north (up)\&.
.TP
opposite
This attribute specifies the name of the direction
which should be considered as complementary to the
named one\&.
.RE
.TP
\fIdiagramObject\fR \fBnew element\fR \fIname\fR \fIattributes\fR \fIcmdprefix\fR
This method defines a new graphics element for the
drawing language\&. I\&.e\&. \fIname\fR will become a new
command in the language, and the specified command
prefix (\fIcmdprefix\fR) will be called to perform
the actual drawing\&.
.sp
\fIattributes\fR specifies the set of attributes for which
data has to be available\&. I\&.e\&. the system will run the
\&.\&.\&.-callbacks for these attributes\&.
See the method \fBnew attribute\fR for more information
on attribute definitions\&.
.sp
The command prefix is expected to conform to the
following signature:
.RS
.TP
\fBcmdprefix\fR \fIcanvas\fR \fIattributes\fR
Where \fIcanvas\fR is the handle of the canvas widget
to draw to, and \fIattributes\fR is a dictionary
holding the attributes for the element, be they
user-specified, or defaults\&.
.sp
The results of the command has to be a list containing
at least two and at most four items\&. These are, in order:
.RS
.IP [1]
The list of canvas items the drawn element consists of\&.
.IP [2]
The dictionary of named locations in the element, its
\fIcorners\fR\&.
.IP [3]
An optional mode, either "relative" or "absolute"\&.
When not returned "relative" is assumed\&. In the
case of a relative element position the attributes
"with" and "at" are used to determine the final
position of the new element\&.
.IP [4]
An optional name of a direction\&. If not the
empty string this is handed to the automatic
layouter as the new direction to follow\&.
.RE
.RE
.TP
\fIdiagramObject\fR \fBnew alias\fR \fIname\fR \fIcmdprefix\fR
This method defines a new command for the drawing
language\&. I\&.e\&. \fIname\fR will become a new command in
the language, and the specified command prefix
(\fIcmdprefix\fR) will be called on use of this new
command\&. Any arguments given to the command are
simply passed to the prefix\&. There is no fixed siganture\&.
.sp
Note that the prefix is run in the context of the
drawing language, allowing the direct use of any
existing commands\&.
.TP
\fIdiagramObject\fR \fBnew command\fR \fIname\fR \fIarguments\fR \fIbody\fR
This is like \fBnew alias\fR except that the new
command is defined as a procedure in the language's
context, with regular argument list and body\&.
.TP
\fIdiagramObject\fR \fBnew attribute\fR \fIname\fR ?\fIkey\fR \fIvalue\fR\&.\&.\&.?
This method defines a new named attribute which can be
used by graphical elements\&. The handling of the
attribute by the processor is declared through the
\fIkey\fR/\fIvalue\fR pairs coming after the \fIname\fR\&.
.sp
The accepted keys and their meanings are:
.RS
.TP
\fBkey\fR
The value of this key is the name of the key
under which the attribute's value shall be
stored in the attribute dictionary given to
the drawing command after attribute processing
is complete\&.
.sp
This key is optional\&. If it is not specified it
defaults to the name of the attribute\&.
.TP
\fBget\fR
The value of this key is a command prefix
which will be invoked to retrieve the
attribute's argument(s) from the command
line\&.
.sp
This key is optional\&. If it is not specified a
default is used which takes the single word
after the attribute name as the attribute's
value\&.
.sp
The signature of the command prefix is
.RS
.TP
\fBcmdprefix\fR \fIwordqueue\fR
Where \fIwordqueue\fR is the handle of
a queue object conforming to the API
of the queues provided by package
\fBstruct::queue\fR\&. This queue
contains the not-yet-processed part of
the attribute definitions, with one
entry per word, with the first entry
the word \fIafter\fR name of the
attribute\&. In other words, the
attribute's name has already been
removed from the queue\&.
.sp
The result of the command is the value
of the attribute, which may have been
taken from the queue, or not\&.
.RE
.TP
\fBtransform\fR
The value of this key is a command prefix
which will be invoked to transform the
retrieved value (See \fBget\fR) into their
final form\&.
.sp
This key is optional\&. If it is not specified
no transformation is done\&.
The signature of the command prefix is
.RS
.TP
\fBcmdprefix\fR \fIvalue\fR
Where \fIvalue\fR is the value to transform\&.
.sp
The result of the command is the final
value of the attribute\&.
.RE
.TP
\fBtype\fR
The value of this key is a command prefix
which will be invoked to validate the
attribute's argument(s)\&.
.sp
This key is optional\&. If it is not specified
no validation is done\&.
.sp
The signature of the command prefix is that of
snit validation types\&. See the documentation
of the \fBsnit\fR package\&.
.TP
\fBmerge\fR
The value of this key is a command prefix
which will be invoked to insert the
transformed and validated attribute value into
the dictionary of collected attributes\&.
.sp
This key is optional\&. If it is not specified
a default merge is chosen, based on the data
for key \fBaggregate\fR, see below\&.
The signature of the command prefix is
.RS
.TP
\fBcmdprefix\fR \fIvalue\fR \fIdict\fR
Where \fIvalue\fR is the value to
insert, and \fIdict\fR the dictionary
of attributes and values collected so
far\&.
.sp
The result of the command is the new
dictionary of attributes\&.
.RE
.TP
\fBaggregate\fR
The value of this key is a boolean flag\&. It
has an effect if and only if the key \fBmerge\fR was not specified\&. This key is
optional\&. If it is not specified it defaults
to \fBFalse\fR\&.
.sp
If the key is effective, the value of \fBFalse\fR means that the attribute's value is
\fIset\fR into the dictionary using the value
of key \fIkey\fR (see above) as index,
\fIoverwriting\fR any previously specified value\&.
.sp
If the key is effective, the value of \fBTrue\fR means that the attribute's value is
\fIadded\fR to the dictionary using the value
of key \fIkey\fR (see above) as index,
\fIextending\fR any previously specified value\&.
This means that the final value of the
attribute as seen after processing will be a
list of the collected values\&.
.TP
\fBdefault\fR
The value of this key is a command prefix
which will be invoked after collection of
attributes has been completed and this
attribute is in the list of required
attributes for the drawing element (See
argument \fIattributes\fR of method
\fBnew element\fR)\&.
.sp
Note that the connection is made through the
value of key \fIkey\fR, not through the
attribute name per se\&.
.sp
Further note that this command prefix is
invoked even if a user specified attribute
value is present\&. This allows the command
to go beyond simply setting defaults, it
can calculate and store derived values as
well\&.
.sp
This key is optional\&. If an element requires
this attribute, but \fIdefault\fR is not
specified then nothing will be done\&.
.sp
The signature of the command prefix is
.RS
.TP
\fBcmdprefix\fR \fBinit\fR
This method is run when the attribute
is defined, its responsibility is to
initialize anything in the language
namespace for the attribute and
default processing\&.
.sp
The result of this method is ignored\&.
.TP
\fBcmdprefix\fR \fBfill\fR \fIvarname\fR
This method is run to put defaults, or
derived values into the attribute dictionary
named by \fIvarname\fR\&. This variable will
be found in the calling context\&.
.sp
The result of this method is ignored\&.
.TP
\fBcmdprefix\fR \fBset\fR \fIname\fR \fIvalue\fR
This method is run to push current a
attribute value into the language
namespace, to make it the new default\&.
.sp
The result of this method is ignored\&.
.RE
.TP
\fBlinked\fR
This key is effective if and only if key
\fBdefault\fR is not specified\&. In that
case is supplies a default handling for
\fBdefault\fR, linking the attribute to a
variable in the language context\&.
.sp
The value for this key is a 2-element list
containing the name of the variable to link
to, and its initial value, in this order\&.
.RE
.TP
\fIdiagramObject\fR \fBunknown attribute\fR \fIcmdprefix\fR
This method registers the command prefix with the
subsystem processing the attributes for element
commands, telling it to call it when it encounters an
attribute it is unable to handle on its on\&.
.sp
It is allowed to register more than callback, these
will be called in order of registration (i\&.e\&. first to
last), until one of the callbacks accepts the current
input\&.
The command prefix is expected to conform to the
following signature:
.RS
.TP
\fBcmdprefix\fR \fIwordqueue\fR
Where \fIwordqueue\fR is the handle of a queue
object conforming to the API of the queues
provided by package \fBstruct::queue\fR\&.
This queue contains the not-yet-processed part
of the attribute definitions, with one entry
per word, with the first entry the name of the
attribute which could not be processed\&.
.sp
The results of the command has to be a boolean
value where \fBTrue\fR signals that this
callback has accepted the attribute, processed
it, and the new state of the \fIwordqueue\fR
is where the general processing shall continue\&.
.sp
Given the signature the command has basically
two ways of handling (rewriting) the attributes
it recognizes:
.RS
.IP [1]
Replace the attribute (and arguments)
with a different attribute and arguments\&.
.IP [2]
Push additional words in front to get
the general processing unstuck\&.
.RE
.RE
.TP
\fIdiagramObject\fR \fBdraw\fR \fIscript\fR
This method runs the given \fIscript\fR in the
context of the drawing language definitions\&.
See section \fBLanguage Reference\fR for
details on the available commands\&.
.sp
\fINote\fR that \fIscript\fR is \fItrusted\fR\&.
It is executed in the current interpreter with
access to its full abilities\&.
For the execution of untrusted diagram scripts this
interpreter should be a safe one\&.
.PP
.SH "LANGUAGE REFERENCE"
.SS ELEMENTS
This section lists the commands for the predefined drawing elements,
aka shapes\&. These commands are all defined in the language's context\&.
All commands of this section return the handle of the newly created
element as their result\&. This handle also exists as a command which
can be used to query the element for its corners (names, values)\&.
See section \fBMiscellaneous Commands\fR\&.
IMAGE: figure-02-basic-shapes
.TP
\fBarc\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-arc
An open element with the corresponding corners, i\&.e\&. "start", "end",
and "center"\&.
Note however that it also has the compass rose of closed elements as
its corners, with the center of the arc's circle as the center of the
compass and the other points on the circle the arc is part of\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBclockwise\fR
.TP
\fBcw\fR
Specifies the direction of the \fBarc\fR element, here going
clockwise\&.
The complementary attribute is \fBcounterclockwise\fR\&.
If not specified the system falls back to the value taken from the
language variable \fBclockwise\fR, which itself defaults to
\fBfalse\fR, for counter-clockwise direction\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBcounterclockwise\fR
.TP
\fBccw\fR
Specifies the direction of the \fBarc\fR element, here
counter-clockwise\&.
The complementary attribute is \fBclockwise\fR\&.
If not specified the system falls back to the value taken from the
language variable \fBclockwise\fR, which itself defaults to
\fBfalse\fR, for counter-clockwise direction\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBfrom\fR \fIlocation\fR
Specifies the location where the \fBarc\fR element begins\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBradius\fR \fIlength\fR
Specifies the radius of the \fBarc\fR element, or rather, the radius
of the circle the shown arc is a part of\&.
If not specified the system falls back to the value taken from the
language variable \fBarcradius\fR, which itself defaults to the pixel
equivalent of \fB1 cm\fR\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBto\fR \fIlocation\fR
Specifies the location where the \fBarc\fR element ends\&.
Defaults to a location such that a 90-degree arc is drawn in the
chosen direction, starting at \fBfrom\fR\&.
.RE
.TP
\fBarrow\fR \fIattr\fR\&.\&.\&.
.TP
\fB-->\fR \fIattr\fR\&.\&.\&.
.TP
\fB<-->\fR \fIattr\fR\&.\&.\&.
.TP
\fB<-->\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-arrow
An alias for the \fBline\fR element (see below), with the attribute
\fBarrowhead\fR preset to \fB->\fR, \fB<->\fR, or \fB<-\fR\&.  The
\fBarrow\fR is equivalent to \fB-->\fR\&.
.TP
\fBblock\fR \fIscript\fR \fIattr\fR\&.\&.\&.
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
The main effect is the aggregration of all elements created by the
\fIscript\fR into one element\&.
This also means that while the elements created by the script are
visible in the element history while the script is executing,
afterward the history contains only the block itself, and not the
elements it is composed of\&.
.sp
The script has access to the current state of all variables in the
language context\&.
Any changes to the variables will be reverted after execution of the
block\&.
However, also, any variables set in the script will be exported as
corners of the element, allowing users to define their own named
locations in the block\&.
.sp
Regarding the layout mechanism any changes made by the script are
reverted after the element is done\&.
In other words, a block is an implicit \fBgroup\fR\&.
.sp
Blocks handle all attributes, propgating their settings into the
script as the default values active during script execution\&.
.TP
\fBbox\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-box
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBheight\fR \fIlength\fR
.TP
\fBht\fR \fIlength\fR
Specifies the height of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxheight\fR, which itself defaults to the
pixel equivalent of \fB2 cm\fR\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBslant\fR \fIangle\fR
Specifies the angle by which the \fBbox\fR element is slanted, in
degrees\&.
If not specified the system falls back to the value taken from the
language variable \fBslant\fR, which itself defaults to \fB90\fR,
i\&.e\&. vertical, no slant\&.
0 degrees is slanting straight east, pointing to the right\&.
90 degrees is slanting to the north, pointing straight up\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwidth\fR \fIlength\fR
.TP
\fBwid\fR \fIlength\fR
Specifies the width of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxwidth\fR, which itself defaults to the pixel
equivalent of \fB2 cm\fR\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.TP
\fBcircle\fR \fIattr\fR\&.\&.\&.
.TP
\fBO\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-circle
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBdiameter\fR \fIlength\fR
.TP
\fBdiam\fR \fIlength\fR
Specifies the diameter of the \fBcircle\fR element, as an alternative
way to specify its \fBradius\fR\&.
Effective if and only if the radius was not specified\&. I\&.e\&. if both
diameter and radius are specified then the radius infomration has
precendence\&.
This attribute has no default, because the defaults are taken from the
radius\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBradius\fR \fIlength\fR
.TP
\fBrad\fR \fIlength\fR
Specifies the radius of the \fBcircle\fR element\&.
If not specified the system falls back to the value taken from the
language variable \fBcircleradius\fR, which itself defaults to the
pixel equivalent of \fB1 cm\fR\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.TP
\fBdiamond\fR \fIattr\fR\&.\&.\&.
.TP
\fB<>\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-diamond
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBaspect\fR \fInumber\fR
Specifies the aspect ratio, i\&.e ratio of width to height, of the
\fBdiamond\fR element\&.
The manner in which a default is calculated when not specified also
depends on the specifications of the attributes \fBwidth\fR and
\fBheight\fR, if any\&.
.sp
If both \fBwidth\fR, and \fBheight\fR are specified then any
specification of \fBaspect\fR is ignored, as it is implicitly defined
in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp
If the \fBaspect\fR is specified, and one of the attributes
\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated
from the two which are specified\&. No defaults are required for these
cases either\&.
.sp
If only one of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBaspect\fR, the value taken
from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.
.sp
If none of of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to
the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBheight\fR \fIlength\fR
Specifies the height of the \fBdiamond\fR element\&.
The manner in which a default is calculated when not specified also
depends on the specifications of the attributes \fBaspect\fR and
\fBwidth\fR, if any\&.
.sp
If both \fBwidth\fR, and \fBheight\fR are specified then any
specification of \fBaspect\fR is ignored, as it is implicitly defined
in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp
If the \fBaspect\fR is specified, and one of the attributes
\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated
from the two which are specified\&. No defaults are required for these
cases either\&.
.sp
If only one of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBaspect\fR, the value taken
from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.
.sp
If none of of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to
the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwidth\fR \fIlength\fR
Specifies the width of the \fBdiamond\fR element\&.
The manner in which a default is calculated when not specified also
depends on the specifications of the attributes \fBaspect\fR and
\fBheight\fR, if any\&.
.sp
If both \fBwidth\fR, and \fBheight\fR are specified then any
specification of \fBaspect\fR is ignored, as it is implicitly defined
in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp
If the \fBaspect\fR is specified, and one of the attributes
\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated
from the two which are specified\&. No defaults are required for these
cases either\&.
.sp
If only one of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBaspect\fR, the value taken
from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.
.sp
If none of of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to
the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.TP


\fBdrum\fR \fIattr\fR\&.\&.\&.




IMAGE: figure-02-drum





A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.


























It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBaspect\fR \fInumber\fR
Specifies the aspect ratio, i\&.e ratio of width to height, of the
ellipses which are used to draw the top and bottom of the \fBdrum\fR
element\&.
If not specified the system falls back to the value taken from the
language variable \fBdrumaspect\fR, which itself defaults to
\fB0\&.35\fR\&.
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBheight\fR \fIlength\fR
.TP
\fBht\fR \fIlength\fR
Specifies the height of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxheight\fR, which itself defaults to the
pixel equivalent of \fB2 cm\fR\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.









.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwidth\fR \fIlength\fR
.TP
\fBwid\fR \fIlength\fR
Specifies the width of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxwidth\fR, which itself defaults to the pixel
equivalent of \fB2 cm\fR\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.TP


\fBellipse\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-ellipse
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.











.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBheight\fR \fIlength\fR
.TP
\fBht\fR \fIlength\fR
Specifies the height of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxheight\fR, which itself defaults to the
pixel equivalent of \fB2 cm\fR\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.








.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwidth\fR \fIlength\fR
.TP
\fBwid\fR \fIlength\fR
Specifies the width of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxwidth\fR, which itself defaults to the pixel
equivalent of \fB2 cm\fR\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.TP
\fBline\fR \fIattr\fR\&.\&.\&.
.TP
\fB--\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-line
An open element with the corresponding corners, i\&.e\&. "start", "end",
and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBarrowhead\fR \fIspec\fR
IMAGE: figure-19-style-arrowheads
Specifies where to draw arrowheads on the \fBline\fR element, at the
beginning or end, at both ends, or none\&.
If not specified the system falls back to the value taken from the

language variable \fBarrowhead\fR, which itself defaults to
\fBnone\fR\&.
The legal values are
.RS




.TP
\fBnone\fR, \fB-\fR
Draw no arrowheads, at neither end of the line\&.
.TP
\fBstart\fR, \fBfirst\fR, \fB<-\fR
Draw an arrowhead at the beginning of the line, but not at its end\&.

.TP
\fBend\fR, \fBlast\fR, \fB->\fR
Draw an arrowhead at the end of the line, but not at its beginning\&.
.TP
\fBboth\fR, \fB<->\fR

Draw arrowheads at both ends of the line\&.
.RE
.IP
Note that the values "start", "end", "-", "->", "<-", and "<->" are
all accepted as shorthands for the \fBarrowhead\fR command using them



as argument\&.
.TP
\fBat\fR \fIlocation\fR
\fBLine\fR elements are normally positioned absolutely, using the
locations specified through the attributes \fBfrom\fR, \fBthen\fR, and
\fBto\fR\&.
If \fBat\fR is specified however then these positions are translated a
last time, moving the line's corner named by the attribute \fBwith\fR
to the location given by this attribute\&.
.TP
\fBchop\fR ?\fIlength\fR?
Specifies the length of the \fBline\fR element to remove from the
beginning and/or end\&.
Defaults to nothing\&.
If specified once the chopping applies to both beginning and end of
the line\&.
If specified twice or more the last two specifications are used, and
applied to beginning and end of the line, in this order\&.
Whenever the attribute is specified without an explicit length, the
system falls back to the value taken from the language variable
\fBcircleradius\fR, which itself defaults to the pixel equivalent of
\fB1 cm\fR
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBfrom\fR \fIlocation\fR
Specifies the location where the \fBline\fR element begins\&.







Defaults to the current location as maintained by the layouting

system\&.
















.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBnoturn\fR
Specifies that the direction of \fBline\fR element at its end is not
propagated to the layout management\&.
If not specified the direction of the line becomes the new direction
the layout\&.
.TP
\fBsmooth\fR
Specifies the use of bezier splines for the \fBline\fR element\&.
If not specified lines are drawn exactly through the specified
waypoints, without any smooth curves\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBthen\fR \fIlocation\fR
.TP
\fBthen\fR (<direction> ?\fIlength\fR?)\&.\&.\&.


.TP
(<direction> ?\fIlength\fR?)\&.\&.\&.
This attribute specifies an intermediate location the \fBline\fR
element has to go through\&.
It can be specified multiple times, with each use adding one
additional location to the series which the line will go
through\&. These location will be traversed in the order they were
specified\&.

.sp
The location can be given explicitly, or as a series of directions
with distances\&. In the latter case the names of all known directions
are accepted for the direction part\&.
If no distance is specified for a direction the system falls back to

the value taken from the language variable \fBmovelength\fR, which
itself defaults to the pixel equivalent of \fB2 cm\fR\&.
The whole set of direction,distance pairs is treated as a series of
translations which are added up to provide the final translation
specifying the intermediate point (relative to the preceding point)\&.
.sp
The last named direction is propagated to the layout system as the
direction to follow\&. The use of \fBnoturn\fR is not able to overide
this behaviour\&.
.sp
At last, the names of the registered directions also serve as
attribute commands, with an implicit attribute \fBthen\fR in front of


them\&.
.sp
If no intermediate or last location is specified for the line the
system falls back to a point \fBmovelength\fR pixels away from the
starting location, in the current direction as maintained by the
layouting system
.TP
\fBto\fR \fIlocation\fR
Specifies the location where the \fBline\fR element ends\&.
This attribute has no default\&. The default is handled by the attribute
\fBthen\fR, which makes it appear as if \fBto\fR has a default when

not specified\&.

.TP
\fBwith\fR \fIcorner\fR
\fBLine\fR elements are normally positioned absolutely, using the
locations specified through the attributes \fBfrom\fR, \fBthen\fR, and
\fBto\fR\&.
If \fBat\fR is specified however then these positions are translated a
last time, moving the line's corner named by the attribute \fBwith\fR
to the location given by this attribute\&.
This means that \fIwith\fR is effective if and only if the attribute
\fBat\fR was specified as well for the line\&.

.RE
.TP
\fBmove\fR \fIattr\fR
An open element with the corresponding corners, i\&.e\&. "start", "end",
and "center"\&.
A \fBmove\fR element is in essence an invisible \fBline\fR\&.
While the main effect we are interested in is the change it makes to
the layout system, it is an actual element, i\&.e\&. it has the same
corners as an ordinary line, and shows up in the history as well,
allowing future references to all the places it touched\&.
It handles the same attibutes as \fBline\fR elements\&.
.TP
\fBspline\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-spline
An alias for the \fBline\fR element (see above), with the attribute
\fBsmooth\fR preset\&.
.TP
\fBtext\fR \fIattr\fR\&.\&.\&.
IMAGE: figure-02-text
A closed element with the corresponding corners, i\&.e\&. the eight
directions of the compass rose, and "center"\&.
It handles the attributes
.RS
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.



































































































































































The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBat\fR \fIlocation\fR
Specifies the location of the element's corner named by the attribute
\fBwith\fR\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP













\fBheight\fR \fIlength\fR


Specifies the height of the \fBtext\fR element\&.

Defaults to the natural height of its text\&.

.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP





































\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBwidth\fR \fIlength\fR


Specifies the width of the \fBtext\fR element\&.

Defaults to the natural width of its text\&.

.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.RE
.PP

.SS ATTRIBUTES
The set of all attributes supported by all the element commands is
shown below\&.
While we speak of them as commands, and provide a syntax, they are not
truly available as actual commands, but only as part of the arguments
for an element command\&.
.PP
Note that some of the attribute names are overloaded, i\&.e\&. have
multiple, different, definitions\&. During processing of attributes for
an element the actual definition used is chosen based on the type of
the element the processing is for\&.
.PP
Further, as a catch-all clause, any attribute which could not be
processed according to the definitions below will be treated as the
argument of an implicit \fBtext\fR attribute\&.
.TP
\fBanchor\fR \fIname\fR
.TP
\fBljust\fR
.TP
\fBrjust\fR
.TP
\fBabove\fR
.TP
\fBbelow\fR
IMAGE: figure-22-text-anchoring-3
Specifies the anchor of the text which is to be placed at the
element's center, by name\&. I\&.e\&. this attribute defines the text's
position relative to the element's center\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBanchor\fR, which itself defaults to
\fBcenter\fR\&.
The legal values are all those accepted by
\fITk_GetAnchor\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetAnchor\&.htm]\&.
The commands without arguments are all shorthands with the anchor
implied\&. Note that they do not combine, only the last is used\&. For
comined directions the main attribute command, \fBanchor\fR has to be
used\&.
.RS
.TP
\fBljust\fR
"anchor west"
.TP
\fBrjust\fR
"anchor east"
.TP
\fBabove\fR
"anchor south"
.TP
\fBbelow\fR
"anchor north"
.RE
.TP
\fBarrowhead\fR \fIspec\fR
IMAGE: figure-19-style-arrowheads
Specifies where to draw arrowheads on the \fBline\fR element, at the
beginning or end, at both ends, or none\&.
If not specified the system falls back to the value taken from the


































































language variable \fBarrowhead\fR, which itself defaults to



\fBnone\fR\&.






















The legal values are


.RS
.TP
\fBnone\fR, \fB-\fR
Draw no arrowheads, at neither end of the line\&.
.TP
\fBstart\fR, \fBfirst\fR, \fB<-\fR
Draw an arrowhead at the beginning of the line, but not at its end\&.
.TP
\fBend\fR, \fBlast\fR, \fB->\fR
Draw an arrowhead at the end of the line, but not at its beginning\&.
.TP
\fBboth\fR, \fB<->\fR
Draw arrowheads at both ends of the line\&.
.RE
.IP
Note that the values "start", "end", "-", "->", "<-", and "<->" are
all accepted as shorthands for the \fBarrowhead\fR command using them
as argument\&.
.TP








\fBaspect\fR \fInumber\fR
Specifies the aspect ratio, i\&.e ratio of width to height, of the



\fBdiamond\fR element\&.




The manner in which a default is calculated when not specified also




depends on the specifications of the attributes \fBwidth\fR and



\fBheight\fR, if any\&.












.sp



If both \fBwidth\fR, and \fBheight\fR are specified then any

specification of \fBaspect\fR is ignored, as it is implicitly defined








in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp









If the \fBaspect\fR is specified, and one of the attributes







\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated

from the two which are specified\&. No defaults are required for these




cases either\&.






.sp









If only one of the attributes \fBwidth\fR or \fBheight\fR is specified








then the system uses a fallback for the \fBaspect\fR, the value taken

from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.














.sp















If none of of the attributes \fBwidth\fR or \fBheight\fR is specified












then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to




the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.



.TP
\fBaspect\fR \fInumber\fR
Specifies the aspect ratio, i\&.e ratio of width to height, of the


ellipses which are used to draw the top and bottom of the \fBdrum\fR



element\&.

If not specified the system falls back to the value taken from the
language variable \fBdrumaspect\fR, which itself defaults to
\fB0\&.35\fR\&.
.TP






\fBat\fR \fIlocation\fR


































Specifies the location of the element's corner named by the attribute


\fBwith\fR\&.



Defaults to the current location as maintained by the layouting




system\&.

.TP
\fBat\fR \fIlocation\fR











\fBLine\fR elements are normally positioned absolutely, using the

locations specified through the attributes \fBfrom\fR, \fBthen\fR, and

\fBto\fR\&.























If \fBat\fR is specified however then these positions are translated a













































last time, moving the line's corner named by the attribute \fBwith\fR
to the location given by this attribute\&.
.TP
\fBchop\fR ?\fIlength\fR?
Specifies the length of the \fBline\fR element to remove from the
beginning and/or end\&.
Defaults to nothing\&.
If specified once the chopping applies to both beginning and end of
the line\&.
If specified twice or more the last two specifications are used, and
applied to beginning and end of the line, in this order\&.
Whenever the attribute is specified without an explicit length, the
system falls back to the value taken from the language variable
\fBcircleradius\fR, which itself defaults to the pixel equivalent of
\fB1 cm\fR
.TP
\fBclockwise\fR
.TP
\fBcw\fR
Specifies the direction of the \fBarc\fR element, here going
clockwise\&.
The complementary attribute is \fBcounterclockwise\fR\&.
If not specified the system falls back to the value taken from the
language variable \fBclockwise\fR, which itself defaults to
\fBfalse\fR, for counter-clockwise direction\&.
.TP
\fBcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinecolor\fR, which itself defaults to \fBblack\fR\&.
.TP
\fBcounterclockwise\fR
.TP
\fBccw\fR
Specifies the direction of the \fBarc\fR element, here
counter-clockwise\&.
The complementary attribute is \fBclockwise\fR\&.
If not specified the system falls back to the value taken from the
language variable \fBclockwise\fR, which itself defaults to
\fBfalse\fR, for counter-clockwise direction\&.
.TP
\fBdiameter\fR \fIlength\fR
.TP
\fBdiam\fR \fIlength\fR
Specifies the diameter of the \fBcircle\fR element, as an alternative
way to specify its \fBradius\fR\&.
Effective if and only if the radius was not specified\&. I\&.e\&. if both
diameter and radius are specified then the radius infomration has
precendence\&.
This attribute has no default, because the defaults are taken from the
radius\&.
.TP
\fBfillcolor\fR \fIspec\fR
IMAGE: figure-21-style-colors
Specifies the color used to draw the inside of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBfillcolor\fR, which itself defaults to the empty
string, signaling "no filling"\&.
.TP
\fBfrom\fR \fIlocation\fR
Specifies the location where the \fBline\fR element begins\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBfrom\fR \fIlocation\fR
Specifies the location where the \fBarc\fR element begins\&.
Defaults to the current location as maintained by the layouting
system\&.
.TP
\fBheight\fR \fIlength\fR
.TP
\fBht\fR \fIlength\fR
Specifies the height of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxheight\fR, which itself defaults to the
pixel equivalent of \fB2 cm\fR\&.
.TP
\fBheight\fR \fIlength\fR
Specifies the height of the \fBdiamond\fR element\&.
The manner in which a default is calculated when not specified also
depends on the specifications of the attributes \fBaspect\fR and
\fBwidth\fR, if any\&.
.sp
If both \fBwidth\fR, and \fBheight\fR are specified then any
specification of \fBaspect\fR is ignored, as it is implicitly defined
in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp
If the \fBaspect\fR is specified, and one of the attributes
\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated
from the two which are specified\&. No defaults are required for these
cases either\&.
.sp
If only one of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBaspect\fR, the value taken
from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.
.sp
If none of of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to
the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.
.TP
\fBheight\fR \fIlength\fR
Specifies the height of the \fBtext\fR element\&.
Defaults to the natural height of its text\&.
.TP
\fBjustify\fR \fBleft\fR|\fBcenter\fR|\fBright\fR
Specifies how multi-line text associated with the element is
positioned within its box\&.
The value is ignored if no text was specified for the element\&.
If not specified the system falls back to the value taken from the
language variable \fBjustify\fR, which itself defaults to
\fBleft\fR\&.
The legal values are \fBleft\fR, \fBright\fR, and \fBcenter\fR\&.
.TP
\fBnoturn\fR
Specifies that the direction of \fBline\fR element at its end is not
propagated to the layout management\&.
If not specified the direction of the line becomes the new direction
the layout\&.
.TP
\fBradius\fR \fIlength\fR
.TP
\fBrad\fR \fIlength\fR
Specifies the radius of the \fBcircle\fR element\&.
If not specified the system falls back to the value taken from the
language variable \fBcircleradius\fR, which itself defaults to the
pixel equivalent of \fB1 cm\fR\&.
.TP
\fBradius\fR \fIlength\fR
Specifies the radius of the \fBarc\fR element, or rather, the radius
of the circle the shown arc is a part of\&.
If not specified the system falls back to the value taken from the
language variable \fBarcradius\fR, which itself defaults to the pixel
equivalent of \fB1 cm\fR\&.
.TP
\fBslant\fR \fIangle\fR
Specifies the angle by which the \fBbox\fR element is slanted, in
degrees\&.
If not specified the system falls back to the value taken from the
language variable \fBslant\fR, which itself defaults to \fB90\fR,
i\&.e\&. vertical, no slant\&.
0 degrees is slanting straight east, pointing to the right\&.
90 degrees is slanting to the north, pointing straight up\&.
.TP
\fBsmooth\fR
Specifies the use of bezier splines for the \fBline\fR element\&.
If not specified lines are drawn exactly through the specified
waypoints, without any smooth curves\&.
.TP
\fBstroke\fR \fIwidth\fR
IMAGE: figure-20-style-stroke
Specifies the width of the lines drawn for the the element, in pixels\&.
If not specified the system falls back to the value taken from the
language variable \fBlinewidth\fR, which itself defaults to \fB1\fR\&.
.TP
\fBstyle\fR \fIspec\fR
IMAGE: figure-18-style-dash
Specifies the style used to draw the lines of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBlinestyle\fR, which itself defaults to
\fBsolid\fR lines\&.
The legal values are all those accepted by
\fITk_GetDash\fR [http://www\&.tcl\&.tk/man/tcl8\&.5/TkLib/GetDash\&.htm],
and additionally all which are listed below:
.RS
.TP
\fBsolid\fR, empty string
Draw solid line\&.
.TP
\fBdash\fR, \fBdashed\fR, \fB-\fR
Draw a dashed line\&.
.TP
\fBdot\fR, \fBdotted\fR, \fB\&.\fR
Draw a dotted line\&.
.TP
\fBdash-dot\fR, \fB-\&.\fR
Draw a dash-dotted line
.TP
\fBdash-dot-dot\fR, \fB-\&.\&.\fR
Draw a dash-dot-dotted line\&.
.RE
.IP
Note that the values "solid", "dot(ted)", "dash(ed)", "dash-dot", and
"dash-dot-dot" are all accepted as shorthands for the \fBstyle\fR
command using them as argument\&.
.TP
\fBtext\fR \fIstring\fR
Specifies the text to associate with the element\&.
Defaults to nothing\&.
When specified multiple times the actually shown text is the
concatenation of the individual strings, vertically stacked, with the
first string specified being the topmost element\&.
.TP
\fBtextcolor\fR \fIspec\fR
Specifies the color used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextcolor\fR, which itself defaults to
\fBblack\fR\&.
.TP
\fBtextfont\fR \fIspec\fR
Specifies the font used to draw the text of an element with\&.
Ignored if there is no text\&.
If not specified the system falls back to the value taken from the
language variable \fBtextfont\fR, which itself defaults to
\fBHelvetica 12pt\fR\&.
.TP
\fBthen\fR \fIlocation\fR
.TP
\fBthen\fR (<direction> ?\fIlength\fR?)\&.\&.\&.
.TP
(<direction> ?\fIlength\fR?)\&.\&.\&.
This attribute specifies an intermediate location the \fBline\fR
element has to go through\&.
It can be specified multiple times, with each use adding one
additional location to the series which the line will go
through\&. These location will be traversed in the order they were
specified\&.
.sp
The location can be given explicitly, or as a series of directions
with distances\&. In the latter case the names of all known directions
are accepted for the direction part\&.
If no distance is specified for a direction the system falls back to
the value taken from the language variable \fBmovelength\fR, which
itself defaults to the pixel equivalent of \fB2 cm\fR\&.
The whole set of direction,distance pairs is treated as a series of
translations which are added up to provide the final translation
specifying the intermediate point (relative to the preceding point)\&.
.sp
The last named direction is propagated to the layout system as the
direction to follow\&. The use of \fBnoturn\fR is not able to overide
this behaviour\&.
.sp
At last, the names of the registered directions also serve as
attribute commands, with an implicit attribute \fBthen\fR in front of
them\&.
.sp
If no intermediate or last location is specified for the line the
system falls back to a point \fBmovelength\fR pixels away from the
starting location, in the current direction as maintained by the
layouting system
.TP
\fBto\fR \fIlocation\fR
Specifies the location where the \fBline\fR element ends\&.
This attribute has no default\&. The default is handled by the attribute
\fBthen\fR, which makes it appear as if \fBto\fR has a default when
not specified\&.
.TP
\fBto\fR \fIlocation\fR
Specifies the location where the \fBarc\fR element ends\&.
Defaults to a location such that a 90-degree arc is drawn in the
chosen direction, starting at \fBfrom\fR\&.
.TP
\fBwidth\fR \fIlength\fR
.TP
\fBwid\fR \fIlength\fR
Specifies the width of the element\&.
If not specified the system falls back to the value taken from the
language variable \fBboxwidth\fR, which itself defaults to the pixel
equivalent of \fB2 cm\fR\&.
.TP
\fBwidth\fR \fIlength\fR
Specifies the width of the \fBdiamond\fR element\&.
The manner in which a default is calculated when not specified also
depends on the specifications of the attributes \fBaspect\fR and
\fBheight\fR, if any\&.
.sp
If both \fBwidth\fR, and \fBheight\fR are specified then any
specification of \fBaspect\fR is ignored, as it is implicitly defined
in the width and height as well, and this takes precedence\&. A missing
specification is ignored in that case well, i\&.e\&. no defaults are
required\&.
.sp
If the \fBaspect\fR is specified, and one of the attributes
\fBwidth\fR or \fBheight\fR, then the missing attribute is calculated
from the two which are specified\&. No defaults are required for these
cases either\&.
.sp
If only one of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBaspect\fR, the value taken
from the language variable \fBdiamondaspect\fR, which itselfs defaults
to \fB2\fR\&.
.sp
If none of of the attributes \fBwidth\fR or \fBheight\fR is specified
then the system uses a fallback for the \fBwidth\fR, the value taken
from the language variable \fBboxwidth\fR, which itselfs defaults to
the pixel equivalent of \fB2 cm\fR\&. For the aspect it uses either
the user-specified value or the default taken as described in the
previous paragraph\&.
.TP
\fBwidth\fR \fIlength\fR
Specifies the width of the \fBtext\fR element\&.
Defaults to the natural width of its text\&.
.TP
\fBwith\fR \fIcorner\fR
Specifies the corner of the element to place at the location given by
the attribute \fBat\fR\&.
Defaults to the current corner as maintained by the layouting system,
except if the value for \fBat\fR was specified by the user\&. In that
case it defaults to \fBcenter\fR\&.
.TP
\fBwith\fR \fIcorner\fR
\fBLine\fR elements are normally positioned absolutely, using the
locations specified through the attributes \fBfrom\fR, \fBthen\fR, and
\fBto\fR\&.
If \fBat\fR is specified however then these positions are translated a
last time, moving the line's corner named by the attribute \fBwith\fR
to the location given by this attribute\&.
This means that \fIwith\fR is effective if and only if the attribute
\fBat\fR was specified as well for the line\&.
.PP
.SS CORNERS
Corners are named values for in elements, usually locations\&.
.IP \(bu
The \fIclosed\fR elements define corners for the compass rose,
including the "center", and their "width" and "height"\&.
.sp
IMAGE: figure-27-corners-closed
.sp
.IP \(bu
\fBblock\fR elements additionally export all variables which were set
during their definition as corners\&.
.IP \(bu
The \fIopen\fR elements on the other hand define "start", "end", and
"center"\&. The first two map to the locations originally provided
through the attributes \fBfrom\fR and \fBto\fR of the element\&.
.sp
IMAGE: figure-28-corners-open
.sp
.IP \(bu
The center of \fBline\fR and \fBmove\fR elements is the location
halfway between "start" and "end" corners, this is regardless of any
intermediate locations the element may have\&.
.IP \(bu
The \fBline\fR and \fBmove\fR elements additionally name all their
locations as corners using numbers as names, starting from \fB1\fR
(equivalent to "start"), in order of traversal\&.
.sp
IMAGE: figure-15-spline-1
.sp
.IP \(bu
The center of \fBarc\fR elements is the center of the circle the arc
is part off\&.
.IP \(bu
The \fBarc\fR elements additionally define the compass rose of
closed elements as well\&.
.PP
.SS "NAMED DIRECTIONS"
The named directions are commands which tell the layout system in
which direction to go when placing the next element without an
explicit position specification\&.
They can also be used as arguments to the attribute \fBthen\fR, and
the command \fBby\fR for relative points, see there for the relevant
syntax\&.
.PP
The diagram core defines the directions of the compass rose, plus a
number of aliases\&. See below for the full list\&.
.PP
IMAGE: figure-27-corners-closed
.PP
This overlaps with the pre-defined corners for closed elements\&. This
is used by the layout system, when are going in direction X the name
of the opposite direction is the name of the corner at which the new
element will be attached to the current position, and if this corner
does not exist the nearest actual corner by angle is used\&.
.PP
.TP
\fBwest\fR
.TP
\fBw\fR
.TP
\fBleft\fR