paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-08 18:39:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of FilterEdit components.

Browse Source 
git-svn-id: trunk@49243 -
This commit is contained in:
juha 2015-06-02 11:59:42 +00:00
parent 8fbb5a4e52
commit 1e433ebf42
4 changed files with 53 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
components/lazcontrols/docs/listfilteredit.xml
View File

@ -1,7 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions><package name="LazControls"><module name="ListFilterEdit"><element name="TListFilterEdit"><short>Filter contents of an associated ListBox.</short>
<fpdoc-descriptions><package name="LazControls"><module name="ListFilterEdit"><element name="TListFilterEdit"><short>Filter for an associated ListBox.</short>
</element><element name="TListFilterEdit.FilteredListbox"><short>The associated Listbox.</short>
</element>
<element name="TListFilterEdit.SelectionList"><short>List of selected items. They are restored after filtering.</short>
</element><element name="TListFilterEdit.Items"><short>Maintains the data which is filtered and shown in the Listbox.</short>
</element>
</module>
</package>
</fpdoc-descriptions>

6
components/lazcontrols/docs/listviewfilteredit.xml
View File

@ -1,7 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions><package name="LazControls"><module name="ListViewFilterEdit"><element name="TListViewFilterEdit"><short>Filter contents of an associated ListView.</short>
<fpdoc-descriptions><package name="LazControls"><module name="ListViewFilterEdit"><element name="TListViewFilterEdit"><short>Filter for an associated ListView.</short>
</element><element name="TListViewFilterEdit.FilteredListview"><short>The associated ListView.</short>
</element>
<element name="TListViewFilterEdit.ByAllFields"><short>Use all ListView fields when searching filter matches. Otherwise just the first field (ListView caption) is used.</short>
</element><element name="TListViewFilterEdit.Items"><short>Maintains the data which is filtered and shown in the ListView.</short>
</element><element name="TListViewFilterEdit.SelectionList"><short>List of selected items. They are restored after filtering.</short>
</element>
</module>
</package>
</fpdoc-descriptions>

25
components/lazcontrols/docs/treefilteredit.xml
View File

@ -1,7 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions><package name="LazControls"><module name="TreeFilterEdit"><element name="TTreeFilterEdit"><short>Filter contents of an associated TreeView.</short>
<fpdoc-descriptions><package name="LazControls"><module name="TreeFilterEdit"><element name="TTreeFilterEdit"><short>Filter for an associated TreeView.</short>
<descr>This control has 2 different operation modes. One mode maintains and filters sub-items of root-nodes in a tree, another mode filters a whole existing tree using TreeNode.Visible property.
<b>Mode 1</b>: Sub-branches under root nodes
Items for each branch are maintained in TTreeFilterBranch class instance.
<b>Mode 2</b>: A whole tree
When no branches are defined (no calls made to GetBranch), the TreeFilterEdit control filters the whole tree automatically. It uses each TreeNode's Visible property to show/hide it.
</descr>
</element><element name="TTreeFilterEdit.FilteredTreeview"><short>The associated TreeView.</short>
</element>
<element name="TTreeFilterEdit.SelectionList"><short>List of selected items. They are restored after filtering.</short>
</element><element name="TTreeFilterEdit.ShowDirHierarchy"><short>When a filtered text is a directory name, it is split and shown as a tree structure.</short><descr>This has effect only in the "sub-branches" mode.
The "whole tree" mode uses the existing tree nodes as is and only changes their visibility.
</descr>
</element><element name="TTreeFilterEdit.ExpandAllInitially"><short>Tree branches are expanded also initially.</short><descr>The branches are expanded in any case when the tree is filtered and matches are found. This setting only affects the initial state.
</descr>
</element><element name="TTreeFilterEdit.OnGetImageIndex"><short>ImageIndex can be queried while filtering based on the node data.</short>
</element><element name="TTreeFilterEdit.GetExistingBranch"><short>Get an existing branch for a given tree-node, or Nil if there is none.</short><descr>This can be used only with the "sub-branches" mode.
</descr>
</element><element name="TTreeFilterEdit.GetCleanBranch"><short>Get a new or existing branch with data cleared for a given tree-node.</short><descr>This can be used only with the "sub-branches" mode. In fact calling this method switches the filter into "sub-branches" mode. This is the way to add those branches.
</descr>
</element><element name="TTreeFilterBranch"><short>A branch associated with an existing TreeNode when the filter is used in "sub-branches" mode.</short>
</element><element name="TTreeFilterBranch.Create"><short>An existing TreeNode must be passed for the constructor.</short>
</element><element name="TTreeFilterBranch.AddNodeData"><short>Add a data item for this branch. Text, data reference and an associalted file name can be added.</short>
</element>
</module>
</package>
</fpdoc-descriptions>

20
docs/xml/lcl/editbtn.xml
View File

@ -2631,6 +2631,26 @@ only a file name, without path.</p>
</element>
<element name="TCustomEditButton.Autosize"><short>TCustomEditBtn sets default to True</short>
</element>
<element name="TCustomControlFilterEdit"><short>Base class for filter controls which associate to a container control like Listbox or Treeview.</short>
<descr>When the container control is connected to the filter control, the filtering happens automatically as a user enters text. When the filter is empty and does not have focus, it shows a grey "(filter)" text.
</descr>
</element>
<element name="TCustomControlFilterEdit.OnFilterItem"><short>An event handler to give extra conditions for filtering, in addition to the default behavior. Returns True if the passes the filter.</short><descr>This feature has for example enabled filtering the Options windows in Lazarus IDE, based on captions of all controls on the options pages.
</descr>
</element><element name="TCustomControlFilterEdit.OnCheckItem"><short>Has effect when items in the filtered container can be checked. Typically a CheckListbox.</short>
</element><element name="TCustomControlFilterEdit.OnAfterFilter"><short>Called after all items are filtered.</short>
</element><element name="TCustomControlFilterEdit.Filter"><short>The actual filter text.</short><descr>Typically a user types it in the edit control but it can also be set in code.
Filtering is done during idle time after the value of Filter text has changed.
</descr>
</element><element name="TCustomControlFilterEdit.SortData"><short>Items can be sorted while they are filtered.</short>
</element><element name="TCustomControlFilterEdit.SelectedPart"><short>For retaining selection in the filtered control. The actual type depends on the control.</short>
</element><element name="TCustomControlFilterEdit.InvalidateFilter"><short>Should be called when data was changed and it must be filtered again.</short><descr>Connects to OnIdle handler which filters the data later.</descr>
</element><element name="TCustomControlFilterEdit.ResetFilter"><short>Removes the filter text and shows all items in the container.</short>
</element><element name="TCustomControlFilterEdit.ForceFilter"><short>Applies a new filter immediately without waiting for idle. Returns the previous filter.</short>
</element><element name="TCustomControlFilterEdit.ApplyFilterCore"><short>Method that actually filters data in the container component. Must be implementation inherited classes.</short>
</element><element name="TCustomControlFilterEdit.ApplyFilter"><short>Filters the data and updates the container.</short><descr>Does its job at once if Immediately=True. Otherwise connects to OnIdle handler which does it later.
</descr>
</element>
</module>
<!-- EditBtn -->
</package>