Docs: Improve TreeView documentation. Issue #31410, patch from AlexeyT.

git-svn-id: trunk@54331 -
This commit is contained in:
juha 2017-03-03 10:37:00 +00:00
parent ccd8c6cb32
commit c5cdb41294

View File

@ -14781,63 +14781,63 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoAllowMultiselect">
<short/>
<short>Allow to select several tree-items, e.g. using Ctrl+click and Shift+click. Does the same as MultiSelect property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoAutoExpand">
<short/>
<short>When tree-item gets focus (by user or code), unfold tree to make this item visible.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoAutoInsertMark">
<short/>
<short>Allow to paint horizontal line, below tree-item under cursor, when mouse moves. Good for drag-drop.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoAutoItemHeight">
<short/>
<short>Detect height of tree-item, from current font and icons.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoHideSelection">
<short/>
<short>If control looses focus, then don't paint selection for selected tree-item. Same as HideSelection property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoHotTrack">
<short/>
<short>Additionally highlight/underline tree-item, when mouse is over it. Same as HotTrack property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoKeepCollapsedNodes">
<short/>
<short>When some items change, keep previously folded tree-items in folded state.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoReadOnly">
<short/>
<short>Don't allow to change item captions, by clicking on items with a delay. Same as ReadOnly property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoRightClickSelect">
<short/>
<short>Right-click also selects tree-item. Else it only calls PopupMenu. Same as RightClickSelect property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoRowSelect">
<short/>
<short>When tree-item is selected, paint selection background with full width. Same as RowSelect property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoShowButtons">
<short/>
<short>Show expand/collapse (fold/unfold) icons, at left side, for nodes with sub-nodes. Same as ShowButtons property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoShowLines">
<short/>
<short>Show vertical lines, at left side, which paint tree structure for nested nodes. Same as ShowLines property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoShowRoot">
<short/>
<short>Show root tree-item, which is always present in code, but may be hidden for user. Same as ShowRoot property.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoShowSeparators">
<short/>
<short>Show horizontal lines, below all tree-items.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TTreeViewOption.tvoToolTips">
<short/>
<short>Show tooltip (hint) for tree-item, when item is too long to fit by width, and mouse is over it. Same as ToolTips property.</short>
</element>
<!-- set type Visibility: default -->
<element name="TTreeViewOptions">
@ -16645,10 +16645,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.AutoExpand">
<short>
<var>AutoExpand</var> - if True, the tree structure is automatically expanded when a node is selected</short>
<descr/>
<seealso/>
<short>Unfold tree-item, when user clicks it, or item activated by code.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.BorderStyle" link="#LCL.Controls.TCustomControl.BorderStyle">
@ -16658,38 +16658,37 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.HideSelection">
<short>
<var>HideSelection</var> - if True, the selected part of the tree is to be hidden</short>
<descr/>
<seealso/>
<short>If control looses focus, then don't paint selection for selected tree-item.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.HotTrack">
<short>
<var>HotTrack</var> - the property whereby the item under the mouse pointer becomes emphasised</short>
<descr/>
<seealso>
<link id="#lcl.ComCtrls.TCustomListview.HotTrack">TCustomListView.HotTrack</link>
</seealso>
<short>Additionally highlight/underline tree-item, when mouse is over it.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.Images">
<short>
<var>Images</var> - the ImageList to be used in association with the list of TreeNodes</short>
<descr/>
<seealso/>
<short>TImageList object, which holds icons for tree-items.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.Indent">
<short>
<var>Indent</var> - the amount by which each successive level of branching is to be indented in the tree structure</short>
<descr/>
<seealso/>
<short>Size in pixels, by which each nested branching level is to be indented.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.Items">
<short>
<var>Items</var> - the collection of TreeNodes that comprise the TreeView</short>
<short>Collection of tree-items, which is the content of control. Has type TTreeNodes.</short>
<descr/>
<seealso/>
</element>
@ -16821,24 +16820,24 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ReadOnly">
<short>
<var>ReadOnly</var> - if True, the TreeView can only be observed, and not Written to or changed. Default False</short>
<descr/>
<seealso/>
<short>Don't allow to change item captions, by mouse click with a delay.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.RightClickSelect">
<short>
<var>RightClickSelect</var> - if True, a Right Click selects an Item. Default False</short>
<descr/>
<seealso/>
<short>Right-click also selects tree-item. Else it only calls PopupMenu.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.RowSelect">
<short>
<var>RowSelect</var> - if True, a row is selected</short>
<descr/>
<seealso/>
<short>When tree-item is selected, paint selection background with full width.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ScrolledLeft">
@ -16856,52 +16855,51 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ShowButtons">
<short>
<var>ShowButtons</var> - if True, buttons are displayed</short>
<descr/>
<seealso/>
<short>Show expand/collapse (fold/unfold) icons, at left side, for nodes with sub-nodes.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ShowLines" link="#LCL.ComCtrls.TCustomTreeView.ShowLines">
<short>
<var>ShowLines</var> - show the connecting lines of the tree structure</short>
<element name="TCustomTreeView.ShowLines">
<descr/>
<seealso/>
<short>Show vertical lines, at left side, which paint tree structure for nested nodes.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ShowRoot">
<short>
<var>ShowRoot</var> - if True, the root of the tree structure is displayed</short>
<descr/>
<seealso/>
<short>Show root tree-item, which is always present in code, but may be hidden for user.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ShowSeparators">
<short>
<var>ShowSeparators</var> - if True, separators are shown between items</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.SortType">
<short>
<var>SortType</var> - the way the items are to be sorted: None, by Data, by Text or Both</short>
<descr/>
<seealso/>
<short>Allow to show items sorted: by caption, by Data property, or both.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.StateImages">
<short>
<var>StateImages</var> - the list of images to denote state of the tree (expanded, contracted etc)</short>
<descr/>
<seealso/>
<short>TImageList object, which holds icons for tree-item states: normal item, selected item, etc.</short>
</element>
<!-- property Visibility: protected -->
<element name="TCustomTreeView.ToolTips">
<short>
<var>ToolTips</var> - if True (default), pop-up tool tips are to be shown</short>
<descr/>
<seealso/>
<short>Show tooltip (hint) for tree-item, when item is too long to fit by width, and mouse is over it.</short>
</element>
<!-- constructor Visibility: public -->
<element name="TCustomTreeView.Create">
@ -17223,10 +17221,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.BackgroundColor">
<short>
<var>BackgroundColor</var> for the treeview</short>
<descr/>
<seealso/>
<short>Color of background area of control.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.BorderWidth" link="#LCL.Controls.TWinControl.BorderWidth">
@ -17243,10 +17241,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.DefaultItemHeight">
<short>
<var>DefaultItemHeight</var> - default height for items on the list</short>
<descr>If tvoAutoItemHeight is set in Options this value is set automatically depending on font and icons.</descr>
<seealso/>
<short>Default height of tree-items. If tvoAutoItemHeight is set in Options, this value is detected from font and icons.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.DropTarget">
@ -17257,10 +17255,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.ExpandSignType">
<short>
<var>ExpandSignType</var> - the symbols to denote whether a list is expanded or collapsed; default is plus or minus</short>
<descr/>
<seealso/>
<short>Sets shape of expand/collapse (fold/unfold) symbol: plus/minus, empty arrows, filled arrows etc.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.InsertMarkNode">
@ -17285,36 +17283,17 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.Options">
<short>The set of <var>Options</var> for displaying the tree view</short>
<descr>
<p>The set of <var>Options</var> for displaying the tree view</p>
<p>List of available options:</p>
<pre>tvoAllowMultiselect,
tvoAutoExpand,
tvoAutoInsertMark,
tvoAutoItemHeight,
tvoHideSelection,
tvoHotTrack,
tvoKeepCollapsedNodes,
tvoReadOnly,
tvoRightClickSelect,
tvoRowSelect,
tvoShowButtons,
tvoShowLines,
tvoShowRoot,
tvoShowSeparators,
tvoToolTips,
tvoNoDoubleClickExpand
</pre>
</descr>
<seealso/>
<short>Set of additional option flags for treeview.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.ScrollBars">
<short>
<var>ScrollBars</var> - the style of scroll bars for the treeview display</short>
<descr/>
<seealso/>
<short>Kind of scrollbars: horizontal, vertical, or both. Auto* mean that scrollbars hide automatically.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.Selected">
@ -17324,17 +17303,17 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.SelectionColor">
<short>
<var>SelectionColor</var> - the colour to be used for the selected nodes, to distinguish them from the others</short>
<descr/>
<seealso/>
<short>Color used to paint background of item selection.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.SeparatorColor">
<short>
<var>SeparatorColor</var> - the colour to be used for separators</short>
<descr/>
<seealso/>
<short>Color used to paint horizontal lines between items, separators.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.TopItem">
@ -17350,17 +17329,17 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.TreeLineColor">
<short>
<var>TreeLineColor</var> - the colour to be used for the lines showing the tree structure</short>
<descr/>
<seealso/>
<short>Color used to paint vertical lines, at left side.</short>
</element>
<!-- property Visibility: public -->
<element name="TCustomTreeView.ExpandSignColor">
<short>
<var>ExpandSignColor</var> - the colour to be used for the expand/collapse symbols</short>
<descr/>
<seealso/>
<short>Color used to paint expand/collapse (fold/unfold) symbol (ie, plus/minus symbol).</short>
</element>
<!-- property Visibility: published -->
<element name="TCustomTreeView.TabStop" link="#LCL.Controls.TWinControl.TabStop">
@ -17393,8 +17372,7 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: published -->
<element name="TTreeView.AutoExpand">
<short>
<var>AutoExpand</var> - automatically expand the tree when an item is selected</short>
<descr/>
<seealso/>
</element>
@ -17405,8 +17383,8 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.BackgroundColor" link="#LCL.ComCtrls.TCustomTreeView.BackgroundColor">
<short/>
<element name="TTreeView.BackgroundColor">
<descr/>
<seealso/>
</element>
@ -17441,8 +17419,8 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.DefaultItemHeight" link="#LCL.ComCtrls.TCustomTreeView.DefaultItemHeight">
<short/>
<element name="TTreeView.DefaultItemHeight">
<descr/>
<seealso/>
</element>
@ -17471,8 +17449,8 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ExpandSignType" link="#LCL.ComCtrls.TCustomTreeView.ExpandSignType">
<short/>
<element name="TTreeView.ExpandSignType">
<descr/>
<seealso/>
</element>
@ -17484,28 +17462,23 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
</element>
<!-- property Visibility: published -->
<element name="TTreeView.HideSelection">
<short>
<var>HideSelection</var> - the selected items are to be hidden</short>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.HotTrack">
<short>
<var>HotTrack</var> - the property whereby the item under the mouse pointer becomes emphasised</short>
<descr/>
<seealso>
<link id="#lcl.ComCtrls.TCustomListView.HotTrack">TCustomListView.HotTrack</link>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.Images">
<short>The Bitmap image associated with each item in the display</short>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.Indent">
<short>
<var>Indent</var> - the amount by which each successive branching level is to be indented</short>
<descr/>
<seealso/>
</element>
@ -17540,36 +17513,40 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ReadOnly" link="#LCL.ComCtrls.TCustomTreeView.ReadOnly">
<element name="TTreeView.ReadOnly">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.RightClickSelect">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.RowSelect">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ScrollBars">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.RightClickSelect" link="#LCL.ComCtrls.TCustomTreeView.RightClickSelect">
<element name="TTreeView.SelectionColor">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.RowSelect" link="#LCL.ComCtrls.TCustomTreeView.RowSelect">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ScrollBars" link="#LCL.ComCtrls.TCustomTreeView.ScrollBars">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.SelectionColor" link="#LCL.ComCtrls.TCustomTreeView.SelectionColor">
<short/>
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ShowButtons" link="#LCL.ComCtrls.TCustomTreeView.ShowButtons">
<element name="TTreeView.ShowButtons">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ShowHint" link="#LCL.Controls.TControl.ShowHint">
@ -17578,24 +17555,28 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ShowLines" link="#LCL.ComCtrls.TCustomTreeView.ShowLines">
<element name="TTreeView.ShowLines">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ShowRoot" link="#LCL.ComCtrls.TCustomTreeView.ShowRoot">
<element name="TTreeView.ShowRoot">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.SortType" link="#LCL.ComCtrls.TCustomTreeView.SortType">
<element name="TTreeView.SortType">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.StateImages" link="#LCL.ComCtrls.TCustomTreeView.StateImages">
<element name="TTreeView.StateImages">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.TabOrder" link="#LCL.Controls.TWinControl.TabOrder">
@ -17616,9 +17597,10 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ToolTips" link="#LCL.ComCtrls.TCustomTreeView.ToolTips">
<element name="TTreeView.ToolTips">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.Visible" link="#LCL.Controls.TControl.Visible">
@ -17808,8 +17790,8 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.Options" link="#LCL.ComCtrls.TCustomTreeView.Options">
<short/>
<element name="TTreeView.Options">
<descr/>
<seealso/>
</element>
@ -17822,14 +17804,14 @@ If Images.HasOverlays then it is fetched from Images via Images.Overlay(Node.Ove
<!-- property Visibility: published -->
<element name="TTreeView.Items" link="#LCL.ComCtrls.TCustomTreeView.Items"/>
<!-- property Visibility: published -->
<element name="TTreeView.TreeLineColor" link="#LCL.ComCtrls.TCustomTreeView.TreeLineColor">
<short/>
<element name="TTreeView.TreeLineColor">
<descr/>
<seealso/>
</element>
<!-- property Visibility: published -->
<element name="TTreeView.ExpandSignColor" link="#LCL.ComCtrls.TCustomTreeView.ExpandSignColor">
<short/>
<element name="TTreeView.ExpandSignColor">
<descr/>
<seealso/>
</element>
@ -18706,11 +18688,12 @@ the comparision is case sensitive.
<var>SelectOnlyThis</var> - method for selecting only the indicated node</short>
</element>
<element name="TCustomTreeView.TreeLinePenStyle">
<short>
<var>TreeLinePenStyle</var> - the pen style for drawing lines on the tree</short>
<short>Style of TPen, used to paint vertical lines, at left side.</short>
</element>
<element name="TTreeView.OnUTF8KeyPress" link="#LCL.Controls.TWinControl.OnUTF8KeyPress"/>
<element name="TTreeView.TreeLinePenStyle" link="#LCL.ComCtrls.TCustomTreeView.TreeLinePenStyle"/>
<element name="TTreeView.TreeLinePenStyle">
</element>
<element name="THeaderSectionState">
<short>
<var>THeaderSectionState</var> - enumerated type containing possible selection states for header</short>
@ -18809,6 +18792,25 @@ the comparision is case sensitive.
<element name="TToolButton.OnArrowClick"><short>Executed when user clicked the arrow part for Style=tbsDropDown.</short><descr>It is not executed if DropDownMenu is assigned.</descr>
</element><element name="TToolButton.ArrowClick"><short>Invokes the OnArrowClick event handler</short><descr>Executed automatically when user clicked the arrow part for Style=tbsDropDown and no DropDownMenu is assigned.</descr>
</element>
<element name="TTreeView.ExpandSignSize">
</element><element name="TTreeView.MultiSelect">
</element><element name="TTreeView.MultiSelectStyle">
</element><element name="TMultiSelectStyles.msControlSelect"><short>Allow to select one additonal item, by Ctrl+click.</short>
</element><element name="TMultiSelectStyles.msShiftSelect"><short>Allow to select range of items (from previous current item, to clicked one), by Shift+click.</short>
</element><element name="TMultiSelectStyles.msVisibleOnly"><short>When selecting range with Shift+click, select only visible (unfolded) items.</short>
</element><element name="TMultiSelectStyles.msSiblingOnly"><short>When selecting range with Shift+click, touch only siblings of previous current item.</short>
</element><element name="TTreeViewOption.tvoNoDoubleClickExpand"><short>Don't expand (unfold) tree-item, by mouse double click.</short>
</element><element name="TTreeViewOption.tvoThemedDraw"><short>Use OS themes to paint control elements.</short>
</element><element name="TTreeView.SelectionFontColor">
</element><element name="TTreeView.SelectionFontColorUsed">
</element><element name="TTreeView.SeparatorColor">
</element>
<element name="TCustomTreeView.ExpandSignSize"><short>Size of expand/collapse (fold/unfold) symbol.</short>
</element><element name="TCustomTreeView.MultiSelect"><short>Allow to select several tree-items at a time, e.g. using Ctrl+click (select one item more) or Shift+click (select range of items).</short>
</element><element name="TCustomTreeView.MultiSelectStyle"><short>Additional options for MultiSelect property.</short>
</element><element name="TCustomTreeView.SelectionFontColor"><short>Color used to paint text of selected item.</short>
</element><element name="TCustomTreeView.SelectionFontColorUsed"><short>Allow to use property SelectionFontColor. If not used, that color is detected automatically.</short>
</element>
</module>
<!-- ComCtrls -->
</package>