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

Docs: LazUtils/fileutil. Adds missing TFileSearcher.OnQueryDirectoryEnter topic.

Browse Source
This commit is contained in:
dsiders 2024-03-16 07:09:33 +01:00
parent 2ea537c259
commit d47c2c2d20
1 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/xml/lazutils/fileutil.xml
View File

@ -2137,7 +2137,7 @@ directory is accepted or rejected.
</p>
</descr>
<version>
Added in LCL version 4.0.
Added in LCL version 4.0.
</version>
<seealso>
<link id="TFileSearcher.Search"/>
@ -2147,6 +2147,43 @@ Added in LCL version 4.0.
</seealso>
</element>
<element name="TFileSearcher.OnQueryDirectoryEnter">
<short>
Event handler signalled to accept or reject a subdirectory in the Search method.
</short>
<descr>
<p>
<var>OnQueryDirectoryEnter</var> is a <var>TQueryDirectoryFoundEvent</var>
property signalled when a recursive directory search is performed in the Search
method. It allows an application to accept or reject a directory name on a
case-by-case basis even though it matches the path and mask provided to Search.
</p>
<p>
Arguments passed to the event handler include information about the current
file system entry, the name for the directory, and a variable argument which
indicates whether the directory is accepted or rejected. See
<link id="TQueryDirectoryFoundEvent">TQueryDirectoryFoundEvent</link> for more
information.
</p>
<p>
OnQueryDirectoryEnter is signalled (when assigned) from the Search method, and
occurs when subdirectory searches have been enabled in the method.
</p>
<p>
Use OnQueryFileFound to accept or reject individual file names processed in the
Search method.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TFileSearcher.Search"/>
<link id="TFileSearcher.OnQueryFileFound"/>
<link id="TQueryDirectoryFoundEvent"/>
</seealso>
</element>
<element name="TListFileSearcher">
<short>
Stores file names matching a search criteria in a TStrings class instance.