From 95c2602a6c941b086a38ac7e712b19b0e08faf49 Mon Sep 17 00:00:00 2001 From: dsiders Date: Tue, 13 Feb 2024 20:04:46 +0000 Subject: [PATCH] Docs: LCL/shellctrls. Updates content for renamed TCustomShellTreeView.ExistsAndIsValid topic. Changed in 44e32411. * TCustomShellTreeView.ExistsAndIsValid * TCustomShellTreeView.UpdateView * TCustomShellTreeView.Path * TCustomShellTreeView.OnSortCompare --- docs/xml/lcl/shellctrls.xml | 73 ++++++++++++++++++++++++------------- 1 file changed, 48 insertions(+), 25 deletions(-) diff --git a/docs/xml/lcl/shellctrls.xml b/docs/xml/lcl/shellctrls.xml index 6c140be347..5283164ba8 100644 --- a/docs/xml/lcl/shellctrls.xml +++ b/docs/xml/lcl/shellctrls.xml @@ -1008,16 +1008,16 @@ unit. Rectangle where the icon is drawn. - + Checks whether the specified path is a valid file system object and type for the tree view control.

-Exists is a Boolean function used to determine whether a -file system object at the path specified in APath can be displayed -on the tree view control. +ExistsAndIsValid is a Boolean function used to determine +whether a file system object at the path specified in APath can be +displayed on the tree view control.

APath is a UTF-8-encoded fully-qualified path name. File attributes for the @@ -1032,8 +1032,8 @@ The return value is True if APath a valid file (or directory) on the local file system.

-Exists is used in the UpdateView method when the Path and expanded state for a -Selected node are updated. +ExistsAndIsValid is used in the UpdateView method when the Path and expanded +state for a Selected node are updated.

@@ -1045,11 +1045,16 @@ Added in LCL version 4.0. - - + + +Returns True if the specified path exists and is valid for the object +types displayed on the control. + - - + + +Path name examined in the method. + @@ -1530,7 +1535,7 @@ state of the local file system in the tree view control.

UpdateView ensures that the Selected and expanded tree node(s) are captured, and restored when the nodes in Items have been reloaded. If one of the selected -or expanded nodes no longer exists on the file system, the path in an existing +or expanded nodes no longer exists on the file system, the Path in an existing parent node is used for the update. When a node is updated, its HasChildren property is changed to reflect whether subdirectories have been added or removed for the node. @@ -1559,7 +1564,9 @@ Added in LCL version 4.0. - + + + TCustomTreeView.TopItem TCustomTreeView.Selected TTreeNodes.BeginUpdate @@ -1641,7 +1648,7 @@ control. - + @@ -1721,6 +1728,7 @@ provided by the file system. + @@ -1772,7 +1780,9 @@ updated to match the new value for the property. -Path to the directory displayed in the shell control. + +Path to the directory displayed in the shell control. +

Path is a String property which represents the path on @@ -1787,23 +1797,34 @@ the base path name is prepended to the path value.

Setting the value for the property causes the the new value to be resolved to -a fully qualified path name when needed. A relative path is expanded into a -fully qualified absolute path value resolved relative to the base path in +a fully-qualified path name when needed. A relative path is expanded into a +fully-qualified absolute path value resolved relative to the base path in Root.

-An EInvalidPath exception is raised when setting Path to a value +An EInvalidPath exception is raised if Path is set to a value that is not valid, including:

    -
  • The path does not exist on the local file system
    • -
  • The path cannot be resolved as a directory located under the Root -directory
    • -
  • The path represents an entry not valid for the settings in -ObjectTypes
    • +
  • +The path does not exist on the local file system. +
    • +
  • +The path cannot be resolved as a directory located under the Root directory. +
    • +
  • +The path represents an entry not valid for the settings in ObjectTypes. +
- + + + + + + +FilenameIsAbsolute + @@ -1851,8 +1872,8 @@ the tree view control when its FileSortType property is set to fstCustom.

Changing the routine assigned to the property causes the Items in the control to be reloaded and ordered using the new file sort compare routine. The Path -property is used to to expand and select nodes if the path still exists on the -local file system. +property is used to to expand and select a node if the path still exists and is +valid for the settings in ObjectTypes.

An application can implement and assign a routine using the signature perform @@ -1917,6 +1938,8 @@ Added in LCL version 3.0. + +