paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-04-07 14:38:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL. Fixes missing punctuation in short descriptions (partial).

Browse Source 
git-svn-id: trunk@65264 -
This commit is contained in:
dsiders 2021-06-18 02:42:06 +00:00
parent e90a7248d5
commit fc8b6ff125
9 changed files with 5381 additions and 5384 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,7 +7,7 @@
====================================================================
-->
<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:
@ -45,7 +45,7 @@
<element name="TPreviewFileControl">
<short>
<var>TPreviewFileControl</var> - a windowed control allowing the contents of a file to be previewed before opening
<var>TPreviewFileControl</var> - a windowed control allowing the contents of a file to be previewed before opening.
</short>
<descr>
<p>
@ -68,7 +68,7 @@
<element name="TPreviewFileControl.SetPreviewFileDialog">
<short>
Sets the value for the PreviewFileDialog property
Sets the value for the PreviewFileDialog property.
</short>
<descr/>
<seealso>
@ -76,7 +76,7 @@
</seealso>
</element>
<element name="TPreviewFileControl.SetPreviewFileDialog.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TPreviewFileControl.CreateParams" link="#lcl.controls.TWinControl.CreateParams">
@ -91,11 +91,11 @@
</seealso>
</element>
<element name="TPreviewFileControl.CreateParams.Params">
<short>Creation parameters updated in the method</short>
<short>Creation parameters updated in the method.</short>
</element>
<element name="TPreviewFileControl.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor. Create sets the value for the <var>CompStyle</var> member (deprecated), and calls <var>SetInitialBounds</var> to size the control using the values returned from <var>GetControlClassDefaultSize</var>.
@ -108,11 +108,11 @@
</seealso>
</element>
<element name="TPreviewFileControl.Create.TheOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TPreviewFileControl.PreviewFileDialog">
<short>Dialog which created the file preview control</short>
<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>.
@ -125,7 +125,7 @@
<element name="TPreviewFileDialog" link="#lcl.dialogs.TOpenDialog">
<short>
<var>TPreviewFileDialog</var> - a dialog that allows the contents of a file to be inspected before opening the file
<var>TPreviewFileDialog</var> - a dialog that allows the contents of a file to be inspected before opening the file.
</short>
<descr>
<p>
@ -141,7 +141,7 @@
<element name="TPreviewFileDialog.FPreviewFileControl"/>
<element name="TPreviewFileDialog.GetPreviewFileControl">
<short>Gets the value for the PreviewFileControl property</short>
<short>Gets the value for the PreviewFileControl property.</short>
<descr>
<p>
Calls <var>CreatePreviewControl</var> if a <var>TPreviewFileControl</var> instance has not already been created for the dialog.
@ -152,14 +152,14 @@
</seealso>
</element>
<element name="TPreviewFileDialog.GetPreviewFileControl.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TPreviewFileDialog.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TPreviewFileDialog.CreatePreviewControl">
<short>
<var>CreatePreviewControl</var> - create an instance of the windowed control used in the dialog
<var>CreatePreviewControl</var> - create an instance of the windowed control used in the dialog.
</short>
<descr>
<p>
@ -178,7 +178,7 @@
<element name="TPreviewFileDialog.InitPreviewControl">
<short>
<var>InitPreviewControl</var> - initializes the windowed control created for the dialog
<var>InitPreviewControl</var> - initializes the windowed control created for the dialog.
</short>
<descr>
<p>
@ -192,7 +192,7 @@
</element>
<element name="TPreviewFileDialog.DoExecute" link="#lcl.dialogs.TOpenDialog.DoExecute">
<short>Creates the PreviewFileControl and displays the dialog</short>
<short>Creates the PreviewFileControl and displays the dialog.</short>
<descr>
<p>
<var>DoExecute</var> is an overridden Boolean function in <var>TPreviewFileDialog</var>.
@ -213,7 +213,7 @@
</element>
<element name="TPreviewFileDialog.Create" link="#rtl.classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance. Create calls the inherited constructor, and sets the value in CompStyle (deprecated) to <var>csPreviewFileDialog</var>.
@ -224,12 +224,12 @@
</seealso>
</element>
<element name="TPreviewFileDialog.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<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>
@ -245,7 +245,7 @@
<element name="TOpenPictureDialog">
<short>
<var>TOpenPictureDialog</var> - a preview dialog that shows a preview of a picture before opening the file
<var>TOpenPictureDialog</var> - a preview dialog that shows a preview of a picture before opening the file.
</short>
<descr>
<p>
@ -268,7 +268,7 @@
<element name="TOpenPictureDialog.IsFilterStored">
<short>
<var>IsFilterStored</var> - returns True if a filter is stored
<var>IsFilterStored</var> - returns True if a filter is stored.
</short>
<descr>
<p>
@ -281,12 +281,12 @@
</seealso>
</element>
<element name="TOpenPictureDialog.IsFilterStored.Result">
<short>True when Filter is included in the LCL component streaming content</short>
<short>True when Filter is included in the LCL component streaming content.</short>
</element>
<element name="TOpenPictureDialog.ImageCtrl">
<short>
TImage used to preview the content in an image file
TImage used to preview the content in an image file.
</short>
<descr>
<var>ImageCtrl</var> is a read-only TImage property which contains the image used to preview the content for an image file on the local file system.
@ -312,7 +312,7 @@
</element>
<element name="TOpenPictureDialog.InitPreviewControl" link="#lcl.extdlgs.TPreviewFileDialog.InitPreviewControl">
<short>Initializes the PreviewFileControl for the dialog</short>
<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.
@ -327,7 +327,7 @@
<element name="TOpenPictureDialog.ClearPreview">
<short>
<var>ClearPreview</var> - clears the preview area
<var>ClearPreview</var> - clears the preview area.
</short>
<descr>
<p>
@ -344,7 +344,7 @@
<element name="TOpenPictureDialog.UpdatePreview">
<short>
<var>UpdatePreview</var> - updates the preview image, implementing any pending changes
<var>UpdatePreview</var> - updates the preview image, implementing any pending changes.
</short>
<descr>
<p>
@ -369,7 +369,7 @@
</element>
<element name="TOpenPictureDialog.Create" link="#rtl.classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor.
@ -390,12 +390,12 @@
</seealso>
</element>
<element name="TOpenPictureDialog.Create.TheOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TOpenPictureDialog.DoClose" link="#lcl.dialogs.TCommonDialog.DoClose">
<short>
Performs actions needed when the dialog is closed
Performs actions needed when the dialog is closed.
</short>
<descr>
<p>
@ -415,7 +415,7 @@
<element name="TOpenPictureDialog.DoSelectionChange" link="#lcl.dialogs.TOpenDialog.DoSelectionChange">
<short>
Performs actions needed when the selected file name for the dialog is changed
Performs actions needed when the selected file name for the dialog is changed.
</short>
<descr>
<p>
@ -436,7 +436,7 @@
<element name="TOpenPictureDialog.DoShow" link="#lcl.dialogs.TCommonDialog.DoShow">
<short>
Performs actions needed to display the preview dialog in its initial state
Performs actions needed to display the preview dialog in its initial state.
</short>
<descr>
<p>
@ -454,7 +454,7 @@
<element name="TOpenPictureDialog.GetFilterExt">
<short>
<var>GetFilterExt</var> - returns the extension for filtering filenames
<var>GetFilterExt</var> - returns the extension for filtering filenames.
</short>
<descr>
<p>
@ -476,13 +476,13 @@
</element>
<element name="TOpenPictureDialog.GetFilterExt.Result">
<short>
File extension found in the method, or an empty string when no extension is available
File extension found in the method, or an empty string when no extension is available.
</short>
</element>
<element name="TOpenPictureDialog.DefaultFilter">
<short>
<var>DefaultFilter</var> - the default filename filter
<var>DefaultFilter</var> - the default filename filter.
</short>
<descr>
<p>
@ -498,7 +498,7 @@
<element name="TOpenPictureDialog.Filter" link="#lcl.dialogs.TFileDialog.Filter">
<short>
Contains a delimited list of descriptions and extensions for file available in the dialog
Contains a delimited list of descriptions and extensions for file available in the dialog.
</short>
<descr>
<p>
@ -521,7 +521,7 @@
<element name="TSavePictureDialog">
<short>
<var>TSavePictureDialog</var> - a dialog for saving the picture in the current buffer to a file
<var>TSavePictureDialog</var> - a dialog for saving the picture in the current buffer to a file.
</short>
<descr>
<p>
@ -537,7 +537,7 @@
<element name="TSavePictureDialog.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TSavePictureDialog.DefaultTitle">
<short>Gets the default value for the Title property</short>
<short>Gets the default value for the Title property.</short>
<descr>
<p>
<var>DefaultTitle</var> is an overridden <var>String</var> function in <var>TSavePictureDialog</var>. It returns the value in <var>rsfdFileSaveAs</var> as the <var>Title</var> used for the dialog. DefaultTitle is used in the constructor in <var>TCommonDialog</var> to set the value for its <var>Title</var> property.
@ -551,11 +551,11 @@
</seealso>
</element>
<element name="TSavePictureDialog.DefaultTitle.Result">
<short>Default value for the Title property</short>
<short>Default value for the Title property.</short>
</element>
<element name="TSavePictureDialog.Create" link="#rtl.classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor. Create sets the value in the <var>FCompStyle</var> member (deprecated) to the value <var>csSaveFileDialog</var>.
@ -564,11 +564,11 @@
<seealso/>
</element>
<element name="TSavePictureDialog.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TExtCommonDialog" link="#lcl.dialogs.TCommonDialog">
<short>The common base class for custom drawn dialogs (Calculator and Calendar)</short>
<short>The common base class for custom drawn dialogs (Calculator and Calendar).</short>
<descr>
<p>
<var>TExtCommonDialog</var> is a <var>TCommonDialog</var> descendant which implements a common base class for custom drawn dialogs such as <var>TCalculatorDialog</var> and <var>TCalendarDialog</var>. It provides additional properties used to set the position for the form displayed in the dialog.
@ -591,74 +591,74 @@
<element name="TExtCommonDialog.FDlgForm"/>
<element name="TExtCommonDialog.GetLeft">
<short>Gets the value for the Left property</short>
<short>Gets the value for the Left property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Left"/>
</seealso>
</element>
<element name="TExtCommonDialog.GetLeft.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.GetHeight" link="#lcl.dialogs.TCommonDialog.GetHeight">
<short>Gets the value for the Height property</short>
<short>Gets the value for the Height property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Height"/>
</seealso>
</element>
<element name="TExtCommonDialog.GetHeight.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.GetTop">
<short>Gets the value for the Top property</short>
<short>Gets the value for the Top property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Top"/>
</seealso>
</element>
<element name="TExtCommonDialog.GetTop.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.GetWidth" link="#lcl.dialogs.TCommonDialog.GetWidth">
<short>Gets the value for the Width property</short>
<short>Gets the value for the Width property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Width"/>
</seealso>
</element>
<element name="TExtCommonDialog.GetWidth.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TExtCommonDialog.SetLeft">
<short>Sets the value for the Left property</short>
<short>Sets the value for the Left property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Left"/>
</seealso>
</element>
<element name="TExtCommonDialog.SetLeft.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TExtCommonDialog.SetTop">
<short>Sets the value for the Top property</short>
<short>Sets the value for the Top property.</short>
<descr/>
<seealso>
<link id="TExtCommonDialog.Top"/>
</seealso>
</element>
<element name="TExtCommonDialog.SetTop.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TExtCommonDialog.DlgForm">
<short>
Contains the form displayed modally for the custom-drawn dialog
Contains the form displayed modally for the custom-drawn dialog.
</short>
<descr>
<p>
@ -678,7 +678,7 @@
</element>
<element name="TExtCommonDialog.Create" link="#lcl.dialogs.TCommonDialog.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method. Create sets the default value for the <var>DialogPosition</var> property to <var>poMainFormCenter</var>.
</descr>
@ -688,17 +688,17 @@
</seealso>
</element>
<element name="TExtCommonDialog.Create.AOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TExtCommonDialog.Destroy" link="#lcl.dialogs.TCommonDialog.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TExtCommonDialog.Left">
<short>Contains the left coordinate for the dialog form</short>
<short>Contains the left coordinate for the dialog form.</short>
<descr>
<p>
<var>Left</var> is an <var>Integer</var> property which contains the client coordinate for the left-hand edge of the dialog. Read and write access for the property value are redirected to the Left property in DlgForm (when assigned).
@ -714,7 +714,7 @@
</element>
<element name="TExtCommonDialog.Top">
<short>Contains the top coordinate for the dialog form</short>
<short>Contains the top coordinate for the dialog form.</short>
<descr>
<p>
<var>Top</var> is an <var>Integer</var> property which contains the client coordinate for the top edge of the dialog. Read and write access for the property value are redirected to the Top property in DlgForm (when assigned).
@ -731,7 +731,7 @@
<element name="TExtCommonDialog.DialogPosition">
<short>
Specifies the position where the dialog is displayed
Specifies the position where the dialog is displayed.
</short>
<descr>
<p>
@ -753,7 +753,7 @@
<element name="TCalculatorDialog" link="#lcl.extdlgs.TExtCommonDialog">
<short>
Implements a pop-up calculator dialog used to perform simple calculations and return the value
Implements a pop-up calculator dialog used to perform simple calculations and return the value.
</short>
<descr>
<p>
@ -801,7 +801,7 @@
<element name="TCalculatorDialog.FColorDisplayBack"/>
<element name="TCalculatorDialog.GetDisplay">
<short>Gets the value for the CalcDisplay property</short>
<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.
@ -812,24 +812,24 @@
</seealso>
</element>
<element name="TCalculatorDialog.GetDisplay.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCalculatorDialog.SetDialogScale">
<short>Sets the value for the DialogScale property</short>
<short>Sets the value for the DialogScale property.</short>
<descr/>
<seealso>
</seealso>
<link id="TCalculatorDialog.DialogScale"/>
</element>
<element name="TCalculatorDialog.SetDialogScale.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCalculatorDialog.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCalculatorDialog.OnDialogClose">
<short>Implements the event handler signalled when the dialog is closed</short>
<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).
@ -845,14 +845,14 @@
</seealso>
</element>
<element name="TCalculatorDialog.OnDialogClose.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorDialog.OnDialogClose.CloseAction">
<short>Action performed to close the dialog</short>
<short>Action performed to close the dialog.</short>
</element>
<element name="TCalculatorDialog.OnDialogShow">
<short>Implements the event handler signalled when the dialog is displayed</short>
<short>Implements the event handler signalled when the dialog is displayed.</short>
<descr>
<p>
<var>OnDialogShow</var> implements the event handler signalled when the dialog form is displayed. OnDialogShow calls the <var>DoShow</var> method to signal the <var>OnShow</var> event handler (when assigned).
@ -868,12 +868,12 @@
</seealso>
</element>
<element name="TCalculatorDialog.OnDialogShow.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorDialog.OnDialogCloseQuery">
<short>
Implements the event handler signalled to determine if the dialog can be closed
Implements the event handler signalled to determine if the dialog can be closed.
</short>
<descr>
<p>
@ -889,10 +889,10 @@
</seealso>
</element>
<element name="TCalculatorDialog.OnDialogCloseQuery.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TCalculatorDialog.OnDialogCloseQuery.CanClose">
<short>True when the dialog can be closed</short>
<short>True when the dialog can be closed.</short>
</element>
<element name="TCalculatorDialog.Change">
@ -911,7 +911,7 @@
<element name="TCalculatorDialog.CalcKey">
<short>
Implements the event handler signalled to process keys in the dialog
Implements the event handler signalled to process keys in the dialog.
</short>
<descr>
<p>
@ -928,12 +928,12 @@
</seealso>
</element>
<element name="TCalculatorDialog.CalcKey.Key">
<short>Key examined in the event handler</short>
<short>Key examined in the event handler.</short>
</element>
<element name="TCalculatorDialog.DefaultTitle" link="#lcl.dialogs.TCommonDialog.DefaultTitle">
<short>
Gets the default value used in the Title property for the calculator dialog
Gets the default value used in the Title property for the calculator dialog.
</short>
<descr>
<p>
@ -950,36 +950,36 @@
</seealso>
</element>
<element name="TCalculatorDialog.DefaultTitle.Result">
<short></short>
<short>.</short>
</element>
<element name="TCalculatorDialog.DisplayChange">
<short>
<var>DisplayChange</var> - software emulator for the <var>OnDisplayChange</var> event
<var>DisplayChange</var> - software emulator for the <var>OnDisplayChange</var> event.
</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.Create" link="#rtl.classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="TCalculatorDialog.Create.AOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCalculatorDialog.Destroy" link="#rtl.classes.TComponent.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.Execute">
<short>Creates, configures, and displays the form for the calculator dialog</short>
<short>Creates, configures, and displays the form for the calculator dialog.</short>
<descr>
<p>
<var>Execute</var> is an overridden <var>Boolean</var> function used to create, configure, display, and capture the result from the form for the calculator dialog. Execute calls <var>CreateCalculatorForm</var> to create the <var>TCalculatorForm</var> in the <var>DlgForm</var> property, and sets the event handlers for the form to methods defined in the class instance. For example:
@ -1026,12 +1026,12 @@
</seealso>
</element>
<element name="TCalculatorDialog.Execute.Result">
<short>True when the modal result for the form is mrOk</short>
<short>True when the modal result for the form is mrOk.</short>
</element>
<element name="TCalculatorDialog.CalcDisplay">
<short>
<var>CalcDisplay</var> - the current numeric value in the main calculator display
<var>CalcDisplay</var> - the current numeric value in the main calculator display.
</short>
<descr>
<p>
@ -1046,7 +1046,7 @@
<element name="TCalculatorDialog.Memory">
<short>
<var>Memory</var> - the value stored in the calculator's memory
<var>Memory</var> - the value stored in the calculator's memory.
</short>
<descr>
<p>
@ -1061,7 +1061,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 True, beeps when there is an entry error or other calculator error.
</short>
<descr>
<p>
@ -1076,7 +1076,7 @@
<element name="TCalculatorDialog.CalculatorLayout">
<short>
<var>CalculatorLayout</var> - whether simple or normal
<var>CalculatorLayout</var> - whether simple or normal.
</short>
<descr>
<p>
@ -1101,7 +1101,7 @@
<element name="TCalculatorDialog.Precision">
<short>
<var>Precision</var> - the level of precision to be used in calculations; default is set by <var>DefCalcPrecision</var>
<var>Precision</var> - the level of precision to be used in calculations; default is set by <var>DefCalcPrecision</var>.
</short>
<descr>
<p>
@ -1124,7 +1124,7 @@
<element name="TCalculatorDialog.Value">
<short>
<var>Value</var> - the numeric value (result) returned by the calculator
<var>Value</var> - the numeric value (result) returned by the calculator.
</short>
<descr>
<p>
@ -1142,7 +1142,7 @@
<element name="TCalculatorDialog.OnCalcKey">
<short>
<var>OnCalcKey</var> - event handler for a key press in the calculator
<var>OnCalcKey</var> - event handler for a key press in the calculator.
</short>
<descr>
<p>
@ -1161,7 +1161,7 @@
<element name="TCalculatorDialog.OnChange">
<short>
<var>OnChange</var> - event handler for any change in the calculator
<var>OnChange</var> - event handler for any change in the calculator.
</short>
<descr>
<p>
@ -1181,7 +1181,7 @@
<element name="TCalculatorDialog.OnDisplayChange">
<short>
<var>OnDisplayChange</var> - event handler for any change in the calculator display
<var>OnDisplayChange</var> - event handler for any change in the calculator display.
</short>
<descr>
<var>OnDisplayChange</var> is a <var>TNotifyEvent</var> property used as the event handler signalled when the display value for the calculator dialog is changed. OnDisplayChange is signalled from the <var>DisplayChanged</var> method which is assigned as the <var>OnDisplayChange</var> event handler in <var>DlgForm</var>.
@ -1196,7 +1196,7 @@
<element name="TCalculatorDialog.DialogScale">
<short>
Scaling percentage applied to the calculator dialog form
Scaling percentage applied to the calculator dialog form.
</short>
<descr>
<p>
@ -1215,55 +1215,55 @@
</element>
<element name="TCalculatorDialog.ColorBtnDigits">
<short>Color for the digit buttons displayed in the calculator dialog</short>
<short>Color for the digit buttons displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorBtnMemory">
<short>Color for the Memory button displayed in the calculator dialog</short>
<short>Color for the Memory button displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorBtnOk">
<short>Color for the OK button displayed in the calculator dialog</short>
<short>Color for the OK button displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorBtnCancel">
<short>Color for the Cancel button displayed in the calculator dialog</short>
<short>Color for the Cancel button displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorBtnClear">
<short>Color for the Clear button displayed in the calculator dialog</short>
<short>Color for the Clear button displayed in the calculator dialog.</short>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorBtnOthers">
<short>Color for other buttons displayed in the calculator dialog</short>
<short>Color for other buttons displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorDisplayText">
<short>Color for text displayed in the calculator dialog</short>
<short>Color for text displayed in the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalculatorDialog.ColorDisplayBack">
<short>Color for background in the display area for the calculator dialog</short>
<short>Color for background in the display area for the calculator dialog.</short>
<descr/>
<seealso/>
</element>
<element name="TCalendarDialog" link="#lcl.extdlgs.TExtCommonDialog">
<short>
<var>TCalendarDialog</var> - a popup calendar dialog that allows a date to be selected and returned to the main program
<var>TCalendarDialog</var> - a popup calendar dialog that allows a date to be selected and returned to the main program.
</short>
<descr>
<p>
@ -1297,133 +1297,133 @@
<element name="TCalendarDialog.panel"/>
<element name="TCalendarDialog.OnDialogClose">
<short>Implements the event handler signalled when the dialog form is closed</short>
<short>Implements the event handler signalled when the dialog form is closed.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogClose.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnDialogClose.CloseAction">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery">
<short>
Implements an event handler signalled to determine if the dialog form can be closed
Implements an event handler signalled to determine if the dialog form can be closed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnDialogCloseQuery.CanClose">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnDialogShow">
<short>
Implements an event handler signalled when the dialog form is displayed
Implements an event handler signalled when the dialog form is displayed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnDialogShow.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnCalendarDayChanged">
<short>
Implements an event handler signalled when the day number in Date is changed
Implements an event handler signalled when the day number in Date is changed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarDayChanged.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnCalendarMonthChanged">
<short>
Implements an event handler signalled when the month in Date is changed
Implements an event handler signalled when the month in Date is changed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarMonthChanged.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnCalendarYearChanged">
<short>
Implements an event handler signalled when the year in Date is changed
Implements an event handler signalled when the year in Date is changed.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarYearChanged.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.OnCalendarChange">
<short>
Event handler used to signal the OnChange event when the Calendar is updated
Event handler used to signal the OnChange event when the Calendar is updated.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.OnCalendarChange.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
<element name="TCalendarDialog.GetNewDate">
<short>
<var>GetNewDate</var> - programmatic simulation of <var>OnClick</var> event, which transfers the selected date to the calling program
<var>GetNewDate</var> - programmatic simulation of <var>OnClick</var> event, which transfers the selected date to the calling program.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.GetNewDate.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.CalendarDblClick">
<short>
<var>CalendarDblClick</var> - method for handling doubleclick on the calendar
<var>CalendarDblClick</var> - method for handling doubleclick on the calendar.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.CalendarDblClick.Sender">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.DefaultTitle">
<short>
Contains the default value for the Title displayed on the calendar dialog form
Contains the default value for the Title displayed on the calendar dialog form.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.DefaultTitle.Result">
<short></short>
<short>.</short>
</element>
<element name="TCalendarDialog.Create" link="#rtl.classes.TComponent.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TCalendarDialog.Create.AOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCalendarDialog.Execute" link="#lcl.dialogs.TCommonDialog.Execute">
<short>
Configures and dIsplays the form for the calendar dialog, and captures the results
Configures and dIsplays the form for the calendar dialog, and captures the results.
</short>
<descr/>
<seealso/>
@ -1433,19 +1433,19 @@
</element>
<element name="TCalendarDialog.Left">
<short>Contains the left coordinate for the dialog</short>
<short>Contains the left coordinate for the dialog.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.Top">
<short>Contains the top coordinate for the dialog</short>
<short>Contains the top coordinate for the dialog.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCalendarDialog.Date">
<short>The selected <var>Date</var>, for return to the main program</short>
<short>The selected <var>Date</var>, for return to the main program.</short>
<descr>
<p>The selected <var>Date</var>, for return to the main program.</p>
<p>This is NOT the standard RTL Date function.</p>
@ -1455,7 +1455,7 @@
<element name="TCalendarDialog.DisplaySettings">
<short>
<var>DisplaySettings</var> - the user-selected settings determining the appearance of the display
<var>DisplaySettings</var> - the user-selected settings determining the appearance of the display.
</short>
<descr>
<p>
@ -1470,7 +1470,7 @@
<element name="TCalendarDialog.OnDayChanged">
<short>
<var>OnDayChanged</var> - event handler when a different day is selected
<var>OnDayChanged</var> - event handler when a different day is selected.
</short>
<descr/>
<seealso/>
@ -1478,7 +1478,7 @@
<element name="TCalendarDialog.OnMonthChanged">
<short>
Event handler signalled when a different month is selected
Event handler signalled when a different month is selected.
</short>
<descr>
<p>
@ -1490,7 +1490,7 @@
<element name="TCalendarDialog.OnYearChanged">
<short>
<var>OnYearChanged</var> - event handler when a different year is selected
<var>OnYearChanged</var> - event handler when a different year is selected.
</short>
<descr/>
<seealso/>
@ -1498,7 +1498,7 @@
<element name="TCalendarDialog.OnChange">
<short>
Event handler signalled when the valuein Date has been changed
Event handler signalled when the valuein Date has been changed.
</short>
<descr></descr>
<seealso></seealso>
@ -1506,7 +1506,7 @@
<element name="TCalendarDialog.OKCaption">
<short>
Caption displayed on the OK button
Caption displayed on the OK button.
</short>
<descr>
<p>
@ -1518,7 +1518,7 @@
<element name="TCalendarDialog.CancelCaption">
<short>
Caption displayed on the Cancel button for the calendar dialog form
Caption displayed on the Cancel button for the calendar dialog form.
</short>
<descr>
<p>
@ -1529,7 +1529,7 @@
</element>
<element name="Register">
<short>Registers components in the unit for use in the Lazarus IDE</short>
<short>Registers components in the unit for use in the Lazarus IDE.</short>
<descr>
<p>
<var>Register</var> is a procedure used to register components in the <file>extdlgs.pas</file> unit for use in the Lazarus IDE. Register adds the <var>TOpenPictureDialog</var>, <var>TSavePictureDialog</var>, <var>TCalendarDialog</var>, and <var>TCalculatorDialog</var> components to the <b>'Dialogs'</b> tab in the Lazarus IDE.

2
docs/xml/lcl/extgraphics.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ExtGraphics">
<short>Types and routines used to implement extended graphic drawing</short>
<short>Types and routines used to implement extended graphic drawing.</short>
<descr>
<p>
<file>extgraphics.pas</file> contains types and routines which implement extended drawing routines for various shapes. This file is part of the Lazarus Component Library (<b>LCL</b>).

130
docs/xml/lcl/filectrl.xml
View File

@ -8,7 +8,7 @@
-->
<module name="FileCtrl">
<short>
Implements list box and combo-box controls used to select files on the local file system
Implements list box and combo-box controls used to select files on the local file system.
</short>
<descr>
<p>
@ -31,7 +31,7 @@
<element name="Masks"/>
<element name="TFileAttr">
<short>Enumerated type with file and directory attributes used in TFileListBox</short>
<short>Enumerated type with file and directory attributes used in TFileListBox.</short>
<descr>
<p>
<var>TFileAttr</var> is an enumerated type with values that represent file and directory attributes for a selection in <var>TFileListBox</var>. Values from TFileAttr are stored in the <var>TFileType</var> set, which is used to implement the <var>FileType</var> property in TFileListBox.
@ -94,7 +94,7 @@
</element>
<element name="TFileType">
<short>Set type used to store file attributes</short>
<short>Set type used to store file attributes.</short>
<descr>
<p>
<var>TFileType</var> is a set type used to store zero (0) or more enumeration values from <var>TFileAttr</var>. TFileType is the type used to implement the <var>FileType</var> property in <var>TFileListBox</var>.
@ -107,7 +107,7 @@
</element>
<element name="TCustomFileListBox">
<short>Implements the base class for a file selection list box</short>
<short>Implements the base class for a file selection list box.</short>
<descr>
<p>
<var>TCustomFileListBox</var> is a TCustomListBox descendant which implements the base type for <var>TFileListBox</var>. TCustomFileListBox extends the ancestor with properties, methods, and events used to select a file or directory on the local file system in a list box control.
@ -152,7 +152,7 @@
<element name="TCustomFileListBox.FLastChangeFileName"/>
<element name="TCustomFileListBox.MaskIsStored">
<short>Storage specifier for the Mask property</short>
<short>Storage specifier for the Mask property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.Mask"/>
@ -165,62 +165,62 @@
</element>
<element name="TCustomFileListBox.SetDirectory">
<short>Sets the value for the Directory property</short>
<short>Sets the value for the Directory property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.Directory"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetDirectory.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.SetDrive">
<short>Sets the value for the Drive property</short>
<short>Sets the value for the Drive property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.Drive"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetDrive.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.SetFileName">
<short>Sets the value for the FileName property</short>
<short>Sets the value for the FileName property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.FileName"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetFileName.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.SetFileType">
<short>Sets the value for the FileType property</short>
<short>Sets the value for the FileType property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.FileType"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetFileType.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.SetMask">
<short>Sets the value for the Mask property</short>
<short>Sets the value for the Mask property.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.Mask"/>
</seealso>
</element>
<element name="TCustomFileListBox.SetMask.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.UpdateSelectedFileName">
<short>Updates the value in FileName when a new item is selected in the list box</short>
<short>Updates the value in FileName when a new item is selected in the list box.</short>
<descr/>
<seealso>
<link id="TCustomFileListBox.FileName"/>
@ -261,7 +261,7 @@
</element>
<element name="TCustomFileListBox.IndexOfFile">
<short>Gets the ordinal position for the specified file name in Items</short>
<short>Gets the ordinal position for the specified file name in Items.</short>
<descr>
<p>
<var>IndexOfFile</var> is an Integer function used to get the ordinal position for the specified file name in the list of file names in the control. <var>AFilename</var> contains the file name to locate in the method.
@ -279,14 +279,14 @@
</seealso>
</element>
<element name="TCustomFileListBox.IndexOfFile.Result">
<short>Ordinal position in Items for the specified file name, or -1 when not found</short>
<short>Ordinal position in Items for the specified file name, or -1 when not found.</short>
</element>
<element name="TCustomFileListBox.IndexOfFile.AFilename">
<short>File name to locate in Items</short>
<short>File name to locate in Items.</short>
</element>
<element name="TCustomFileListBox.KeyUp">
<short>Implements the handler for KeyUp events in the control</short>
<short>Implements the handler for KeyUp events in the control.</short>
<descr>
<p>
Overridden in <var>TCustomFileListBox</var> to update the selected file name prior to calling the inherited method.
@ -299,14 +299,14 @@
</seealso>
</element>
<element name="TCustomFileListBox.KeyUp.Key">
<short>Virtual key code examined in the method</short>
<short>Virtual key code examined in the method.</short>
</element>
<element name="TCustomFileListBox.KeyUp.Shift">
<short>Shift, Alt, or Ctrl modifier for the virtual key</short>
<short>Shift, Alt, or Ctrl modifier for the virtual key.</short>
</element>
<element name="TCustomFileListBox.SetItemIndex">
<short>Sets the value for the ItemIndex property</short>
<short>Sets the value for the ItemIndex property.</short>
<descr>
<p>
<var>SetItemIndex</var> is an overridden method in <var>TCustomFileListBox</var>. Calls the inherited method on entry. Calls <var>UpdateSelectedFileName</var> to set the new value for the <var>FileName</var> property.
@ -319,11 +319,11 @@
</seealso>
</element>
<element name="TCustomFileListBox.SetItemIndex.AIndex">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFileListBox.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited constructor on entry. Create sets the default values for properties in the class instance, including:
@ -358,11 +358,11 @@
</seealso>
</element>
<element name="TCustomFileListBox.Create.TheOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TCustomFileListBox.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the overridden destructor for the class instance, and calls the inherited destructor on entry.
@ -374,7 +374,7 @@
</element>
<element name="TCustomFileListBox.Click">
<short>Performs actions needed when the mouse is clicked on the list box control</short>
<short>Performs actions needed when the mouse is clicked on the list box control.</short>
<descr>
<p>
<var>Click</var> is an overridden method in <var>TCustomFileListBox</var> used to perform actions needed when the mouse is clicked in the list box control. Click ensures that the value in the <var>FileName</var> property is updated to reflect the selected file name in <var>Items</var>. <var>ItemIndex</var> contains the position for the current selection in the list box.
@ -394,7 +394,7 @@
</element>
<element name="TCustomFileListBox.UpdateFileList">
<short>Loads the list of files and/or directories for the list box control</short>
<short>Loads the list of files and/or directories for the list box control.</short>
<descr>
<p>
<var>UpdateFileList</var> is a method used to load the list of file and/or directory names in the Items for the control. No actions are performed in the method at design-time, or when the component is being loaded using the LCL streaming mechanism.
@ -419,7 +419,7 @@
</element>
<element name="TCustomFileListBox.Drive">
<short>The <var>Drive</var> on which the file is located (applies to Windows systems)</short>
<short>The <var>Drive</var> on which the file is located (applies to Windows systems).</short>
<descr>
<p>
<var>Drive</var> is a Char property which indicates the current drive letter for the Directory in the list box control. Drive is relevant for file systems which use drive designations (Windows).
@ -443,7 +443,7 @@
</element>
<element name="TCustomFileListBox.Directory">
<short>The <var>Directory</var> or Folder in which the file is located</short>
<short>The <var>Directory</var> or Folder in which the file is located.</short>
<descr>
<p>
<var>Directory</var> is a <var>String</var> property which contains the path on the local file system to the files or and/or directories displayed in the list box control. The initial value for Directory is assigned in the constructor and defaults to the current directory for the application.
@ -471,7 +471,7 @@
<element name="TCustomFileListBox.FileName">
<short>
<var>FileName</var> - the name of the selected file</short>
<var>FileName</var> - the name of the selected file.</short>
<descr>
<p>
<var>FileName</var> is a <var>String</var> property which contains the file name for the currently selected item in the list box control. The value in FileName is updated when an item in the control is selected, or when a new value is assigned to the <var>ItemIndex</var> property.
@ -492,7 +492,7 @@
<element name="TCustomFileListBox.FileType">
<short>
<var>FileType</var> - the type or attributes of the selected file</short>
<var>FileType</var> - the type or attributes of the selected file.</short>
<descr>
<p>
<var>FileType</var> is a <var>TFileType</var> set property which contains zero (0) or more values from the <var>TFileAttr</var> enumeration. FileType determines the file system entries displayed in the list box control. See <link id="TFileAttr">TFileAttr</link> for more information about the enumeration values and their meanings.
@ -513,7 +513,7 @@
</element>
<element name="TCustomFileListBox.Mask">
<short>Contains the mask for files selected for the control</short>
<short>Contains the mask for files selected for the control.</short>
<descr>
<p>
<var>Mask</var> should be filled with one or more file masks separated by semi-colons. For example: <b>'*.pdf;*.svg'</b> will show all files with the extensions pdf and svg. The default value for the property is <b>'*'</b> which is the generic mask meaning any file or directory. Do not use the Windows specific mask <b>'*.*'</b> to attempt to show all files, which is the behavior from Delphi. In the LCL version of the control '*.*' will <b>require</b> the file name to have an extension.
@ -536,7 +536,7 @@
</element>
<element name="TCustomFileListBox.OnChange">
<short>Event handler signalled when the selected file in the list box control is changed</short>
<short>Event handler signalled when the selected file in the list box control is changed.</short>
<descr>
<p>
<var>OnChange</var> is a <var>TNotifyEvent</var> property which contains the event handler signalled when the selected file for the control has been changed. This can occur when clicking on an entry in list box, when assigning a value directly to the <var>FileName</var> property, and when the list of file system entries in the control is reloaded.
@ -553,7 +553,7 @@
</element>
<element name="TCustomFileListBox.Sorted">
<short>Indicates if values in Items are sort in ascending alphanumeric order</short>
<short>Indicates if values in Items are sort in ascending alphanumeric order.</short>
<descr>
<p>
<var>Sorted</var> is a public property in <var>TCustomFileListBox</var>, and indicates if values stored in <var>Items</var> are sorted in ascending alphanumeric order. The default value for the property is <b>True</b>.
@ -566,7 +566,7 @@
</element>
<element name="TFileListBox">
<short>Implements a file selection list box control</short>
<short>Implements a file selection list box control.</short>
<descr>
<p>
<var>TFileListBox</var> is a <var>TCustomFileListBox</var> descendant which implements a file selection list box control. It is used to select a file or directory on the local file system. TFileListBox sets the visibility for properties introduced in an ancestor class, and does not contains any new properties, methods, or events.
@ -646,7 +646,7 @@
<element name="TFileListBox.ParentBiDiMode" link="#lcl.controls.TControl.ParentBiDiMode"/>
<element name="TCustomFilterComboBox">
<short>Specifies a combo-box used to select a file filter</short>
<short>Specifies a combo-box used to select a file filter.</short>
<descr>
<p>
<var>TCustomFilterComboBox</var> is a <var>TCustomComboBox</var> descendant which defines a combo-box used to select files which match a selection filter.
@ -678,29 +678,29 @@
<element name="TCustomFilterComboBox.FShellTreeView"/>
<element name="TCustomFilterComboBox.SetFilter">
<short>Sets the value for the Filter property</short>
<short>Sets the value for the Filter property.</short>
<descr/>
<seealso>
<link id="TFilterComboBox.Filter"/>
</seealso>
</element>
<element name="TCustomFilterComboBox.SetFilter.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFilterComboBox.SetShellListView">
<short>Sets the value for the ShellListView property</short>
<short>Sets the value for the ShellListView property.</short>
<descr/>
<seealso>
<link id="TCustomFilterComboBox.ShellListView"/>
</seealso>
</element>
<element name="TCustomFilterComboBox.SetShellListView.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFilterComboBox.Select">
<short>Performs actions needed when the selected item (ItemIndex) has been changed</short>
<short>Performs actions needed when the selected item (ItemIndex) has been changed.</short>
<descr>
<p>
<var>Select</var> is an overridden method in <var>TCustomFilterComboBox</var>. It ensures that the value in <var>Mask</var> is also applied to the <var>ShellListView</var> control (when assigned). This forces the ShellListView to reload the list of matching files displayed in the control.
@ -717,19 +717,19 @@
</element>
<element name="TCustomFilterComboBox.Notification" link="#lcl.controls.TControl.Notification">
<short>Handles notification messages for sub-components in the control</short>
<short>Handles notification messages for sub-components in the control.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFilterComboBox.Notification.AComponent">
<short>Component for the notification message</short>
<short>Component for the notification message.</short>
</element>
<element name="TCustomFilterComboBox.Notification.Operation">
<short>Operation for the notification message</short>
<short>Operation for the notification message.</short>
</element>
<element name="TCustomFilterComboBox.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. Create sets the value for the <var>Text</var> property to an empty string (<b>''</b>).
@ -740,11 +740,11 @@
</seealso>
</element>
<element name="TCustomFilterComboBox.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCustomFilterComboBox.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
Destroy calls the inherited destructor.
@ -755,7 +755,7 @@
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings">
<short>Parses the file filter(s) in AFilter and stores them in AStrings</short>
<short>Parses the file filter(s) in AFilter and stores them in AStrings.</short>
<descr>
<p>
<var>ConvertFilterToStrings</var> is a class procedure used to parse the LCL filter string in <var>AFilter</var>, and store the individual filters in <var>AStrings</var>.
@ -788,23 +788,23 @@ Binaries (*.exe)</pre>
</seealso>
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AFilter">
<short>Values converted in the method</short>
<short>Values converted in the method.</short>
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AStrings">
<short>TStrings instance where the filters are stored</short>
<short>TStrings instance where the filters are stored.</short>
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AClearStrings">
<short>Indicates if existing values in AStrings are cleared</short>
<short>Indicates if existing values in AStrings are cleared.</short>
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AAddDescription">
<short>True if the filter description is included in the converted values</short>
<short>True if the filter description is included in the converted values.</short>
</element>
<element name="TCustomFilterComboBox.ConvertFilterToStrings.AAddFilter">
<short>True if the filter mask expression is included in the converted values</short>
<short>True if the filter mask expression is included in the converted values.</short>
</element>
<element name="TCustomFilterComboBox.Mask">
<short>File mask for the selected filter in the control</short>
<short>File mask for the selected filter in the control.</short>
<descr>
<p>
<var>Mask</var> is a read-only <var>String</var> property with the file mask for the selected <var>Filter</var> in the control.
@ -827,7 +827,7 @@ Binaries (*.exe)</pre>
</element>
<element name="TCustomFilterComboBox.ShellListView">
<short>Connects the control to a TShellListView instance</short>
<short>Connects the control to a TShellListView instance.</short>
<descr>
<p>
<var>ShellListView</var> is a <var>TShellListView</var> property which contains an optional list view control connected to the combo-box control. The files shown in the TShellListView will be limited to the <var>Mask</var> (or selected Filter) in the control.
@ -844,7 +844,7 @@ Binaries (*.exe)</pre>
</element>
<element name="TFilterComboBox">
<short>Implements a combo-box used to select a file filter</short>
<short>Implements a combo-box used to select a file filter.</short>
<descr>
<p>
<var>TFilterComboBox</var> is a <var>TCustomFilterComboBox</var> descendant which implements a combo-box used to select files which match a selection filter. Use the <var>Filter</var> property to define the filter names and expressions available in the drop-down for the combo-box. Only the filter name is displayed in the combo-box.
@ -891,7 +891,7 @@ Binaries (*.exe)</pre>
<element name="TFilterComboBox.Enabled" link="#lcl.controls.TControl.Enabled"/>
<element name="TFilterComboBox.Filter">
<short>Contains one or more file filters used in the combo-box</short>
<short>Contains one or more file filters used in the combo-box.</short>
<descr>
<p>
<var>Filter</var> is a <var>String</var> property which is published in <var>TFilterComboBox</var>. Filter contains the file filter(s) which are used in the <var>Items</var> property. Each filter value in the string contains a textual description and mask. For example:
@ -943,7 +943,7 @@ Binaries (*.exe)</pre>
<element name="TFilterComboBox.OnUTF8KeyPress" link="#lcl.controls.TWinControl.OnUTF8KeyPress"/>
<element name="MinimizeName">
<short>Returns a shortened version of a file name, so that it fits within the given MaxWidth</short>
<short>Returns a shortened version of a file name, so that it fits within the given MaxWidth.</short>
<descr>
<p>
This function will return a shortened version of <var>FileName</var>, so that it fits within the width given in <var>MaxWidth</var>. It uses the Font currently assigned to the <var>Canvas</var> argument.
@ -960,20 +960,20 @@ Binaries (*.exe)</pre>
</descr>
</element>
<element name="MinimizeName.Result">
<short>File name shortened to the maximum length when needed</short>
<short>File name shortened to the maximum length when needed.</short>
</element>
<element name="MinimizeName.FileName">
<short>File name examined and shortened in the routine</short>
<short>File name examined and shortened in the routine.</short>
</element>
<element name="MinimizeName.Canvas">
<short>Canvas with the font used to measure the file name</short>
<short>Canvas with the font used to measure the file name.</short>
</element>
<element name="MinimizeName.MaxWidth">
<short>Maximum width (in pixels) for the file name on the canvas</short>
<short>Maximum width (in pixels) for the file name on the canvas.</short>
</element>
<element name="Register">
<short>Registers components in the unit for use in the Lazarus IDE</short>
<short>Registers components in the unit for use in the Lazarus IDE.</short>
<descr>
<p>
<var>Register</var> is a procedure used to register components in the unit for use in the Lazarus IDE. Register calls <var>RegisterComponents</var> to add the <var>TFileListBox</var> and <var>TFilterComboBox</var> components on the <b>Misc</b> tab in the Lazarus IDE.

2
docs/xml/lcl/finddlgunit.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="FindDlgUnit">
<short>Contains a form template for the find dialog in LCL</short>
<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.

2673
docs/xml/lcl/forms.xml
View File

File diff suppressed because it is too large Load Diff

3596
docs/xml/lcl/graphics.xml
View File

File diff suppressed because it is too large Load Diff

36
docs/xml/lcl/graphmath.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="GraphMath">
<short>A Set of Mathematical Helper routines to simply Cross-Platform Canvas drawing etc</short>
<short>A Set of Mathematical Helper routines to simply Cross-Platform Canvas drawing etc.</short>
<descr/>
<!-- unresolved external references -->
@ -19,7 +19,7 @@
<element name="TFloatPoint">
<short>
<var>TFloatPoint</var> - an extended precision record specifying the X and Y coordinates of a point in a graphic environment</short>
<var>TFloatPoint</var> - an extended precision record specifying the X and Y coordinates of a point in a graphic environment.</short>
<descr/>
<seealso/>
</element>
@ -50,7 +50,7 @@
<!-- procedure Visibility: default -->
<element name="Angles2Coords">
<short>
<var>Angles2Coords</var> - convert an Eccentric Angle and an Angle-Length, into the coords for Start and End Radial-Points</short>
<var>Angles2Coords</var> - convert an Eccentric Angle and an Angle-Length, into the coords for Start and End Radial-Points.</short>
<descr>
<p>
Use Angles2Coords to convert an Eccentric (Radial) angle and an angle-length, such as are used in X-Windows and GTK, into the coordinates for the Start and End Radial-Points. Like those used in the Arc, Pie, and Chord routines from the Windows API.
@ -158,7 +158,7 @@
<!-- function Visibility: default -->
<element name="Bezier">
<short>
<var>Bezier</var> - function to get a Bezier figure from the given points</short>
<var>Bezier</var> - function to get a Bezier figure from the given points.</short>
<descr/>
<errors/>
<seealso/>
@ -186,7 +186,7 @@
<!-- procedure Visibility: default -->
<element name="Bezier2Polyline">
<short>
<var>Bezier2Polyline</var> - convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable</short>
<var>Bezier2Polyline</var> - convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable.</short>
<descr>
<p>
Use BezierToPolyline to convert a 4-Point Bezier into a Pointer Array of TPoint and a Count variable which can then be used within either a Polyline, or Polygon routine. It is primarily for use within PolyBezier2Polyline.
@ -213,7 +213,7 @@
<!-- procedure Visibility: default -->
<element name="BezierArcPoints">
<short>
<var>BezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon</short>
<var>BezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon.</short>
<descr>
<p>
Use BezierArcPoints to convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon. The Rotation parameter accepts a Rotation-Angle for a rotated Ellipse'- for a non-rotated ellipse this value would be 0, or 360. The result is an Approximation based on 1 or more Beziers.
@ -289,7 +289,7 @@
<!-- function Visibility: default -->
<element name="CenterPoint">
<short>
<var>CenterPoint</var> - get the Center-Point of any rectangle. It is primarily for use with, and in, other routines such as Quadrant, and RadialPoint</short>
<var>CenterPoint</var> - get the Center-Point of any rectangle. It is primarily for use with, and in, other routines such as Quadrant, and RadialPoint.</short>
<descr/>
<errors/>
<seealso/>
@ -305,7 +305,7 @@
<!-- procedure Visibility: default -->
<element name="Coords2Angles">
<short>
<var>Coords2Angles</var> - convert the coords for Start and End Radial-Points into an Eccentric counter clockwise Angle and an Angle-Length</short>
<var>Coords2Angles</var> - convert the coords for Start and End Radial-Points into an Eccentric counter clockwise Angle and an Angle-Length.</short>
<descr>
<p>
Use Coords2Angles to convert the coords for Start and End Radial-Points, such as are used in the Windows API Arc Pie and Chord routines, into an Eccentric (aka Radial) counter clockwise Angle and an Angle-Length, such as are used in X-Windows and GTK.
@ -362,7 +362,7 @@
</element>
<!-- function Visibility: default -->
<element name="Distance">
<short>Get the <var>Distance</var> between any two Points. It is primarily for use in other routines such as EccentricAngle</short>
<short>Get the <var>Distance</var> between any two Points. It is primarily for use in other routines such as EccentricAngle.</short>
<descr/>
<errors/>
<seealso/>
@ -382,7 +382,7 @@
<!-- function Visibility: default -->
<element name="EccentricAngle">
<short>
<var>EccentricAngle</var> - get the Eccentric Angle of a given point on any non-rotated ellipse</short>
<var>EccentricAngle</var> - get the Eccentric Angle of a given point on any non-rotated ellipse.</short>
<descr>
<p>
Use EccentricAngle to get the Eccentric( aka Radial ) Angle of a given point on any non-rotated ellipse. It is primarily for use in Coords2Angles. The result is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
@ -406,7 +406,7 @@
<!-- function Visibility: default -->
<element name="EllipseRadialLength">
<short>
<var>EllipseRadialLength</var> - Radial-Length of non-rotated ellipse at any given Eccentric Angle</short>
<var>EllipseRadialLength</var> - Radial-Length of non-rotated ellipse at any given Eccentric Angle.</short>
<descr>
<p>
Use EllipseRadialLength to get the Radial-Length of non-rotated ellipse at any given Eccentric( aka Radial ) Angle. It is primarily for use in other routines such as RadialPoint. The Eccentric angle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
@ -450,7 +450,7 @@
<!-- function Visibility: default -->
<element name="LineEndPoint">
<short>
<var>LineEndPoint</var> - get the End-Point of a line of any given Length at any given angle with any given Start-Point</short>
<var>LineEndPoint</var> - get the End-Point of a line of any given Length at any given angle with any given Start-Point.</short>
<descr>
<p>
Use LineEndPoint to get the End-Point of a line of any given Length at any given angle with any given Start-Point. It is primarily for use in other routines such as RadialPoint. The angle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
@ -478,7 +478,7 @@
<!-- procedure Visibility: default -->
<element name="PolyBezier2Polyline">
<short>
<var>PolyBezier2Polyline</var> - convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable</short>
<var>PolyBezier2Polyline</var> - convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable.</short>
<descr>
<p>
Use BezierToPolyline to convert an array of 4-Point Bezier into a Pointer Array of TPoint and a Count variable which can then be used within either a Polyline, or Polygon routine. Points is automatically initialized, so any existing information is lost, and the array starts at 0. Points should ALWAYS be Freed when done by calling to ReallocMem(Points, 0).
@ -502,7 +502,7 @@
<!-- procedure Visibility: default -->
<element name="PolyBezierArcPoints">
<short>
<var>PolyBezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon</short>
<var>PolyBezierArcPoints</var> - convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon.</short>
<descr>
<p>
Use PolyBezierArcPoints to convert an Arc and ArcLength into a Pointer Array of TPoints for use with Polyline or Polygon. The Rotation parameter accepts a Rotation-Angle for a rotated Ellipse - for a non-rotated ellipse this value would be 0, or 360. The result is an Approximation based on 1 or more Beziers. If the AngleLength is greater than 45 degrees, it recursively breaks the Arc into Arcs of 45 degrees or less, and converts them into Beziers with BezierArcPoints.
@ -558,7 +558,7 @@
</element>
<!-- function Visibility: default -->
<element name="Quadrant">
<short>Determine the <var>Quadrant</var> of any point, given the Center</short>
<short>Determine the <var>Quadrant</var> of any point, given the Center.</short>
<descr>
<p>
Use Quadrant to determine the Quadrant of any point, given the Center. It is primarily for use in other routines such as EccentricAngle. A result of 1-4 represents the primary 4 quadrants. A result of 5-8 means the point lies on one of the Axis, 5 = -Y Axis, 6 = +X Axis, 7 = +Y Axis, and 8 = -X Axis. A result of -1 means that it does not fall in any quadrant, that is, it is the Center.
@ -581,7 +581,7 @@
</element>
<!-- function Visibility: default -->
<element name="RadialPoint">
<short>Get the <var>RadialPoint</var> at any given Eccentric angle on any non-rotated ellipse</short>
<short>Get the <var>RadialPoint</var> at any given Eccentric angle on any non-rotated ellipse.</short>
<descr>
<p>
Use RadialPoint to get the Radial-Point at any given Eccentric( aka Radial ) angle on any non-rotated ellipse. It is primarily for use in Angles2Coords. The EccentricAngle is in 1/16th of a degree. For example, a full circle equals 5760 (16*360). Zero degrees is at the 3 o'clock position.
@ -605,7 +605,7 @@
<!-- procedure Visibility: default -->
<element name="SplitBezier">
<short>
<var>SplitBezier</var> - split any 4-Point Bezier into two 4-Point Beziers: a 'Left' and a 'Right'</short>
<var>SplitBezier</var> - split any 4-Point Bezier into two 4-Point Beziers: a 'Left' and a 'Right'.</short>
<descr>
<p>
Use SplitBezier to split any 4-Point Bezier into two 4-Point Beziers:
@ -630,7 +630,7 @@
<topic name="GraphMathOperators">
<short>
<b>GraphMath Operators</b>
</short>
.</short>
<descr>
<p>This Unit contains a number of routines for calculating and converting series of graphic points from one coordinate system to another.</p>
<p>A fundamental type is introduced, called TFloatPoint. It is an extended precision record containing an X and a Y coordinate for a graphic point. Its structure is as follows:</p>

334
docs/xml/lcl/graphutil.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="GraphUtil">
<short>Contains routines and types used when drawing graphics</short>
<short>Contains routines and types used when drawing graphics.</short>
<descr>
<p>
<var>GraphUtil.pp</var> contains routines and types used when drawing graphics. They focus primarily on converting colors and drawing gradients, scroll bars, and arrows.
@ -35,424 +35,424 @@
<element name="GraphType"/>
<element name="ColorToGray">
<short>Converts a Lazarus TColor value to its grayscale equivalent</short>
<short>Converts a Lazarus TColor value to its grayscale equivalent.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="ColorToGray.Result">
<short>Byte contain the grayscale value for the specified color</short>
<short>Byte contain the grayscale value for the specified color.</short>
</element>
<element name="ColorToGray.AColor">
<short>TColor value converted in the method</short>
<short>TColor value converted in the method.</short>
</element>
<element name="ColorToHLS">
<short>Converts a TColor value to its Hue, Lightness, and Saturation values</short>
<short>Converts a TColor value to its Hue, Lightness, and Saturation values.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorToHLS.AColor">
<short>TColor value converted in the method</short>
<short>TColor value converted in the method.</short>
</element>
<element name="ColorToHLS.H">
<short>Hue value for the specified color</short>
<short>Hue value for the specified color.</short>
</element>
<element name="ColorToHLS.L">
<short>Lightness value for the specified color</short>
<short>Lightness value for the specified color.</short>
</element>
<element name="ColorToHLS.S">
<short>Saturation value for the specified color</short>
<short>Saturation value for the specified color.</short>
</element>
<element name="RGBtoHLS">
<short>Converts RGB color values to Hue, Lightness, and Saturation values</short>
<short>Converts RGB color values to Hue, Lightness, and Saturation values.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="RGBtoHLS.R">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHLS.G">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHLS.B">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHLS.H">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHLS.L">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHLS.S">
<short></short>
<short>.</short>
</element>
<element name="HLStoColor">
<short>Converts Hue, Lightness, and Saturation values to a TColor value</short>
<short>Converts Hue, Lightness, and Saturation values to a TColor value.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="HLStoColor.Result">
<short></short>
<short>.</short>
</element>
<element name="HLStoColor.H">
<short></short>
<short>.</short>
</element>
<element name="HLStoColor.L">
<short></short>
<short>.</short>
</element>
<element name="HLStoColor.S">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB">
<short>Converts Hue, Lightness, and Saturation values to a RGB color values</short>
<short>Converts Hue, Lightness, and Saturation values to a RGB color values.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="HLStoRGB.H">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB.L">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB.S">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB.R">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB.G">
<short></short>
<short>.</short>
</element>
<element name="HLStoRGB.B">
<short></short>
<short>.</short>
</element>
<!-- HSV functions are copied from mbColorLib without changes -->
<element name="ColorToHSV">
<short>Converts a TColor value to Hue, Saturation, and brightness Values</short>
<short>Converts a TColor value to Hue, Saturation, and brightness Values.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="ColorToHSV.c">
<short></short>
<short>.</short>
</element>
<element name="ColorToHSV.H">
<short></short>
<short>.</short>
</element>
<element name="ColorToHSV.S">
<short></short>
<short>.</short>
</element>
<element name="ColorToHSV.V">
<short></short>
<short>.</short>
</element>
<element name="HSVToColor">
<short>Converts Hue, Saturation, and brightness values to a TColor value</short>
<short>Converts Hue, Saturation, and brightness values to a TColor value.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVToColor.Result">
<short></short>
<short>.</short>
</element>
<element name="HSVToColor.H">
<short></short>
<short>.</short>
</element>
<element name="HSVToColor.S">
<short></short>
<short>.</short>
</element>
<element name="HSVToColor.V">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV">
<short>Comverts RGB values to Hue, Saturation, and brightness values</short>
<short>Comverts RGB values to Hue, Saturation, and brightness values.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="RGBToHSV.Result">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.R">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.G">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.B">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.H">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.S">
<short></short>
<short>.</short>
</element>
<element name="RGBToHSV.V">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB">
<short>Converts Hue, Saturation, and brightness values to RGB values</short>
<short>Converts Hue, Saturation, and brightness values to RGB values.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGB.H">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB.S">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB.V">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB.R">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB.G">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGB.B">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange">
<short></short>
<short>.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="RGBtoHSVRange.R">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.G">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.B">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.H">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.S">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.V">
<short></short>
<short>.</short>
</element>
<element name="RGBtoHSVRange.">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange">
<short></short>
<short>.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBRange.H">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange.S">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange.V">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange.R">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange.G">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBRange.B">
<short></short>
<short>.</short>
</element>
<element name="HSVRangeToColor">
<short></short>
<short>.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVRangeToColor.Result">
<short></short>
<short>.</short>
</element>
<element name="HSVRangeToColor.H">
<short></short>
<short>.</short>
</element>
<element name="HSVRangeToColor.S">
<short></short>
<short>.</short>
</element>
<element name="HSVRangeToColor.V">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBTriple">
<short>
Converts Hue, Saturation, and brightness values to a TRGBTriple value
</short>
.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBTriple.Result">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBTriple.H">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBTriple.S">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBTriple.V">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBQuad">
<short>
Converts Hue, Saturation, and brightness values to a TRGBQuad value
</short>
.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="HSVtoRGBQuad.Result">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBQuad.H">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBQuad.S">
<short></short>
<short>.</short>
</element>
<element name="HSVtoRGBQuad.V">
<short></short>
<short>.</short>
</element>
<element name="GetHValue">
<short>Gets the Hue value from the specified TColor value</short>
<short>Gets the Hue value from the specified TColor value.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetHValue.Result">
<short></short>
<short>.</short>
</element>
<element name="GetHValue.Color">
<short></short>
<short>.</short>
</element>
<element name="GetSValue">
<short>Gets the Saturation value from the specified TColor value</short>
<short>Gets the Saturation value from the specified TColor value.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetSValue.Result">
<short>Saturation value for the specified color</short>
<short>Saturation value for the specified color.</short>
</element>
<element name="GetSValue.Color">
<short>Color examined in the routine</short>
<short>Color examined in the routine.</short>
</element>
<element name="GetVValue">
<short>Gets the brightness value from the specified TColor value</short>
<short>Gets the brightness value from the specified TColor value.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="GetVValue.Result">
<short>Brightness value for the specified color</short>
<short>Brightness value for the specified color.</short>
</element>
<element name="GetVValue.Color">
<short>Color examined in the routine</short>
<short>Color examined in the routine.</short>
</element>
<element name="DrawVerticalGradient">
<short>Draws a gradient from top to bottom with parabolic color variation</short>
<short>Draws a gradient from top to bottom with parabolic color variation.</short>
<descr/>
<seealso/>
</element>
<element name="DrawVerticalGradient.Canvas">
<short>Canvas where the gradient is drawn</short>
<short>Canvas where the gradient is drawn.</short>
</element>
<element name="DrawVerticalGradient.ARect">
<short>Rectangle that defines the drawing boundaries for the gradient</short>
<short>Rectangle that defines the drawing boundaries for the gradient.</short>
</element>
<element name="DrawVerticalGradient.TopColor">
<short>Color used at the top of the gradient</short>
<short>Color used at the top of the gradient.</short>
</element>
<element name="DrawVerticalGradient.BottomColor">
<short>Color used at the end or bottom of the gradient</short>
<short>Color used at the end or bottom of the gradient.</short>
</element>
<element name="DrawGradientWindow">
<short>Draws a window with a Title using gradient coloring</short>
<short>Draws a window with a Title using gradient coloring.</short>
<descr/>
<seealso/>
</element>
<element name="DrawGradientWindow.Canvas">
<short>Canvas where the gradient is drawn</short>
<short>Canvas where the gradient is drawn.</short>
</element>
<element name="DrawGradientWindow.WindowRect">
<short>Rectangle for the window drawn using a gradient </short>
<short>Rectangle for the window drawn using a gradient .</short>
</element>
<element name="DrawGradientWindow.TitleHeight">
<short>Height of the the title bar in the window</short>
<short>Height of the the title bar in the window.</short>
</element>
<element name="DrawGradientWindow.BaseColor">
<short>Base color for the window</short>
<short>Base color for the window.</short>
</element>
<element name="AntiAliasedStretchDrawBitmap">
<short>Stretch-draws a bitmap using anti-aliased drawing</short>
<short>Stretch-draws a bitmap using anti-aliased drawing.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="AntiAliasedStretchDrawBitmap.SourceBitmap">
<short>Bitmap drawn in the routine</short>
<short>Bitmap drawn in the routine.</short>
</element>
<element name="AntiAliasedStretchDrawBitmap.DestBitmap">
<short>Bitmap where the new image is drawn</short>
<short>Bitmap where the new image is drawn.</short>
</element>
<element name="AntiAliasedStretchDrawBitmap.DestWidth">
<short>Width for the resized image</short>
<short>Width for the resized image.</short>
</element>
<element name="AntiAliasedStretchDrawBitmap.DestHeight">
<short>Height for the resized image</short>
<short>Height for the resized image.</short>
</element>
<element name="TScrollDirection">
<short>Enumerated type that indicates the direction for scrollbar arrows</short>
<short>Enumerated type that indicates the direction for scrollbar arrows.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TScrollDirection.sdLeft">
<short></short>
<short>.</short>
</element>
<element name="TScrollDirection.sdRight">
<short></short>
<short>.</short>
</element>
<element name="TScrollDirection.sdUp">
<short></short>
<short>.</short>
</element>
<element name="TScrollDirection.sdDown">
<short></short>
<short>.</short>
</element>
<element name="TArrowType">
<short>Indicates the drawing style for an arrow</short>
<short>Indicates the drawing style for an arrow.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TArrowType.atSolid">
<short>Arrow is drawn using a solid, filled color</short>
<short>Arrow is drawn using a solid, filled color.</short>
</element>
<element name="TArrowType.atArrows">
<short>Arrow is drawn using chevrons</short>
<short>Arrow is drawn using chevrons.</short>
</element>
<element name="NiceArrowAngle">
<short></short>
<short>.</short>
<descr>
45*pi/180
</descr>
@ -460,7 +460,7 @@
</element>
<element name="DrawArrow">
<short>Draws an arrow at the specified location on a canvas</short>
<short>Draws an arrow at the specified location on a canvas.</short>
<descr>
<p>
<var>DrawArrow</var> is an overloaded procedure used to draw an arrow on a canvas at the specified location. Overloaded variants of the routine allow the type of arrow, length, angle, and drawing style to be specified as arguments.
@ -469,35 +469,35 @@
<seealso></seealso>
</element>
<element name="DrawArrow.Canvas">
<short>Canvas where the arrow is drawn</short>
<short>Canvas where the arrow is drawn.</short>
</element>
<element name="DrawArrow.Direction">
<short>Direction for the arrow</short>
<short>Direction for the arrow.</short>
</element>
<element name="DrawArrow.Location">
<short>Point that indicates the canvas coordinates where the arrow is drawn</short>
<short>Point that indicates the canvas coordinates where the arrow is drawn.</short>
</element>
<element name="DrawArrow.Size">
<short></short>
<short>.</short>
</element>
<element name="DrawArrow.ArrowType">
<short>Drawing style for the arrow</short>
<short>Drawing style for the arrow.</short>
</element>
<element name="DrawArrow.p1">
<short></short>
<short>.</short>
</element>
<element name="DrawArrow.p2">
<short></short>
<short>.</short>
</element>
<element name="DrawArrow.ArrowLen">
<short></short>
<short>.</short>
</element>
<element name="DrawArrow.ArrowAngleRad">
<short></short>
<short>.</short>
</element>
<element name="FloodFill">
<short>A simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels</short>
<short>A simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels.</short>
<descr>
<p>
<var>FloodFill</var> is a procedure which implements a simple first-in-first-out circular buffer (queue) for flood-filling contiguous voxels. This algorithm avoids stack problems associated simple recursive algorithms described in the discussion at <url href="http://steve.hollasch.net/cgindex/polygons/floodfill.html"/>. Please note that the routine is slow because of its use of <var>Canvas.Pixels</var>.
@ -509,23 +509,23 @@
<seealso></seealso>
</element>
<element name="FloodFill.Canvas">
<short></short>
<short>.</short>
</element>
<element name="FloodFill.X">
<short></short>
<short>.</short>
</element>
<element name="FloodFill.Y">
<short></short>
<short>.</short>
</element>
<element name="FloodFill.lColor">
<short></short>
<short>.</short>
</element>
<element name="FloodFill.FillStyle">
<short></short>
<short>.</short>
</element>
<element name="ScaleImg">
<short>Scales the specified image to the required dimensons</short>
<short>Scales the specified image to the required dimensons.</short>
<descr>
<p>
<var>ScaleImg</var> is a procedure used to scale the image in <var>AImage</var> to the dimensions in <var>AWidth</var> and <var>AWidth</var>.
@ -537,133 +537,133 @@
<seealso></seealso>
</element>
<element name="ScaleImg.AImage">
<short>Bitmap image resize in the routine</short>
<short>Bitmap image resize in the routine.</short>
</element>
<element name="ScaleImg.AWidth">
<short>New Width requested for the image</short>
<short>New Width requested for the image.</short>
</element>
<element name="ScaleImg.AHeight">
<short>New height requested for the image</short>
<short>New height requested for the image.</short>
</element>
<element name="ColorRGBToHLS">
<short>
Converts an RGB color value to Hue, Lightness, and Saturation values
</short>
.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorRGBToHLS.clrRGB">
<short></short>
<short>.</short>
</element>
<element name="ColorRGBToHLS.Hue">
<short></short>
<short>.</short>
</element>
<element name="ColorRGBToHLS.Luminance">
<short></short>
<short>.</short>
</element>
<element name="ColorRGBToHLS.Saturation">
<short></short>
<short>.</short>
</element>
<element name="ColorHLSToRGB">
<short></short>
<short>.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="ColorHLSToRGB.Result">
<short></short>
<short>.</short>
</element>
<element name="ColorHLSToRGB.Hue">
<short></short>
<short>.</short>
</element>
<element name="ColorHLSToRGB.Luminance">
<short></short>
<short>.</short>
</element>
<element name="ColorHLSToRGB.Saturation">
<short></short>
<short>.</short>
</element>
<element name="ColorAdjustLuma">
<short></short>
<short>.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="ColorAdjustLuma.Result">
<short></short>
<short>.</short>
</element>
<element name="ColorAdjustLuma.clrRGB">
<short></short>
<short>.</short>
</element>
<element name="ColorAdjustLuma.n">
<short></short>
<short>.</short>
</element>
<element name="ColorAdjustLuma.fScale">
<short></short>
<short>.</short>
</element>
<element name="GetHighLightColor">
<short></short>
<short>.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetHighLightColor.Result">
<short></short>
<short>.</short>
</element>
<element name="GetHighLightColor.Color">
<short></short>
<short>.</short>
</element>
<element name="GetHighLightColor.Luminance">
<short></short>
<short>.</short>
</element>
<element name="GetShadowColor">
<short></short>
<short>.</short>
<descr></descr>
<errors/>
<seealso></seealso>
</element>
<element name="GetShadowColor.Result">
<short></short>
<short>.</short>
</element>
<element name="GetShadowColor.Color">
<short></short>
<short>.</short>
</element>
<element name="GetShadowColor.Luminance">
<short></short>
<short>.</short>
</element>
<element name="NormalizeRect">
<short>Ensures that coordinates in the rectangle are in the correct order</short>
<short>Ensures that coordinates in the rectangle are in the correct order.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="NormalizeRect.Result">
<short>Rectangle with the corrected values for its coordinates</short>
<short>Rectangle with the corrected values for its coordinates.</short>
</element>
<element name="NormalizeRect.R">
<short>Rectangle examined in the routine</short>
<short>Rectangle examined in the routine.</short>
</element>
<element name="WaveTo">
<short>Draws a hoizontal or vertical wave at the specified position to the given device context</short>
<short>Draws a hoizontal or vertical wave at the specified position to the given device context.</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="WaveTo.ADC">
<short>Device context that is the target for the drawing operation</short>
<short>Device context that is the target for the drawing operation.</short>
</element>
<element name="WaveTo.X">
<short>Horizontal position where the wave is drawn</short>
<short>Horizontal position where the wave is drawn.</short>
</element>
<element name="WaveTo.Y">
<short>Vertical position where the wave is drawn</short>
<short>Vertical position where the wave is drawn.</short>
</element>
<element name="WaveTo.R">
<short>Amplitude for changes in horizontal or vertical positions in the wave</short>
<short>Amplitude for changes in horizontal or vertical positions in the wave.</short>
</element>
</module>
<!-- GraphUtil -->

3720
docs/xml/lcl/grids.xml
View File

File diff suppressed because it is too large Load Diff