Added note that the 'move' operation restores detached nodes.

2 files changed, 36 insertions, 30 deletions

diff --git a/ChangeLog b/ChangeLog
index fe653d1..65ee2fb 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,19 +1,24 @@
+2009-11-15  Donal K. Fellows  <dkf@users.sf.net>
+
+	* doc/ttk_treeview.n (detach): Added note that the 'move' operation
+	restores detached nodes.
+
 2009-11-12  Joe English  <jenglish@users.sourceforge.net>
 
 	* library/ttk/button.tcl, library/ttk/combobox.tcl,
-	library/ttk/notebook.tcl, library/ttk/treeview.tcl: 
+	* library/ttk/notebook.tcl, library/ttk/treeview.tcl: 
 	[update] hygiene.
 
 	+ Where possible, replace [a; update; b] with [a ; after 0 b].
 	+ Where not possible, use [update idletasks] instead of full [update].
-	+ Use [after 0] in favor of [after idle] for delayed work,
-	  to reduce likelihood of reentrancy issues in [update idletasks].
+	+ Use [after 0] in favor of [after idle] for delayed work, to reduce
+	likelihood of reentrancy issues in [update idletasks].
 
 2009-11-11  Don Porter  <dgp@users.sourceforge.net>
 
-	* generic/tkPlatDecls.h:	Restore C++ friendliness to the
-	tkPlatDecls.h header file, which we insist extensions #include to
-	gain access to the Tk_*HWND*() routines.  [Bug 2886635].
+	* generic/tkPlatDecls.h:	[Bug 2886635]: Restore C++
+	friendliness to the tkPlatDecls.h header file, which we insist
+	extensions #include to gain access to the Tk_*HWND*() routines.
 
 2009-11-10  Andreas Kupries  <andreask@activestate.com>
 
diff --git a/doc/ttk_treeview.n b/doc/ttk_treeview.n
index b81ca35..f351fb3 100644
--- a/doc/ttk_treeview.n
+++ b/doc/ttk_treeview.n
@@ -4,7 +4,7 @@
 '\" 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.20 2008/09/23 13:36:58 dkf Exp $
+'\" RCS: @(#) $Id: ttk_treeview.n,v 1.21 2009/11/15 21:09:22 dkf Exp $
 '\" 
 .so man.macros
 .TH ttk::treeview n 8.5 Tk "Tk Themed Widget"
@@ -12,7 +12,7 @@
 .SH NAME
 ttk::treeview \- hierarchical multicolumn data display widget
 .SH SYNOPSIS
-\fBttk::treeview\fR \fIpathname \fR?\fIoptions\fR?
+\fBttk::treeview \fIpathname \fR?\fIoptions\fR?
 .BE
 .SH DESCRIPTION
 .PP
@@ -98,7 +98,7 @@ even if \fB\-show tree\fR is not specified.
 .SH "WIDGET COMMAND"
 .PP
 .TP
-\fIpathname \fBbbox\fR \fIitem\fR ?\fIcolumn\fR?
+\fIpathname \fBbbox \fIitem\fR ?\fIcolumn\fR?
 Returns the bounding box (relative to the treeview widget's window)
 of the specified \fIitem\fR
 in the form \fIx y width height\fR.
@@ -107,10 +107,10 @@ If the \fIitem\fR is not visible
 (i.e., if it is a descendant of a closed item or is scrolled offscreen),
 returns the empty list.
 .TP
-\fIpathname \fBcget\fR \fIoption\fR
+\fIpathname \fBcget \fIoption\fR
 Returns the current value of the specified \fIoption\fR; see \fIttk::widget(n)\fR.
 .TP
-\fIpathname \fBchildren\fR \fIitem\fR ?\fInewchildren\fR?
+\fIpathname \fBchildren \fIitem\fR ?\fInewchildren\fR?
 If \fInewchildren\fR is not specified,
 returns the list of children belonging to \fIitem\fR.
 .RS
@@ -123,7 +123,7 @@ None of the items in \fInewchildren\fR may be an ancestor
 of \fIitem\fR.
 .RE
 .TP
-\fIpathname \fBcolumn\fR \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
+\fIpathname \fBcolumn \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
 Query or modify the options for the specified \fIcolumn\fR.
 If no \fI\-option\fR is specified,
 returns a dictionary of option/value pairs.
@@ -164,16 +164,17 @@ Use \fIpathname column #0\fR to configure the tree column.
 \fIpathname \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 Modify or query widget options; see \fIttk::widget(n)\fR.
 .TP
-\fIpathname \fBdelete\fR \fIitemList\fR
+\fIpathname \fBdelete \fIitemList\fR
 Deletes each of the items in \fIitemList\fR and all of their descendants.
 The root item may not be deleted.
 See also: \fBdetach\fR.
 .TP
-\fIpathname \fBdetach\fR \fIitemList\fR
+\fIpathname \fBdetach \fIitemList\fR
 Unlinks all of the specified items in \fIitemList\fR from the tree.
 The items and all of their descendants are still present
 and may be reinserted at another point in the tree
-but will not be displayed.
+with the \fBmove\fR operation,
+but will not be displayed until that is done.
 The root item may not be detached.
 See also: \fBdelete\fR.
 .TP
@@ -186,7 +187,7 @@ If \fIitem\fR is specified, sets the focus item to \fIitem\fR.
 Otherwise, returns the current focus item, or \fB{}\fR if there is none.
 .\" Need: way to clear the focus item.  {} works for this...
 .TP 
-\fIpathname \fBheading\fR \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
+\fIpathname \fBheading \fIcolumn\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
 Query or modify the heading options for the specified \fIcolumn\fR.
 Valid options are:
 .RS
@@ -214,7 +215,7 @@ or the empty string if no such \fIcomponent\fR is present at that position.
 The following subcommands are supported:
 .RS
 .TP
-\fIpathname \fBidentify region\fR \fI x y\fR
+\fIpathname \fBidentify region \fIx y\fR
 .RS
 Returns one of:
 .IP heading
@@ -231,17 +232,17 @@ The tree area.
 .IP cell
 A data cell.
 .RE
-\fIpathname \fBidentify item\fR \fIx y\fR
+\fIpathname \fBidentify item \fIx y\fR
 Returns the item ID of the item at position \fIy\fR.
 .TP
-\fIpathname \fBidentify column\fR \fIx y\fR
+\fIpathname \fBidentify column \fIx y\fR
 Returns the data column identifier of the cell at position \fIx\fR.
 The tree column has ID \fB#0\fR.
 .TP
-\fIpathname \fBidentify element\fR \fIx y\fR
+\fIpathname \fBidentify element \fIx y\fR
 The element at position \fIx,y\fR.
 .TP
-\fIpathname \fBidentify row\fR \fIx y\fR
+\fIpathname \fBidentify row \fIx y\fR
 Obsolescent synonym for \fIpathname \fBidentify item\fR.
 .PP
 See \fBCOLUMN IDENTIFIERS\fR for a discussion of display columns
@@ -251,7 +252,7 @@ and data columns.
 \fIpathname \fBindex \fIitem\fR
 Returns the integer index of \fIitem\fR within its parent's list of children.
 .TP
-\fIpathname \fBinsert\fR \fIparent\fR \fIindex\fR ?\fB\-id \fIid\fR? \fIoptions...\fR
+\fIpathname \fBinsert \fIparent index\fR ?\fB\-id \fIid\fR? \fIoptions...\fR
 Creates a new item.  
 \fIparent\fR is the item ID of the parent item,
 or the empty string \fB{}\fR
@@ -275,7 +276,7 @@ See \fBITEM OPTIONS\fR for the list of available options.
 \fIpathname \fBinstate \fIstatespec\fR ?\fIscript\fR?
 Test the widget state; see \fIttk::widget(n)\fR.
 .TP
-\fIpathname \fBitem\fR \fIitem\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
+\fIpathname \fBitem \fIitem\fR ?\fI\-option \fR?\fIvalue \-option value...\fR?
 Query or modify the options for the specified \fIitem\fR.
 If no \fI\-option\fR is specified, 
 returns a dictionary of option/value pairs.
@@ -306,13 +307,13 @@ or \fB{}\fR if \fIitem\fR is at the top level of the hierarchy.
 Returns the identifier of \fIitem\fR's previous sibling,
 or \fB{}\fR if \fIitem\fR is the first child of its parent.
 .TP
-\fIpathname \fBsee\fR \fIitem\fR
+\fIpathname \fBsee \fIitem\fR
 Ensure that \fIitem\fR is visible:
 sets all of \fIitem\fR's ancestors to \fB\-open true\fR,
 and scrolls the widget if necessary so that \fIitem\fR is 
 within the visible portion of the tree.
 .TP
-\fIpathname \fBselection\fR ?\fIselop\fR \fIitemList\fR?
+\fIpathname \fBselection\fR ?\fIselop itemList\fR?
 If \fIselop\fR is not specified, returns the list of selected items.
 Otherwise, \fIselop\fR is one of the following:
 .RS
@@ -330,7 +331,7 @@ Remove \fIitemList\fR from the selection
 Toggle the selection state of each item in \fIitemList\fR.
 .RE
 .TP
-\fIpathname \fBset\fR \fIitem\fR ?\fIcolumn\fR? ?\fIvalue\fR?
+\fIpathname \fBset \fIitem\fR ?\fIcolumn\fR? ?\fIvalue\fR?
 With one argument, returns a dictionary of column/value pairs
 for the specified \fIitem\fR.
 With two arguments, returns the current value of the specified \fIcolumn\fR.
@@ -361,7 +362,7 @@ The binding \fIscript\fR undergoes \fB%\fR-substitutions before
 evaluation; see \fBbind(n)\fR for details.
 .RE
 .TP
-\fIpathName \fBtag configure\fR \fItagName\fR ?\fIoption\fR? ?\fIvalue option value...\fR?
+\fIpathName \fBtag configure \fItagName\fR ?\fIoption\fR? ?\fIvalue option value...\fR?
 Query or modify the options for the specified \fItagName\fR.
 If one or more \fIoption/value\fR pairs are specified,
 sets the value of those options for the specified tag.
@@ -372,7 +373,7 @@ With no additional arguments,
 returns a dictionary of the option settings for \fItagName\fR.
 See \fBTAG OPTIONS\fR for the list of available options.
 .TP
-\fIpathName \fBtag has\fR \fItagName\fR ?\fIitem\fR?
+\fIpathName \fBtag has \fItagName\fR ?\fIitem\fR?
 If \fIitem\fR is specified, returns 1 or 0
 depending on whether the specified item has the named tag.
 Otherwise, returns a list of all items which have
@@ -422,8 +423,8 @@ Specifies the font to use when drawing text.
 .\" ??? Maybe: .IP \-text
 .IP \fB\-image\fR
 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
+.\" .PP
+.\" \fI(@@@ TODO: sort out order of precedence for options)\fR
 .SH "COLUMN IDENTIFIERS"
 .PP
 Column identifiers take any of the following forms: