.\"
.\" Copyright (c) 2025 Csaba Nemethi
.\"
.\" See the file "license.terms" for information on usage and redistribution
.\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
.\"
.TH tk attribtable n 9.1 "" Tk "Tk Built-in Commands"
.\" The -*- nroff -*- definitions below are for supplemental macros used
.\" in Tcl/Tk manual entries.
.\"
.\" .AP type name in/out ?indent?
.\"	Start paragraph describing an argument to a library procedure.
.\"	type is type of argument (int, etc.), in/out is either "in", "out",
.\"	or "in/out" to describe whether procedure reads or modifies arg,
.\"	and indent is equivalent to second arg of .IP (shouldn't ever be
.\"	needed;  use .AS below instead)
.\"
.\" .AS ?type? ?name?
.\"	Give maximum sizes of arguments for setting tab stops.  Type and
.\"	name are examples of largest possible arguments that will be passed
.\"	to .AP later.  If args are omitted, default tab stops are used.
.\"
.\" .BS
.\"	Start box enclosure.  From here until next .BE, everything will be
.\"	enclosed in one large box.
.\"
.\" .BE
.\"	End of box enclosure.
.\"
.\" .CS
.\"	Begin code excerpt.
.\"
.\" .CE
.\"	End code excerpt.
.\"
.\" .VS ?version? ?br?
.\"	Begin vertical sidebar, for use in marking newly-changed parts
.\"	of man pages.  The first argument is ignored and used for recording
.\"	the version when the .VS was added, so that the sidebars can be
.\"	found and removed when they reach a certain age.  If another argument
.\"	is present, then a line break is forced before starting the sidebar.
.\"
.\" .VE
.\"	End of vertical sidebar.
.\"
.\" .DS
.\"	Begin an indented unfilled display.
.\"
.\" .DE
.\"	End of indented unfilled display.
.\"
.\" .SO ?manpage?
.\"	Start of list of standard options for a Tk widget. The manpage
.\"	argument defines where to look up the standard options; if
.\"	omitted, defaults to "options". The options follow on successive
.\"	lines, in three columns separated by tabs.
.\"
.\" .SE
.\"	End of list of standard options for a Tk widget.
.\"
.\" .OP cmdName dbName dbClass
.\"	Start of description of a specific option.  cmdName gives the
.\"	option's name as specified in the class command, dbName gives
.\"	the option's name in the option database, and dbClass gives
.\"	the option's class in the option database.
.\"
.\" .UL arg1 arg2
.\"	Print arg1 underlined, then print arg2 normally.
.\"
.\" .QW arg1 ?arg2?
.\"	Print arg1 in quotes, then arg2 normally (for trailing punctuation).
.\"
.\" .PQ arg1 ?arg2?
.\"	Print an open parenthesis, arg1 in quotes, then arg2 normally
.\"	(for trailing punctuation) and then a closing parenthesis.
.\"
.\"	# Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
.if t .wh -1.3i ^B
.nr ^l \n(.l
.ad b
.\"	# Start an argument description
.de AP
.ie !"\\$4"" .TP \\$4
.el \{\
.   ie !"\\$2"" .TP \\n()Cu
.   el          .TP 15
.\}
.ta \\n()Au \\n()Bu
.ie !"\\$3"" \{\
\&\\$1 \\fI\\$2\\fP (\\$3)
.\".b
.\}
.el \{\
.br
.ie !"\\$2"" \{\
\&\\$1	\\fI\\$2\\fP
.\}
.el \{\
\&\\fI\\$1\\fP
.\}
.\}
..
.\"	# define tabbing values for .AP
.de AS
.nr )A 10n
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
.nr )B \\n()Au+15n
.\"
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
.nr )C \\n()Bu+\\w'(in/out)'u+2n
..
.AS Tcl_Interp Tcl_CreateInterp in/out
.\"	# BS - start boxed text
.\"	# ^y = starting y location
.\"	# ^b = 1
.de BS
.br
.mk ^y
.nr ^b 1u
.if n .nf
.if n .ti 0
.if n \l'\\n(.lu\(ul'
.if n .fi
..
.\"	# BE - end boxed text (draw box now)
.de BE
.nf
.ti 0
.mk ^t
.ie n \l'\\n(^lu\(ul'
.el \{\
.\"	Draw four-sided box normally, but don't draw top of
.\"	box if the box started on an earlier page.
.ie !\\n(^b-1 \{\
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.el \}\
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
.\}
.\}
.fi
.br
.nr ^b 0
..
.\"	# VS - start vertical sidebar
.\"	# ^Y = starting y location
.\"	# ^v = 1 (for troff;  for nroff this doesn't matter)
.de VS
.if !"\\$2"" .br
.mk ^Y
.ie n 'mc \s12\(br\s0
.el .nr ^v 1u
..
.\"	# VE - end of vertical sidebar
.de VE
.ie n 'mc
.el \{\
.ev 2
.nf
.ti 0
.mk ^t
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
.sp -1
.fi
.ev
.\}
.nr ^v 0
..
.\"	# Special macro to handle page bottom:  finish off current
.\"	# box/sidebar if in box/sidebar mode, then invoked standard
.\"	# page bottom macro.
.de ^B
.ev 2
'ti 0
'nf
.mk ^t
.if \\n(^b \{\
.\"	Draw three-sided box if this is the box's first page,
.\"	draw two sides but no top otherwise.
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
.\}
.if \\n(^v \{\
.nr ^x \\n(^tu+1v-\\n(^Yu
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
.\}
.bp
'fi
.ev
.if \\n(^b \{\
.mk ^y
.nr ^b 2
.\}
.if \\n(^v \{\
.mk ^Y
.\}
..
.\"	# DS - begin display
.de DS
.RS
.nf
.sp
..
.\"	# DE - end display
.de DE
.fi
.RE
.sp
..
.\"	# SO - start of list of standard options
.de SO
'ie '\\$1'' .ds So \\fBoptions\\fR
'el .ds So \\fB\\$1\\fR
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 5.5c 11c
.ft B
..
.\"	# SE - end of list of standard options
.de SE
.fi
.ft R
.LP
See the \\*(So manual entry for details on the standard options.
..
.\"	# OP - start of full description for a single option
.de OP
.LP
.nf
.ta 4c
Command-Line Name:	\\fB\\$1\\fR
Database Name:	\\fB\\$2\\fR
Database Class:	\\fB\\$3\\fR
.fi
.IP
..
.\"	# CS - begin code excerpt
.de CS
.RS
.nf
.ta .25i .5i .75i 1i
..
.\"	# CE - end code excerpt
.de CE
.fi
.RE
..
.\"	# UL - underline word
.de UL
\\$1\l'|0\(ul'\\$2
..
.\"	# QW - apply quotation marks to word
.de QW
.ie '\\*(lq'"' ``\\$1''\\$2
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\$2
..
.\"	# PQ - apply parens and quotation marks to word
.de PQ
.ie '\\*(lq'"' (``\\$1''\\$2)\\$3
.\"" fix emacs highlighting
.el (\\*(lq\\$1\\*(rq\\$2)\\$3
..
.\"	# QR - quoted range
.de QR
.ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
.\"" fix emacs highlighting
.el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
..
.\"	# MT - "empty" string
.de MT
.QW ""
..
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
attribtable \- Create an attribute table, used to query and modify
arbitrary data attached to any widget.
.SH SYNOPSIS
\fBtk attribtable \fItableName\fR
.BE
.SH DESCRIPTION
.PP
This command creates an attribute table of the name \fItableName\fR,
implemented as a hash table and accessible as a command in the namespace of
the calling context if not fully qualified, and returns the fully qualified
name of the command just created.
.PP
An attribute table is used to query and modify arbitrary data attached to any
widget.  These data are commonly called \fIattributes\fR.
.PP
If an attribute table of the given name already exists then it is replaced
with the new one and all the attributes of all widgets set using the old table
instance will be unset.
.PP
\fBREMARK 1:\fR  When the \fItableName\fR command is deleted (via \fBrename\fR
\fItableName\fR "" or by deleting the containing namespace), all the
attributes of all widgets set using this command are automatically unset and
the underlying hash table is deleted.  This will free all the memory used by
the table.
.PP
\fBREMARK 2:\fR  When a widget is destroyed, all of its attributes set by all
attribute table commands are automatically unset.  This will free all the
memory used by the widget's attributes.
.PP
The command \fItableName\fR created by this command has the signature
.PP
.CS
\fItableName\fR \fBset\fR|\fBget\fR|\fBunset\fR|\fBclear\fR|\fBexists\fR|\fBnames\fR|\fBpathnames\fR \fIargs\fR
.CE
.PP
In the description of the supported forms below, \fIpathName\fR specifies a
widget whose attributes are being queried or modified via the \fItableName\fR
command.
.\" METHOD: set
.TP
\fItableName\fR \fBset\fR \fIpathName name value\fR ?\fIname value\fR ...?
.
Sets (i.e., adds or updates) the attributes identified by the \fIname\fR
arguments to the values given by the \fIvalue\fR arguments.  Returns an empty
string.  Example:
.RS
.PP
.CS
# Save and then change the button's text
\fBtk attribtable\fR table
table \fBset\fR .btn prevText [.btn cget -text]
\&.btn configure -text "NewText"
.CE
.RE
.\" METHOD: get
.TP
\fItableName\fR \fBget\fR \fIpathName\fR ?\fIname\fR ?\fIdefaultValue\fR??
.
If \fIname\fR is specified then returns the corresponding attribute value, or
an empty string or \fIdefaultValue\fR (if given) if no corresponding value
exists.  Otherwise returns a list consisting of all attribute names and values
of the widget \fIpathName\fR.  Example:
.RS
.PP
.CS
# Restore the button's previous text
\&.btn configure -text [table \fBget\fR .btn prevText]
.CE
.RE
.\" METHOD: unset
.TP
\fItableName\fR \fBunset\fR \fIpathName name\fR ?\fIname\fR ...?
.
Unsets the attributes identified by the \fIname\fR arguments.  Returns an
empty string.  Example:
.RS
.PP
.CS
table \fBunset\fR .btn prevText
.CE
.RE
.\" METHOD: clear
.TP
\fItableName\fR \fBclear\fR \fIpathName\fR
.
Unsets all attributes and removes \fIpathName\fR from the list of those
widgets that have attributes set via \fItableName\fR \fBset\fR.  Returns an
empty string.  Example:
.RS
.PP
.CS
table \fBclear\fR .btn
.CE
.RE
.\" METHOD: exists
.TP
\fItableName\fR \fBexists\fR \fIpathName\fR ?\fIname\fR?
.
If the optional argument is present then returns \fB1\fR if the attribute
identified by \fIname\fR exists and \fB0\fR otherwise.  Without the optional
argument the return value is \fB1\fR if the widget \fIpathName\fR has at
least one attribute set via \fItableName\fR \fBset\fR and \fB0\fR otherwise.
Example:
.RS
.PP
.CS
if [table \fBexists\fR .btn prevText] {
    # Restore the button's previous text
    \&.btn configure -text [table \fBget\fR .btn prevText]
}
.CE
.RE
.\" METHOD: names
.TP
\fItableName\fR \fBnames\fR \fIpathName\fR
.
Returns a list consisting of all attribute names of the widget
\fIpathName\fR.  Example:
.RS
.PP
.CS
puts "attribute names for .btn: [table \fBnames\fR .btn]"
.CE
.RE
.\" METHOD: pathnames
.TP
\fItableName\fR \fBpathnames\fR
.
Returns a list consisting of the path names of all widgets that have
attributes set via \fItableName\fR \fBset\fR.
Example:
.RS
.PP
.CS
puts "widgets in table: [table \fBpathnames\fR]"
.CE
.RE
.SH KEYWORDS
widget, attribute, attribute table
.\" Local Variables:
.\" mode: nroff
.\" fill-column: 78
.\" End: