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

Docs: LCL/shellctrls. Adds topics for changes in 8fa26c3c71, including:

Browse Source 
* TCustomShellTreeView.Exists
* TCustomShellTreeView.UpdateView
* TCustomShellListView.UpdateView
This commit is contained in:
dsiders 2023-11-06 06:19:21 +00:00
parent c6a99fe03a
commit e97ac42b74
1 changed files with 121 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
docs/xml/lcl/shellctrls.xml
View File

@ -886,8 +886,8 @@ The value in <var>AutoExpand</var> is restored to its original value prior to
exiting from the method.
</p>
<p>
The entire update process is done in a BeginUpdate / EndUpdate block to
reduce the number of screen refreshes in the method.
The entire update process is done in a BeginUpdate / EndUpdate block to reduce
the number of screen refreshes in the method.
</p>
</descr>
<seealso>
@ -1007,6 +1007,49 @@ unit.
<short>Rectangle where the icon is drawn.</short>
</element>
<element name="TCustomShellTreeView.Exists">
<short>
Checks whether the specified path is a valid file system object and type for
the tree view control.
</short>
<descr>
<p>
<var>Exists</var> is a <var>Boolean</var> function used to determine whether a
file system object at the path specified in <var>APath</var> can be displayed
on the tree view control.
</p>
<p>
APath is a UTF-8-encoded fully-qualified path name. File attributes for the
argument are retrieved to check whether it exists on the local file system.
ObjectTypes is checked to determine whether the item is one of the object types
displayed on the tree view control.
</p>
<p>
The return value is <b>False</b> if both conditions are not satisfied. The
return value is <b>True</b> if APath a valid file (or directory) on the local
file system.
</p>
<p>
Exists is used in the UpdateView method when the Path and expanded state for a
Selected node are updated.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TCustomShellTreeView.ObjectTypes"/>
<link id="TCustomShellTreeView.Path"/>
<link id="TCustomShellTreeView.UpdateView"/>
</seealso>
</element>
<element name="TCustomShellTreeView.Exists.Result">
<short/>
</element>
<element name="TCustomShellTreeView.Exists.APath">
<short/>
</element>
<element name="TCustomShellTreeView.GetBuiltinIconSize">
<short>Gets the size for a shell icon used in the control.</short>
<descr>
@ -1461,6 +1504,49 @@ to the root directory.
</short>
</element>
<element name="TCustomShellTreeView.UpdateView">
<short>
Reloads the nodes for tree view control and synchronizes an associated
ShellListView control.
</short>
<descr>
<p>
<var>UpdateView</var> is a method used to repopulate the nodes on a tree view
control. It ensures that Items contains the entries needed for the current
state of the local file system.
</p>
<p>
UpdateView ensures that the Selected and expanded tree node(s) are captured,
and restored when the nodes in Items have been reloaded. TopItem is used to
restore the first visible tree node on the control. Selected provides the
selected tree node on the control.
</p>
<p>
Updates to the Items in the control are enclosed by BeginUpdate and EndUpdate
method calls to reduce the number of updates while the control is reloaded.
</p>
<p>
UpdateView causes an associated ShellListView control to call its UpdateView
method to synchronize the two controls. This action is omitted if ShellListView
has not been assigned.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TCustomShellTreeView.Items"/>
<link id="TCustomShellTreeView.Refresh"/>
<link id="TCustomShellTreeView.GetPathFromNode"/>
<link id="TCustomShellTreeView.ShellListView"/>
<link id="TCustomShellListView.UpdateView"/>
<link id="#lcl.comctrls.TCustomTreeView.TopItem">TCustomTreeView.TopItem</link>
<link id="#lcl.comctrls.TCustomTreeView.Selected">TCustomTreeView.Selected</link>
<link id="#lcl.comctrls.TTreeNodes.BeginUpdate">TTreeNodes.BeginUpdate</link>
<link id="#lcl.comctrls.TTreeNodes.EndUpdate">TTreeNodes.EndUpdate</link>
</seealso>
</element>
<element name="TCustomShellTreeView.UseBuiltinIcons">
<short>
Indicates if OS-provided icons are used for entries in the Shell control.
@ -2140,6 +2226,7 @@ in the class.
<element name="TCustomShellListView.FRoot"/>
<element name="TCustomShellListView.FShellTreeView"/>
<element name="TCustomShellListView.FUseBuiltInIcons"/>
<element name="TCustomShellListView.FLockUpdate"/>
<element name="TCustomShellListView.FOnAddItem"/>
<element name="TCustomShellListView.FOnSortCompare"/>
<element name="TCustomShellListView.FOnFileAdded"/>
@ -2616,6 +2703,38 @@ path on the local file system for the list item specified in
<short>List item examined in the method.</short>
</element>
<element name="TCustomShellListView.UpdateView">
<short>
Reloads the contents for the list view control and restores the Selected item.
</short>
<descr>
<p>
<var>UpdateView</var> is a method used to repopulate the Items for the control.
It ensures that the Selected entry is captured and restored (if assigned) when
the file system entries have been reloaded in the method.
</p>
<p>
UpdateView calls Clear to discard existing entries in Items, and
PopulateWithRoot to recreate the entries starting at the path in Root.
FindCaption is called to locate and restore the value in Selected.
</p>
<p>
UpdateView ensures that an associated ShellTreeView control calls its
UpdateView method to synchronize the contents for the controls.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TCustomShellListView.Root"/>
<link id="TCustomShellListView.PopulateWithRoot"/>
<link id="TCustomShellTreeView.UpdateView"/>
<link id="#lcl.comctrls.TCustomListView.Clear">TCustomListView.Clear</link>
<link id="#lcl.comctrls.TCustomListView.Selected">TCustomListView.Selected</link>
</seealso>
</element>
<element name="TCustomShellListView.AutoSizeColumns">
<short>
Indicates if columns in the control are automatically resized to fill the