paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-09-06 16:00:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/extdlgs. Removes extra spaces in topics. Updates tagging for True and False values.

Browse Source
This commit is contained in:
dsiders 2022-06-18 01:19:46 +01:00
parent fb8f4bd664
commit 1989d8b90e
1 changed files with 29 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
docs/xml/lcl/extdlgs.xml
View File

@ -7,7 +7,9 @@
====================================================================
-->
<module name="ExtDlgs">
<short>Contains extended dialogs used for Calendar, Calculator and Picture Open/Save tasks.</short>
<short>
Contains extended dialogs used for Calendar, Calculator and Picture Open/Save tasks.
</short>
<descr>
<p>
<file>extdlgs.pas</file> contains extended dialogs available in Lazarus Component Library (<b>LCL</b>) applications. It adds the following components to <b>Dialogs</b> tab in the Lazarus IDE Component Palette:
@ -115,7 +117,7 @@
<short>Dialog which created the file preview control.</short>
<descr>
<p>
<var>PreviewFileDialog</var> is a <var>TPreviewFileDialog</var> property which contains the dialog which created the file preview control. The value in PreviewFileDialog is is assigned in the <var>CreatePreviewControl</var> method in <var>TPreviewFileDialog</var>.
<var>PreviewFileDialog</var> is a <var>TPreviewFileDialog</var> property which contains the dialog which created the file preview control. The value in PreviewFileDialog is is assigned in the <var>CreatePreviewControl</var> method in <var>TPreviewFileDialog</var>.
</p>
</descr>
<seealso>
@ -195,13 +197,13 @@
<short>Creates the PreviewFileControl and displays the dialog.</short>
<descr>
<p>
<var>DoExecute</var> is an overridden Boolean function in <var>TPreviewFileDialog</var>.
<var>DoExecute</var> is an overridden Boolean function in <var>TPreviewFileDialog</var>.
</p>
<p>
DoExecute calls the <var>CreatePreviewControl</var> method to allocate resources for the <var>PreviewFileControl</var> property. It calls the inherited method to display the dialog, select a file on the local file system, and get the return value for the method. The return value is <b>True</b> when the dialog return value in <var>UserChoice</var> is <var>mrOk</var>.
</p>
<p>
DoExecute is called from the <var>Execute</var> method in the <var>TCommonDialog</var> ancestor class.
DoExecute is called from the <var>Execute</var> method in the <var>TCommonDialog</var> ancestor class.
</p>
</descr>
<seealso>
@ -230,7 +232,7 @@
<element name="TPreviewFileDialog.PreviewFileControl">
<short>
Windowed control used to preview the contents of a file in the dialog.
Windowed control used to preview the contents of a file in the dialog.
</short>
<descr>
<p>
@ -250,7 +252,7 @@
</short>
<descr>
<p>
<var>TOpenPictureDialog</var> is a <var>TPreviewFileDialog</var> descendant which implements a dialog used to preview and select image files using common image formats recognized for the platform or OS. It provides <var>DefaultFilter</var> and <var>Filter</var> properties which use file masks for file extensions supported for the <var>TGraphic</var> class. The <var>ImageCtrl</var> property provides the image preview for the dialog.
<var>TOpenPictureDialog</var> is a <var>TPreviewFileDialog</var> descendant which implements a dialog used to preview and select image files using common image formats recognized for the platform or OS. It provides <var>DefaultFilter</var> and <var>Filter</var> properties which use file masks for file extensions supported for the <var>TGraphic</var> class. The <var>ImageCtrl</var> property provides the image preview for the dialog.
</p>
</descr>
<seealso>
@ -269,7 +271,7 @@
<element name="TOpenPictureDialog.IsFilterStored">
<short>
<var>IsFilterStored</var> - returns True if a filter is stored.
<var>IsFilterStored</var> - returns <b>True</b> if a filter is stored.
</short>
<descr>
<p>
@ -282,7 +284,9 @@
</seealso>
</element>
<element name="TOpenPictureDialog.IsFilterStored.Result">
<short>True when Filter is included in the LCL component streaming content.</short>
<short>
<b>True</b> when Filter is included in the LCL component streaming content.
</short>
</element>
<element name="TOpenPictureDialog.ImageCtrl">
@ -316,7 +320,7 @@
<short>Initializes the PreviewFileControl for the dialog.</short>
<descr>
<p>
<var>InitPreviewControl</var> is overridden in <var>TOpenPictureDialog</var>. InitPreviewControl calls the inherited method, and ensures that <var>PreviewFileControl</var> is assigned as the Parent control for <var>PictureGroupBox</var>. InitPreviewControl is called from the inherited <var>CreatePreviewControl</var> method.
<var>InitPreviewControl</var> is overridden in <var>TOpenPictureDialog</var>. InitPreviewControl calls the inherited method, and ensures that <var>PreviewFileControl</var> is assigned as the Parent control for <var>PictureGroupBox</var>. InitPreviewControl is called from the inherited <var>CreatePreviewControl</var> method.
</p>
</descr>
<seealso>
@ -333,7 +337,7 @@
</short>
<descr>
<p>
<var>ClearPreview</var> is a procedure used to clear the image content and the caption displayed in the dialog. ClearPreview is called from the <var>DoShow</var>, <var>DoClose</var>, and <var>UpdatePreview</var> methods.
<var>ClearPreview</var> is a procedure used to clear the image content and the caption displayed in the dialog. ClearPreview is called from the <var>DoShow</var>, <var>DoClose</var>, and <var>UpdatePreview</var> methods.
</p>
</descr>
<seealso>
@ -425,7 +429,7 @@
<var>DoSelectionChange</var> is an overridden method used to perform actions needed when the selected file name for the dialog is changed. DoSelectionChange calls <var>UpdatePreview</var> to update the <var>PreviewFileName</var>, <var>ImageCtrl</var> and <var>PictureGroupBox</var> properties.
</p>
<p>
DoSelectionChange calls the inherited method to signal the <var>OnSelectionChange</var> event handler (when assigned).
DoSelectionChange calls the inherited method to signal the <var>OnSelectionChange</var> event handler (when assigned).
</p>
</descr>
<seealso>
@ -461,7 +465,7 @@
</short>
<descr>
<p>
<var>GetFilterExt</var> is a <var>String</var> function used to get the file extension for the value in the Filter property. GetFilterExt parses the value in <var>Filter</var>, and ignores the all files mask (<b>'*.*'</b>) in favor of actual file extensions included in the property.
<var>GetFilterExt</var> is a <var>String</var> function used to get the file extension for the value in the Filter property. GetFilterExt parses the value in <var>Filter</var>, and ignores the all files mask (<b>'*.*'</b>) in favor of actual file extensions included in the property.
</p>
<p>
The return value contains the file extension found in the Filter property. If no file extension is found in Filter, the value in <var>DefaultExt</var> is used as the return value.
@ -767,7 +771,7 @@
<var>TCalculatorDialog</var> is a <var>TExtCommonDialog</var> descendant which implements a pop-up calculator dialog used to perform calculations and return the result in the Value property. Value uses the Double type, and can be represented using the number of digits in the Precision property.
</p>
<p>
TCalculatorDialog uses a TCalculatorForm instance in the DlgForm property which includes separate panels to display the input value, numeric keys, labels, and other buttons on the dialog form. A CalculatorLayout property allows use of a detailed or a simplified view on the form. Properties are provided to set the colors used for components on DlgForm, including:
TCalculatorDialog uses a TCalculatorForm instance in the DlgForm property which includes separate panels to display the input value, numeric keys, labels, and other buttons on the dialog form. A CalculatorLayout property allows use of a detailed or a simplified view on the form. Properties are provided to set the colors used for components on DlgForm, including:
</p>
<ul>
<li>ColorBtnDigits</li>
@ -811,7 +815,7 @@
<short>Gets the value for the CalcDisplay property.</short>
<descr>
<p>
<var>GetDisplay</var> is a <var>Double</var> function used to get the display value from the form instance in <var>DlgForm</var>. If DlgForm has not been assigned, the <var>Value</var> property is used as the return value for the method.
<var>GetDisplay</var> is a <var>Double</var> function used to get the display value from the form instance in <var>DlgForm</var>. If DlgForm has not been assigned, the <var>Value</var> property is used as the return value for the method.
</p>
</descr>
<seealso>
@ -839,7 +843,7 @@
<short>Implements the event handler signalled when the dialog is closed.</short>
<descr>
<p>
<var>OnDialogClose</var> implements the event handler signalled when the dialog form is closed. OnDialogClose calls the DoClose method to execute the OnClose event handler (when assigned).
<var>OnDialogClose</var> implements the event handler signalled when the dialog form is closed. OnDialogClose calls the DoClose method to execute the OnClose event handler (when assigned).
</p>
<p>
<var>OnDialogClose</var> is assigned as the <var>OnClose</var> event handler for the form in <var>DlgForm</var> in the <var>Execute</var> method.
@ -884,7 +888,7 @@
</short>
<descr>
<p>
<var>OnDialogCloseQuery</var> implements the event handler signalled to determine if the dialog can be closed. OnDialogCloseQuery sets the value in the <var>UserChoice</var> property to the modal result returned by the dialog form in <var>DlgForm</var>. It calls <var>DoCanClose</var> to signal the <var>OnCanClose</var> event handler (when assigned).
<var>OnDialogCloseQuery</var> implements the event handler signalled to determine if the dialog can be closed. OnDialogCloseQuery sets the value in the <var>UserChoice</var> property to the modal result returned by the dialog form in <var>DlgForm</var>. It calls <var>DoCanClose</var> to signal the <var>OnCanClose</var> event handler (when assigned).
</p>
<p>
OnDialogCloseQuery is assigned as the <var>OnCloseQuery</var> event handler for the form in DlgForm in the <var>Execute</var> method.
@ -899,7 +903,7 @@
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorDialog.OnDialogCloseQuery.CanClose">
<short>True when the dialog can be closed.</short>
<short><b>True</b> when the dialog can be closed.</short>
</element>
<element name="TCalculatorDialog.Change">
@ -1008,13 +1012,13 @@
When <var>DialogScale</var> contains any value other than <b>100</b>, the scaling percentage is applied to DlgForm.
</p>
<p>
The value in <var>DialogPosition</var> is stored in DlgForm as well. At design-time, the dialog position is always aligned to the center of the screen (or current monitor). When DialogPosition is <var>poDesigned</var>, the form coordinates in DlgForm are set to the values in the <var>Left</var> and <var>Top</var> properties. The content stored in the <var>Title</var>, <var>Memory</var>, <var>Precision</var>, and <var>Value</var> properties are copied into the corresponding properties in DlgForm.
The value in <var>DialogPosition</var> is stored in DlgForm as well. At design-time, the dialog position is always aligned to the center of the screen (or current monitor). When DialogPosition is <var>poDesigned</var>, the form coordinates in DlgForm are set to the values in the <var>Left</var> and <var>Top</var> properties. The content stored in the <var>Title</var>, <var>Memory</var>, <var>Precision</var>, and <var>Value</var> properties are copied into the corresponding properties in DlgForm.
</p>
<p>
Execute calls the <var>ShowModal</var> method in DlgForm to display the modal calculator dialog form. The return value for the method is set to <b>True</b> when the modal result from the form is <var>mrOk</var>. When the result is <b>True</b>, the <var>Memory</var> and <var>Value</var> properties are updated with the values form the dialog form. The <var>Change</var> method is called when the Value property has been altered.
</p>
<p>
The coordinates for the form are captured on exit, and stored in the <var>Left</var> and <var>Top</var> properties. The dimensions for the form (Width and Height) are also stored.
The coordinates for the form are captured on exit, and stored in the <var>Left</var> and <var>Top</var> properties. The dimensions for the form (Width and Height) are also stored.
</p>
<p>
Execute frees the resources allocated to the DlgForm property prior to exit from the method.
@ -1034,7 +1038,7 @@
</seealso>
</element>
<element name="TCalculatorDialog.Execute.Result">
<short>True when the modal result for the form is mrOk.</short>
<short><b>True</b> when the modal result for the form is mrOk.</short>
</element>
<element name="TCalculatorDialog.CalcDisplay">
@ -1058,7 +1062,7 @@
</short>
<descr>
<p>
<var>Memory</var> is a read-only <var>Double</var> property which contains the numeric value stored using the Memory button on the calculator dialog. The value in Memory is passed to the form in <var>DlgForm</var> in the <var>Execute</var> method, and updated when the modal result for the calculator form is <var>mrOk</var>.
<var>Memory</var> is a read-only <var>Double</var> property which contains the numeric value stored using the Memory button on the calculator dialog. The value in Memory is passed to the form in <var>DlgForm</var> in the <var>Execute</var> method, and updated when the modal result for the calculator form is <var>mrOk</var>.
</p>
</descr>
<seealso>
@ -1069,7 +1073,7 @@
<element name="TCalculatorDialog.BeepOnError">
<short>
<var>BeepOnError</var> - if True, beeps when there is an entry error or other calculator error.
<var>BeepOnError</var> - if <b>True</b>, beeps when there is an entry error or other calculator error.
</short>
<descr>
<p>
@ -1088,7 +1092,7 @@
</short>
<descr>
<p>
<var>CalculatorLayout</var> is a <var>TCalculatorLayout</var> property which specifies the layout used for the calculator dialog form in <var>DlgForm</var>. CalculatorLayout is passed as an argument to the <var>CreateCalculatorForm</var> routine in <var>Execute</var>, and determines the size and position for the panels and buttons on the form.
<var>CalculatorLayout</var> is a <var>TCalculatorLayout</var> property which specifies the layout used for the calculator dialog form in <var>DlgForm</var>. CalculatorLayout is passed as an argument to the <var>CreateCalculatorForm</var> routine in <var>Execute</var>, and determines the size and position for the panels and buttons on the form.
</p>
<dl>
<dt>clNormal</dt>
@ -1173,7 +1177,7 @@
</short>
<descr>
<p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property used as the event handler signalled when the value for the calculator dialog is changed. OnChange is signalled from the <var>Change</var> method when the calculator dialog returns a modified value for the <var>Value</var> property.
<var>OnChange</var> is a <var>TNotifyEvent</var> property used as the event handler signalled when the value for the calculator dialog is changed. OnChange is signalled from the <var>Change</var> method when the calculator dialog returns a modified value for the <var>Value</var> property.
</p>
<p>
Applications must implement an object procedure using the signature in <var>TNotifyEvent</var> to respond to the event notification.
@ -1469,7 +1473,7 @@
</short>
<descr>
<p>
<var>DisplaySettings</var> contains the user-specified settings which determine the appearance for the calendar displayed in the dialog.
<var>DisplaySettings</var> contains the user-specified settings which determine the appearance for the calendar displayed in the dialog.
</p>
<p>
DisplaySettings is a set type which may contain zero or more settings. Possible values include: ShowHeadings,ShowDayNames, NoMonthChange, ShowWeekNumbers, StartMonday.