<?xml version="1.0" encoding="UTF-8"?>
<!--

Documentation for LCL (Lazarus Component Library) and LazUtils (Lazarus 
Utilities) are published under the Creative Commons Attribution-ShareAlike 4.0 
International public license.

https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt
https://gitlab.com/freepascal.org/lazarus/lazarus/-/blob/main/docs/cc-by-sa-4-0.txt

Copyright (c) 1997-2025, by the Lazarus Development Team.

-->
<fpdoc-descriptions>
<package name="LCL">
<!--
====================================================================
FindDlgUnit
====================================================================
-->
<module name="FindDlgUnit">
<short>Contains a form template for the find dialog in LCL.</short>
<descr>
<p>
Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is 
not compiled into the LCL. This form is used to design the .lfm file.
</p>
<p>
The source code is a copy of <file>../lcl/include/finddialog.inc</file>.
</p>
<p>
<file>finddlgunit.pas</file> is part of the Lazarus Component Library 
(<b>LCL</b>).
</p>
</descr>

<!-- used units -->
<element name="System"/>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Forms"/>
<element name="Controls"/>
<element name="Graphics"/>
<element name="Dialogs"/>
<element name="StdCtrls"/>
<element name="Buttons"/>
<element name="ExtCtrls"/>

<element name="TFindDialogForm">
<short>
TForm descendant which implements a find text dialog.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.BtnPanel">
<short>
Panel with the buttons displayed on the dialog form.  
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.EntireScopeCheckBox">
<short>
Check box used for the "Search Entire File" option.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.FindButton">
<short>
Button used to perform the "Find More" action.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.CancelButton">
<short>
Button used to cancel and close the dialog form.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.FlagsPanel">
<short>
Panel which contains the check box options on the dialog form.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.HelpButton">
<short>
Button used to display help information for the dialog form.  
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.WholeWordsOnlyCheckBox">
<short>
Check box to enable or disable searching for whole words only.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.CaseSensitiveCheckBox">
<short>
Check box to enable or disable case-sensitive search in the dialog.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.EditFind">
<short>
Edit control with the value to locate using the dialog.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.FindLabel">
<short>
Label for the EditFind control.  
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.DirectionRadioGroup">
<short>
Radio button group used to select the search direction for the dialog.
</short>
<descr/>
<seealso/>
</element>

<element name="TFindDialogForm.EditFindChange">
<short>
Implements the OnChange event handler for the EditFind control.
</short>
<descr>
<p>
Enables or disables the FindButton on the dialog. The button is enabled when 
the text in the control is not empty.
</p>
</descr>
<seealso/>
</element>
<element name="TFindDialogForm.EditFindChange.Sender">
<short>
Object instance (TControl) for the event notification, or <b>Nil</b>.
</short>
</element>

<element name="TFindDialogForm.FormCreate">
<short>
Implements the OnCreate event handler for the form instance.
</short>
<descr>
<p>
Signals the OnChange event handler for the EditFind control on entry to set 
the state for the "Find More" button.
</p>
</descr>
<seealso/>
</element>
<element name="TFindDialogForm.FormCreate.Sender">
<short>
Object instance for the event notification, or <b>Nil</b>.
</short>
</element>

</module>
<!-- FindDlgUnit-->
</package>
</fpdoc-descriptions>
