summaryrefslogtreecommitdiffstats
path: root/doc/ttk_treeview.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commitd4a63ee0259256e40eba77a360b9902afc472bc4 (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_treeview.n
parent318393c4af319ed15ef4a5d6e3f5b12259fe695d (diff)
downloadtk-d4a63ee0259256e40eba77a360b9902afc472bc4.zip
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.gz
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.bz2
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_treeview.n')
-rw-r--r--doc/ttk_treeview.n32
1 files changed, 22 insertions, 10 deletions
diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n
index a15bfe9..0770c7c 100644
--- a/doc/ttk_treeview.n
+++ b/doc/ttk_treeview.n
@@ -1,14 +1,22 @@
'\"
'\" Copyright (c) 2004 Joe English
'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" RCS: @(#) $Id: ttk_treeview.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
+'\"
.so man.macros
.TH ttk_treeview n 8.5 Tk "Tk Themed Widget"
+.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk::treeview \- hierarchical multicolumn data display widget
+ttk_treeview \- hierarchical multicolumn data display widget
.SH SYNOPSIS
\fBttk::treeview\fR \fIpathname \fR?\fIoptions\fR?
-.SH "DESCRIPTION"
-The treeview widget displays a hierarchical collection of items.
+.BE
+
+.SH DESCRIPTION
+The \fBttk::treeview\fR widget displays a hierarchical collection of items.
Each item has a textual label, an optional image,
and an optional list of data values.
The data values are displayed in successive columns after
@@ -40,7 +48,8 @@ They probably ought to support horizontal scrolling as well.
\-class \-cursor \-takefocus \-style
\-yscrollcommand
.SE
-.SH "WIDGET OPTIONS"
+
+.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-columns columns Columns
A list of column identifiers,
specifying the number of columns and their names.
@@ -85,6 +94,7 @@ The default is \fBtree headings\fR, i.e., show all elements.
\fBNOTE:\fR Column #0 always refers to the tree column,
even if \fB-show tree\fR is not specified.
.RE
+
.SH "WIDGET COMMAND"
.TP
\fIpathname \fBbbox\fR \fIitem\fR ?\fIcolumn\fR?
@@ -97,7 +107,7 @@ If the \fIitem\fR is not visible
returns the empty list.
.TP
\fIpathname \fBcget\fR \fIoption\fR
-Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR.
+Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
.TP
\fIpathname \fBchildren\fR \fIitem\fR ?\fInewchildren\fR?
If \fInewchildren\fR is not specified,
@@ -139,7 +149,7 @@ Use \fIpathname column #0\fR to configure the tree column.
.RE
.TP
\fIpathname \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
-Modify or query widget options; see \fIwidget(n)\fR.
+Modify or query widget options; see \fIttk_widget(n)\fR.
.TP
\fIpathname \fBdelete\fR \fIitemList\fR
Deletes each of the items in \fIitemList\fR and all of their descendants.
@@ -225,7 +235,7 @@ newly created item.
See \fBITEM OPTIONS\fR for the list of available options.
.TP
\fIpathname \fBinstate \fIstatespec\fR ?\fIscript\fR?
-Test the widget state; see \fIwidget(n)\fR.
+Test the widget state; see \fIttk_widget(n)\fR.
.TP
\fIpathname \fBitem\fR \fIitem\fR ?\fI-option \fR?\fIvalue -option value...\fR?
Query or modify the options for the specified \fIitem\fR.
@@ -289,7 +299,7 @@ in item \fIitem\fR to the specified \fIvalue\fR.
See also \fBCOLUMN IDENTIFIERS\fR.
.TP
\fIpathname \fBstate\fR ?\fIstateSpec\fR?
-Modify or query the widget state; see \fIwidget(n)\fR.
+Modify or query the widget state; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBtag \fIargs...\fR
.RS
@@ -322,7 +332,7 @@ See \fBTAG OPTIONS\fR for the list of available options.
.RE
.TP
\fIpathName \fByview \fIargs\fR
-Standard command for vertical scrolling; see \fIwidget(n)\fR.
+Standard command for vertical scrolling; see \fIttk_widget(n)\fR.
.PP
.SH "ITEM OPTIONS"
@@ -361,6 +371,7 @@ Specifies the font to use when drawing text.
Specifies the item image, in case the item's \fB-image\fR option is empty.
.PP
\fI(@@@ TODO: sort out order of precedence for options)\fR
+
.SH "COLUMN IDENTIFIERS"
Column identifiers take any of the following forms:
.IP \(bu
@@ -398,5 +409,6 @@ The \fBfocus\fR and \fBselection\fR widget commands can be used
to determine the affected item or items.
In Tk 8.5, the affected item is also passed as the \fB-detail\fR field
of the virtual event.
+
.SH "SEE ALSO"
-widget(n), listbox(n), image(n), bind(n)
+ttk_widget(n), listbox(n), image(n), bind(n)