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

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

Browse Source 
git-svn-id: trunk@65268 -
This commit is contained in:
dsiders 2021-06-18 04:16:43 +00:00
parent 71fbf604ff
commit 9a1da96871
12 changed files with 1657 additions and 1660 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

254
docs/xml/lcl/shellctrls.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="ShellCtrls">
<short>Contains controls which display files and directories</short>
<short>Contains controls which display files and directories.</short>
<descr>
<p>
<file>shellctrls.pas</file> contains tree view and list view controls used to access files and directories on the local file system. The following components are added to the Lazarus IDE component palette:
@ -38,7 +38,7 @@
<element name="Masks"/>
<element name="TObjectType">
<short>Indicates which objects should be visible in a Shell control</short>
<short>Indicates which objects should be visible in a Shell control.</short>
<descr>
<p>
<var>TObjectType</var> is an enumerated type with values that indicate which file system objects are visible in a Shell control. Values from the enumeration are stored in the <var>TObjectTypes</var> set type.
@ -68,7 +68,7 @@
<element name="TObjectTypes">
<short>
Set type with values that indicate the visible objects in a Shell control
Set type with values that indicate the visible objects in a Shell control.
</short>
<descr></descr>
<seealso>
@ -79,7 +79,7 @@
</element>
<element name="TFileSortType">
<short>Represents sorting options for the items in a shell control</short>
<short>Represents sorting options for the items in a shell control.</short>
<descr>
<p>
<var>TFileSortType</var> is an enumerated type with values that control the sort order for the items in a shell control. TFileSortType is the type used to implement the <var>TCustomShellTreeView.FileSortType</var> property.
@ -91,20 +91,20 @@
</element>
<element name="TFileSortType.fstNone">
<short>
No special sorting is done; items will appear in the order provided by the file system
No special sorting is done; items will appear in the order provided by the file system.
</short>
</element>
<element name="TFileSortType.fstAlphabet">
<short>Items are sorted alphabetically with folders and files mixed</short>
<short>Items are sorted alphabetically with folders and files mixed.</short>
</element>
<element name="TFileSortType.fstFoldersFirst">
<short>
Items are sorted alphabetically with folders placed at the beginning of the list
Items are sorted alphabetically with folders placed at the beginning of the list.
</short>
</element>
<element name="TMaskCaseSensitivity">
<short>Represents case sensitivity options for file masks</short>
<short>Represents case sensitivity options for file masks.</short>
<descr>
<p>
<var>TMaskCaseSensitivity</var> is an enumeration type with values that represent case sensitivity options for the platform or OS where shell controls are implemented. TMaskCaseSensitivity is the type used for the <var>MaskCaseSensitivity</var> property in <var>TCustomShellListView</var>. It is also passed as an argument to methods in <var>TCustomShellTreeView</var>.
@ -115,18 +115,18 @@
</seealso>
</element>
<element name="TMaskCaseSensitivity.mcsPlatformDefault">
<short>File masks used the default for the platform or OS</short>
<short>File masks used the default for the platform or OS.</short>
</element>
<element name="TMaskCaseSensitivity.mcsCaseInsensitive">
<short>File masks are case insensitive</short>
<short>File masks are case insensitive.</short>
</element>
<element name="TMaskCaseSensitivity.mcsCaseSensitive">
<short>File masks are case sensitive</short>
<short>File masks are case sensitive.</short>
</element>
<element name="TAddItemEvent">
<short>
Specifies an event handler signalled when an item is added to a shell control
Specifies an event handler signalled when an item is added to a shell control.
</short>
<descr>
<p>
@ -142,21 +142,21 @@
</seealso>
</element>
<element name="TAddItemEvent.Sender">
<short>Object (control) generating the event notification</short>
<short>Object (control) generating the event notification.</short>
</element>
<element name="TAddItemEvent.ABasePath">
<short>Base path for the item added to the shell control</short>
<short>Base path for the item added to the shell control.</short>
</element>
<element name="TAddItemEvent.AFileInfo">
<short>Search record with information for the item added to the shell control</short>
<short>Search record with information for the item added to the shell control.</short>
</element>
<element name="TAddItemEvent.CanAdd">
<short>True if the item can be added</short>
<short>True if the item can be added.</short>
</element>
<element name="TCustomShellTreeView">
<short>
The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system
The base class for a tree view control used to display files, directories and other objects (such as devices) from the local file system.
</short>
<descr>
<p>
@ -181,62 +181,62 @@
<element name="TCustomShellTreeView.FOnAddItem"/>
<element name="TCustomShellTreeView.GetPath">
<short>Gets the value for the Path property</short>
<short>Gets the value for the Path property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellTreeView.Path"/>
</seealso>
</element>
<element name="TCustomShellTreeView.GetPath.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetFileSortType">
<short>Sets the value for the FileSortType property</short>
<short>Sets the value for the FileSortType property.</short>
<descr></descr>
<seealso>
<link id="TShellTreeView.FileSortType"/>
</seealso>
</element>
<element name="TCustomShellTreeView.SetFileSortType.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetObjectTypes">
<short>Sets the value for the ObjectTypes property</short>
<short>Sets the value for the ObjectTypes property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellTreeView.ObjectTypes"/>
</seealso>
</element>
<element name="TCustomShellTreeView.SetObjectTypes.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetPath">
<short>Sets the value for the Path property</short>
<short>Sets the value for the Path property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellTreeView.Path"/>
</seealso>
</element>
<element name="TCustomShellTreeView.SetPath.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetRoot">
<short>Sets the value for the Root property</short>
<short>Sets the value for the Root property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellTreeView.Root"/>
</seealso>
</element>
<element name="TCustomShellTreeView.SetRoot.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetShellListView">
<short>Sets the value for the ShellListView property</short>
<short>Sets the value for the ShellListView property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellTreeView.ShellListView"/>
@ -244,22 +244,22 @@
</seealso>
</element>
<element name="TCustomShellTreeView.SetShellListView.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.SetUseBuiltinIcons">
<short>Sets the value for the UseBuiltinIcons property</short>
<short>Sets the value for the UseBuiltinIcons property.</short>
<descr/>
<seealso>
<link id="TCustomShellTreeView.UseBuiltinIcons"/>
</seealso>
</element>
<element name="TCustomShellTreeView.SetUseBuiltinIcons.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellTreeView.DoCreateNodeClass">
<short>Performs actions needed to create a new tree node in the shell control</short>
<short>Performs actions needed to create a new tree node in the shell control.</short>
<descr>
<p>
<var>DoCreateNodeClass</var> is an overridden method used to perform actions needed to create a new tree node in the Items for the shell control. DoCreateNodeClass sets <var>NewNodeClass</var> to the <var>TShellTreeNode</var> class type used in <var>TCustomShellTreeView</var>. DoCreateNodeClass calls the inherited method using NewNodeClass as an argument.
@ -270,11 +270,11 @@
</seealso>
</element>
<element name="TCustomShellTreeView.DoCreateNodeClass.NewNodeClass">
<short>Class reference used to create tree nodes in the shell control</short>
<short>Class reference used to create tree nodes in the shell control.</short>
</element>
<element name="TCustomShellTreeView.Loaded">
<short>Performs actions needed when LCL component streaming has been completed</short>
<short>Performs actions needed when LCL component streaming has been completed.</short>
<descr>
<p>
<var>Loaded</var> is an overridden procedure used to perform actions needed when LCL component streaming has been completed. In <var>TCustomShellTreeView</var>, this includes calling the inherited method and setting the initial value for the root directory. If the initial root directory was assigned at design-time, <var>PopulateWithBaseFiles</var> is called to load files in the shell control.
@ -287,7 +287,7 @@
</element>
<element name="TCustomShellTreeView.CreateNode">
<short>Creates a new tree node for the shell control</short>
<short>Creates a new tree node for the shell control.</short>
<descr>
<p>
<var>CreateNode</var> is an overridden method used to create an new <var>TTreeNode</var> instance for the shell control. CreateNode calls the inherited method to create the class instance used as the return value for the method.
@ -307,12 +307,12 @@
</seealso>
</element>
<element name="TCustomShellTreeView.CreateNode.Result">
<short>New tree node created in the method</short>
<short>New tree node created in the method.</short>
</element>
<element name="TCustomShellTreeView.PopulateTreeNodeWithFiles">
<short>
Adds tree nodes for file system objects found starting at the specified node / path
Adds tree nodes for file system objects found starting at the specified node / path.
</short>
<descr>
<p>
@ -341,17 +341,17 @@
</seealso>
</element>
<element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.Result">
<short>Returns True if at least one item was added to the shell control</short>
<short>Returns True if at least one item was added to the shell control.</short>
</element>
<element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.ANode">
<short>Initial tree node used when filling the Items for the shell control</short>
<short>Initial tree node used when filling the Items for the shell control.</short>
</element>
<element name="TCustomShellTreeView.PopulateTreeNodeWithFiles.ANodePath">
<short>Path to the initial tree node used in the method</short>
<short>Path to the initial tree node used in the method.</short>
</element>
<element name="TCustomShellTreeView.DoSelectionChanged">
<short>Performs actions needed when a new item is selected in the shell control</short>
<short>Performs actions needed when a new item is selected in the shell control.</short>
<descr>
<p>
<var>DoSelectionChanged</var> is an overridden method used to perform actions needed when a new item is selected in the shell control. DoSelectionChanged calls the inherited DoSelectionChanged method, and ensures that a <var>TCustomShellListView</var> control assigned to <var>ShellListView</var> is synchronized to the current selection in the class.
@ -380,7 +380,7 @@
</element>
<element name="TCustomShellTreeView.DoAddItem">
<short>Performs actions needed to add a new tree node to the shell control</short>
<short>Performs actions needed to add a new tree node to the shell control.</short>
<descr>
<p>
<var>DoAddItem</var> is a procedure used to perform actions needed when a new tree node is added to the shell control. DoAddItem signals the <var>OnAddItem</var> event handler (when assigned) to examine and process the arguments passed to the method.
@ -403,18 +403,18 @@
</seealso>
</element>
<element name="TCustomShellTreeView.DoAddItem.ABasePath">
<short>Base path for the new tree node</short>
<short>Base path for the new tree node.</short>
</element>
<element name="TCustomShellTreeView.DoAddItem.AFileInfo">
<short>TSearchRec with information about the file system object</short>
<short>TSearchRec with information about the file system object.</short>
</element>
<element name="TCustomShellTreeView.DoAddItem.CanAdd">
<short>Indicates if the tree node can be added for the specified path</short>
<short>Indicates if the tree node can be added for the specified path.</short>
</element>
<element name="TCustomShellTreeView.CanExpand">
<short>
Determines if the specified tree node can be expanded in the shell control
Determines if the specified tree node can be expanded in the shell control.
</short>
<descr>
<p>
@ -436,14 +436,14 @@
</seealso>
</element>
<element name="TCustomShellTreeView.CanExpand.Result">
<short>True when the tree node contains child nodes and be expanded</short>
<short>True when the tree node contains child nodes and be expanded.</short>
</element>
<element name="TCustomShellTreeView.CanExpand.Node">
<short>Tree node examined in the method</short>
<short>Tree node examined in the method.</short>
</element>
<element name="TCustomShellTreeView.DrawBuiltInIcon">
<short>Draws the Shell Icon for the specified tree node</short>
<short>Draws the Shell Icon for the specified tree node.</short>
<descr>
<p>
<var>DrawBuiltInIcon</var> is an overridden <var>TSize</var> function used draw an icon in the tree using the Shell icon for the file name in <var>ANode</var>. It re-implements the method in the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
@ -465,17 +465,17 @@
</seealso>
</element>
<element name="TCustomShellTreeView.DrawBuiltInIcon.Result">
<short>TSize instance with the dimension for the icon</short>
<short>TSize instance with the dimension for the icon.</short>
</element>
<element name="TCustomShellTreeView.DrawBuiltInIcon.ANode">
<short>Tree node with the name for the file system entry</short>
<short>Tree node with the name for the file system entry.</short>
</element>
<element name="TCustomShellTreeView.DrawBuiltInIcon.ARect">
<short>Rectangle where the icon is drawn</short>
<short>Rectangle where the icon is drawn.</short>
</element>
<element name="TCustomShellTreeView.GetBuiltinIconSize">
<short>Gets the size for a shell icon used in the control</short>
<short>Gets the size for a shell icon used in the control.</short>
<descr>
<p>
<var>GetBuiltinIconSize</var> is an overridden <var>TSize</var> function used to get the dimensions for a shell icon displayed for a file system entry in the control. GetBuiltinIconSize re-implements the method from the <var>TCustomTreeView</var> ancestor, and does <b>not</b> call the inherited method.
@ -499,11 +499,11 @@
</seealso>
</element>
<element name="TCustomShellTreeView.GetBuiltinIconSize.Result">
<short>TSize instance with the dimensions for the shell icon</short>
<short>TSize instance with the dimensions for the shell icon.</short>
</element>
<element name="TCustomShellTreeView.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance. Create calls the inherited method using the value in <var>AOwner</var> as the owner for the class instance. Create initializes an internal member used to monitor the <var>Root</var> property for changes to its value. Create sets the value in <var>ObjectTypes</var> to display folders.
@ -521,11 +521,11 @@
</seealso>
</element>
<element name="TCustomShellTreeView.Create.AOwner">
<short>Component that owns the class instance</short>
<short>Component that owns the class instance.</short>
</element>
<element name="TCustomShellTreeView.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
<var>Destroy</var> is the destructor for the class instance. Destroy ensures that the <var>ShellListView</var> is set to <b>Nil</b> prior to calling the inherited destructor.
@ -538,7 +538,7 @@
<element name="TCustomShellTreeView.GetBasePath">
<short>
Returns the initial path in the file system hierarchy for the platform
Returns the initial path in the file system hierarchy for the platform.
</short>
<descr>
<p>
@ -563,7 +563,7 @@
<element name="TCustomShellTreeView.GetRootPath">
<short>
Returns the effective root value, returning the value of GetBasePath() of Root is empty or the Root property value otherwise
Returns the effective root value, returning the value of GetBasePath() of Root is empty or the Root property value otherwise.
</short>
<descr/>
<errors>
@ -574,14 +574,14 @@
<element name="TCustomShellTreeView.GetPathFromNode">
<short>
Returns the path (including the file name) from the file system that a particular node represents
</short>
Returns the path (including the file name) from the file system that a particular node represents.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomShellTreeView.PopulateWithBaseFiles">
<short>Fills the tree view when the Root directory is empty</short>
<short>Fills the tree view when the Root directory is empty.</short>
<descr>
<remark>
The implementation of PopulateWithBaseFiles is platform-specific.
@ -604,7 +604,7 @@
<element name="TCustomShellTreeView.Refresh">
<short>
Updates the tree view to display file system objects starting at the specified tree node
Updates the tree view to display file system objects starting at the specified tree node.
</short>
<descr>
Used in the implementation of the SetObjectTypes method.
@ -616,12 +616,12 @@
</element>
<element name="TCustomShellTreeView.Refresh.ANode">
<short>
Tree node with the initial path displayed in the shell control; Nil defaults to the root directory
Tree node with the initial path displayed in the shell control; Nil defaults to the root directory.
</short>
</element>
<element name="TCustomShellTreeView.UseBuiltinIcons">
<short>Indicates if OS-provided icons are used for entries in the Shell control</short>
<short>Indicates if OS-provided icons are used for entries in the Shell control.</short>
<descr>
<p>
<var>UseBuiltinIcons</var> is a <var>Boolean</var> property which indicates if OS-provided icons are used for the file system entries in the Shell control.
@ -640,7 +640,7 @@
<element name="TCustomShellTreeView.ObjectTypes">
<short>
Indicates which objects should be shown in this control (for example if it should show files and directories or only directories)
Indicates which objects should be shown in this control (for example if it should show files and directories or only directories).
</short>
<descr>
</descr>
@ -652,7 +652,7 @@
<element name="TCustomShellTreeView.ShellListView">
<short>
Connects this ShellTreeView to a ShellListView
Connects this ShellTreeView to a ShellListView.
</short>
<descr>
<p>
@ -673,7 +673,7 @@
</element>
<element name="TCustomShellTreeView.FileSortType">
<short>Indicates how the items should be sorted in the tree</short>
<short>Indicates how the items should be sorted in the tree.</short>
<descr>
<p>
<var>FileSortType</var> is a <var>TFileSortType</var> property used to indicate the sort order for tree nodes in the <var>Items</var> property. See <var>TFileSortType</var> for information about enumeration values and their meanings.
@ -704,7 +704,7 @@
<element name="TCustomShellTreeView.Root">
<short>
Indicates the directory to start showing the list of items
Indicates the directory to start showing the list of items.
</short>
<descr>
<p>
@ -737,7 +737,7 @@
</element>
<element name="TCustomShellTreeView.Path">
<short>Path to the directory displayed in the shell control</short>
<short>Path to the directory displayed in the shell control.</short>
<descr>
<p>
<var>Path</var> is a <var>String</var> property which represents the path on the local file system to the Selected tree node in the control.
@ -762,7 +762,7 @@
<element name="TCustomShellTreeView.OnAddItem">
<short>
Event handler signalled when an item (tree node) is added to the shell control
Event handler signalled when an item (tree node) is added to the shell control.
</short>
<descr>
<p>
@ -778,7 +778,7 @@
<element name="TShellTreeView">
<short>
Implements a tree view control to display the files, directories and other objects (such as devices) from the local file system
Implements a tree view control to display the files, directories and other objects (such as devices) from the local file system.
</short>
<descr>
<p>
@ -876,7 +876,7 @@
<element name="TCSLVFileAddedEvent">
<short>
Specifies an event handler signalled when an item is added to TCustomShellListView
Specifies an event handler signalled when an item is added to TCustomShellListView.
</short>
<descr>
<p>
@ -892,15 +892,15 @@
</seealso>
</element>
<element name="TCSLVFileAddedEvent.Sender">
<short>Object (control) generating the event notification</short>
<short>Object (control) generating the event notification.</short>
</element>
<element name="TCSLVFileAddedEvent.Item">
<short>List item for the event notification</short>
<short>List item for the event notification.</short>
</element>
<element name="TCustomShellListView">
<short>
The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system
The base class that defines a list view control to display the files, directories and other objects (such as devices) from the local file system.
</short>
<descr>
<p>
@ -945,40 +945,40 @@
<element name="TCustomShellListView.FOnFileAdded"/>
<element name="TCustomShellListView.SetMask">
<short>Sets the value for the Mask property</short>
<short>Sets the value for the Mask property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellListView.Mask"/>
</seealso>
</element>
<element name="TCustomShellListView.SetMask.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellListView.SetMaskCaseSensitivity">
<short>Sets the value for the MaskCaseSensitivity property</short>
<short>Sets the value for the MaskCaseSensitivity property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellListView.MaskCaseSensitivity"/>
</seealso>
</element>
<element name="TCustomShellListView.SetMaskCaseSensitivity.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellListView.SetShellTreeView">
<short>Sets the value for the ShellTreeView property</short>
<short>Sets the value for the ShellTreeView property.</short>
<descr></descr>
<seealso>
<link id="TCustomShellListView.ShellTreeView"/>
</seealso>
</element>
<element name="TCustomShellListView.SetShellTreeView.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellListView.SetRoot">
<short>Sets the value for the Root property</short>
<short>Sets the value for the Root property.</short>
<descr>
<p>
Calls <var>Clear</var> to remove list items in the control. Calls <var>PopulateWithRoot</var> to load file system entries in the new root directory. Raises an <var>EInvalidPath</var> exception at run-time if Value contains an invalid path name. Does <b>not</b> raise an exception at design-time to prevent crashing the IDE.
@ -992,7 +992,7 @@
</seealso>
</element>
<element name="TCustomShellListView.SetRoot.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomShellListView.WSRegisterClass" link="#lcl.controls.TWinControl.WSRegisterClass">
@ -1014,7 +1014,7 @@
</element>
<element name="TCustomShellListView.PopulateWithRoot">
<short>Fills the list view with file system information for the root directory</short>
<short>Fills the list view with file system information for the root directory.</short>
<descr>
<p>
<var>PopulateWithRoot</var> is a procedure used to fill the <var>Items</var> in the list view with file system entries for the <var>Root</var> directory.
@ -1054,7 +1054,7 @@
</element>
<element name="TCustomShellListView.Resize">
<short>Sets the size for Columns in the list view</short>
<short>Sets the size for Columns in the list view.</short>
<descr>
<p>
<var>Resize</var> is a method used to set the size for <var>Columns</var> in the list view control. <var>Resize</var> calls the inherited method, and checks the <var>Columns</var> defined for the control. The <var>Width</var> property is used to determine the layout sizes applied to the columns for the control.
@ -1078,27 +1078,27 @@
<element name="TCustomShellListView.DoAddItem">
<short>
Signals the OnAddItem event handler when an entry is added to the Items in the control
Signals the OnAddItem event handler when an entry is added to the Items in the control.
</short>
<descr></descr>
<seealso></seealso>
</element>
<element name="TCustomShellListView.DoAddItem.ABasePath">
<short>Base path for the list view</short>
<short>Base path for the list view.</short>
</element>
<element name="TCustomShellListView.DoAddItem.AFileInfo">
<short>TSearchRec with the information for the new entry</short>
<short>TSearchRec with the information for the new entry.</short>
</element>
<element name="TCustomShellListView.DoAddItem.CanAdd">
<short>
Set the argument to True to allow the item to be added; set to False to prevent adding the item
Set the argument to True to allow the item to be added; set to False to prevent adding the item.
</short>
</element>
<element name="TCustomShellListView.GetBuiltinImageIndex">
<short>
Gets the index position for the built-in icon used for the specified path or file name
</short>
Gets the index position for the built-in icon used for the specified path or file name.
</short>
<descr>
<p>
<var>GetBuiltinImageIndex</var> is an <var>Integer</var> function used to get the image index for a built-in icon provided by the operating system or platform.
@ -1127,18 +1127,18 @@
</seealso>
</element>
<element name="TCustomShellListView.GetBuiltinImageIndex.Result">
<short>Ordinal position for the built-in image</short>
<short>Ordinal position for the built-in image.</short>
</element>
<element name="TCustomShellListView.GetBuiltinImageIndex.AFileName">
<short>File name or path used to find the associated image</short>
<short>File name or path used to find the associated image.</short>
</element>
<element name="TCustomShellListView.GetBuiltinImageIndex.ALargeImage">
<short>True if the large image list is used for the image</short>
<short>True if the large image list is used for the image.</short>
</element>
<element name="TCustomShellListView.OnFileAdded">
<short>
Event handler signalled when a file is added to the Items in the control
Event handler signalled when a file is added to the Items in the control.
</short>
<descr>
<p>
@ -1158,7 +1158,7 @@
</element>
<element name="TCustomShellListView.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. <var>Create</var> calls the inherited method using <var>AOwner</var> as the owner of the class instance. <var>Create</var> sets the default values for properties in the class instance, including:
@ -1187,11 +1187,11 @@
</seealso>
</element>
<element name="TCustomShellListView.Create.AOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TCustomShellListView.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. <var>Destroy</var> ensures that a control assigned to the <var>ShellTreeView</var> property is set to <b>Nil</b>. <var>Destroy</var> calls the inherited method.
@ -1203,7 +1203,7 @@
</element>
<element name="TCustomShellListView.GetPathFromItem">
<short>Gets the path on the local file system for the specified item</short>
<short>Gets the path on the local file system for the specified item.</short>
<descr>
<p>
<var>GetPathFromItem</var> is a <var>String</var> function used to get the path on the local file system for the list item specified in <var>ANode</var>. The return value contains the content from the <var>Root</var> property with a trailing path delimiter, joined with the <var>Caption</var> for the <var>TListItem</var> in <var>ANode</var>.
@ -1215,14 +1215,14 @@
</seealso>
</element>
<element name="TCustomShellListView.GetPathFromItem.Result">
<short>Complete path to the item</short>
<short>Complete path to the item.</short>
</element>
<element name="TCustomShellListView.GetPathFromItem.ANode">
<short>List item examined in the method</short>
<short>List item examined in the method.</short>
</element>
<element name="TCustomShellListView.Mask">
<short>File mask used to select items displayed in the shell control</short>
<short>File mask used to select items displayed in the shell control.</short>
<descr>
<p>
<var>Mask</var> is a <var>String</var> property used to supply a mask which determines the file system objects displayed in the shell control. Mask can contain one or more mask values delimited by the Semicolon (<b>';'</b>) character. For example:
@ -1247,7 +1247,7 @@
</element>
<element name="TCustomShellListView.MaskCaseSensitivity">
<short>Case Sensitivity option enabled for file masks in the shell control</short>
<short>Case Sensitivity option enabled for file masks in the shell control.</short>
<descr>
<p>
<var>MaskCaseSensitivity</var> is a <var>TMaskCaseSensitivity</var> property which represents the case sensitivity option used for file masks in the shell control. The default value for the property is <var>mcsPlatformDefault</var>. See <var>TMaskCaseSensitivity</var> for a description of the enumeration values and their meanings.
@ -1264,7 +1264,7 @@
<element name="TCustomShellListView.ObjectTypes">
<short>
Indicates which objects are visible in the control (files and/or directories, hidden files, etc.)
Indicates which objects are visible in the control (files and/or directories, hidden files, etc.).
</short>
<descr>
</descr>
@ -1276,8 +1276,8 @@
<element name="TCustomShellListView.Root">
<short>
Indicates the initial directory path whose objects are displayed in the control
</short>
Indicates the initial directory path whose objects are displayed in the control.
</short>
<descr>
<p>
The most important property of the ShellListView, indicates the directory whose contents will be shown. This property is automatically managed if the property ShellTreeView is filled. If this property is empty, nothing will be shown.
@ -1289,7 +1289,7 @@
<element name="TCustomShellListView.ShellTreeView">
<short>
Used to connect the ShellListView to a ShellTreeView
Used to connect the ShellListView to a ShellTreeView.
</short>
<descr>
<p>
@ -1312,7 +1312,7 @@
<element name="TCustomShellListView.UseBuiltInIcons">
<short>
Indicates if icons provided by the OS or platform are used for items in the list
Indicates if icons provided by the OS or platform are used for items in the list.
</short>
<descr>
<p>
@ -1365,7 +1365,7 @@
<element name="TShellListView">
<short>
Implements a list view control to display the files, directories and other objects (such as devices) on the local file system
Implements a list view control to display the files, directories and other objects (such as devices) on the local file system.
</short>
<descr>
<p>
@ -1470,7 +1470,7 @@
<element name="TShellListView.ShellTreeView" link="#lcl.shellctrls.TCustomShellListView.ShellTreeView"/>
<element name="TShellTreeNode">
<short>Represents tree nodes in TShellTreeView</short>
<short>Represents tree nodes in TShellTreeView.</short>
<descr>
<p>
<var>TShellTreeNode</var> is a <var>TTreeNode</var> descendant which represents tree nodes in <var>TShellTreeView</var>. TShellTreeNode extends the ancestor class with properties and methods needed to work with files or directories on the local file system. TShellTreeNode is the class type reference used to create new nodes in the <var>TCustomShellTreeView.CreateNode</var> method.
@ -1485,18 +1485,18 @@
<element name="TShellTreeNode.FBasePath"/>
<element name="TShellTreeNode.SetBasePath">
<short>Sets the value in the BasePath property</short>
<short>Sets the value in the BasePath property.</short>
<descr></descr>
<seealso>
<link id="TShellTreeNode.BasePath"/>
</seealso>
</element>
<element name="TShellTreeNode.SetBasePath.ABasePath">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TShellTreeNode.ShortFilename">
<short>Gets the short file name for the item represented in the tree node</short>
<short>Gets the short file name for the item represented in the tree node.</short>
<descr>
<p>
<var>ShortFilename</var> is a <var>String</var> function used to get the short file name for the item represented in the tree node. ShortFilename tries to get the file name from an internal <var>TSearchRec</var> for the tree node. If the file name is an empty string (<b>''</b>), the name in the search record is used as the return value. ShortFilename <b>does not</b> include path information in the return value.
@ -1510,12 +1510,12 @@
</seealso>
</element>
<element name="TShellTreeNode.ShortFilename.Result">
<short>Short file name for the item represented in the tree node</short>
<short>Short file name for the item represented in the tree node.</short>
</element>
<element name="TShellTreeNode.FullFilename">
<short>
Gets the full file name including path for the item represented in the tree node
Gets the full file name including path for the item represented in the tree node.
</short>
<descr>
<p>
@ -1532,11 +1532,11 @@
</seealso>
</element>
<element name="TShellTreeNode.FullFilename.Result">
<short>The full path and name for the file system object</short>
<short>The full path and name for the file system object.</short>
</element>
<element name="TShellTreeNode.IsDirectory">
<short>Indicates if the tree node is a directory on the local file system</short>
<short>Indicates if the tree node is a directory on the local file system.</short>
<descr>
<p>
<var>IsDirectory</var> is a <var>Boolean</var> function which indicates if the file system object for the the tree node is a directory on the local file system. The return value is <b>True</b> when the file attributes in the <var>TSearchRec</var> for the tree node includes the <var>faDirectory</var> attribute.
@ -1554,11 +1554,11 @@
</seealso>
</element>
<element name="TShellTreeNode.IsDirectory.Result">
<short>True when the tree node represents a directory on the local file system</short>
<short>True when the tree node represents a directory on the local file system.</short>
</element>
<element name="TShellTreeNode.BasePath">
<short>Contains the path to the file system object in the tree node</short>
<short>Contains the path to the file system object in the tree node.</short>
<descr>
<p>
<var>BasePath</var> is a read-only <var>String</var> property which contains the path on the local file system to the object in the tree node. The value for the property is set when the tree node is created in TShellTreeView methods using the SetBasePath method in the class instance.
@ -1573,7 +1573,7 @@
</element>
<element name="EShellCtrl">
<short>Exception raised for errors occuring in shell controls</short>
<short>Exception raised for errors occuring in shell controls.</short>
<descr>
<var>EShellCtrl</var> is a <var>Exception</var> descendant raised when errors occur in shell controls.
</descr>
@ -1585,7 +1585,7 @@
</element>
<element name="EInvalidPath">
<short>Exception raised for an invalid path in shell controls</short>
<short>Exception raised for an invalid path in shell controls.</short>
<descr>
<var>EInvalidPath</var> is a <var>EShellCtrl</var> descendant raised for an invalid path in shell controls.
</descr>
@ -1601,7 +1601,7 @@
<element name="DbgS">
<short>
Provides strings values with details about classes used in shell controls for the debugger
Provides strings values with details about classes used in shell controls for the debugger.
</short>
<descr>
<p>
@ -1626,17 +1626,17 @@
</seealso>
</element>
<element name="DbgS.Result">
<short>Formatted values for the debugger</short>
<short>Formatted values for the debugger.</short>
</element>
<element name="DbgS.OT">
<short>TObjectTypes examined in the routine</short>
<short>TObjectTypes examined in the routine.</short>
</element>
<element name="DbgS.CS">
<short>TMaskCaseSensitivity examined in the routine</short>
<short>TMaskCaseSensitivity examined in the routine.</short>
</element>
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are added to the Lazarus IDE component palette:

176
docs/xml/lcl/spin.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="Spin">
<short>This unit contains classes for spin edit controls</short>
<short>This unit contains classes for spin edit controls.</short>
<descr>
<p>
<file>spin.pp</file> contains classes which implement spin edit controls. This file is part of the Lazarus Component Library (<b>LCL</b>).
@ -38,7 +38,7 @@
<element name="Math"/>
<element name="TCustomFloatSpinEdit">
<short>The base class for the float-based spin control</short>
<short>The base class for the float-based spin control.</short>
<descr>
<p>
<var>TCustomFloatSpinEdit</var> is a <var>TCustomEdit</var> descendant which implements the base class for the float-based spin edit control. It provides an edit control where the Float value can be entered directly, and up / down buttons which can be used to increment or decrement the value for the control.
@ -55,77 +55,77 @@
</element>
<element name="TCustomFloatSpinEdit.DefIncrement">
<short>Default increment for the control</short>
<short>Default increment for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.DefDecimals">
<short>Default decimal places displayed for the control</short>
<short>Default decimal places displayed for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.DefMaxValue">
<short>Default value for the MaxValue property</short>
<short>Default value for the MaxValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.FIncrement">
<short>Stores the increment for the control</short>
<short>Stores the increment for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FDecimals">
<short>Stores the decimal places displayed for the control</short>
<short>Stores the decimal places displayed for the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FEditorEnabled">
<short>Stores the value for the EditorEnabled property</short>
<short>Stores the value for the EditorEnabled property.</short>
</element>
<element name="TCustomFloatSpinEdit.FMaxValue">
<short>Stores the value for the MaxValue property</short>
<short>Stores the value for the MaxValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.FMinValue">
<short>Stores the value for the MinValue property</short>
<short>Stores the value for the MinValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.FValue">
<short>Stores the value for the Value property</short>
<short>Stores the value for the Value property.</short>
</element>
<element name="TCustomFloatSpinEdit.FValueEmpty">
<short>Stores the value for the ValueEmpty property</short>
<short>Stores the value for the ValueEmpty property.</short>
</element>
<element name="TCustomFloatSpinEdit.FUpdatePending">
<short>Internal flag used in the control</short>
<short>Internal flag used in the control.</short>
</element>
<element name="TCustomFloatSpinEdit.FValueChanged">
<short>Internal flag used in the control</short>
<short>Internal flag used in the control.</short>
</element>
<element name="TCustomFloatSpinEdit.GetValue">
<short>Gets the value for the Value property</short>
<short>Gets the value for the Value property.</short>
</element>
<element name="TCustomFloatSpinEdit.GetValue.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetEditorEnabled">
<short>Sets the value for the EditorEnabled property</short>
<short>Sets the value for the EditorEnabled property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.EditorEnabled"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetEditorEnabled.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.UpdateControl">
<short>Normalizes the Value for the control and notifies the widgetset class</short>
<short>Normalizes the Value for the control and notifies the widgetset class.</short>
</element>
<element name="TCustomFloatSpinEdit.MaxValueStored">
<short>Implements the storage specifier for the MaxValue property</short>
<short>Implements the storage specifier for the MaxValue property.</short>
</element>
<element name="TCustomFloatSpinEdit.MaxValueStored.Result">
<short>True if an explicit value has been assigned to MaxValue</short>
<short>True if an explicit value has been assigned to MaxValue.</short>
</element>
<element name="TCustomFloatSpinEdit.IncrementStored">
<short>Implements the storage specifier for the Increment property</short>
<short>Implements the storage specifier for the Increment property.</short>
</element>
<element name="TCustomFloatSpinEdit.IncrementStored.Result">
<short>True if an explicit value has been assigned to Increment</short>
<short>True if an explicit value has been assigned to Increment.</short>
</element>
<element name="TCustomFloatSpinEdit.WSRegisterClass" link="#lcl.lclclasses.TLCLComponent.WSRegisterClass"/>
@ -171,62 +171,62 @@
</element>
<element name="TCustomFloatSpinEdit.SetValue">
<short>Sets the value for the Value property</short>
<short>Sets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetMaxValue">
<short>Sets the value for the MaxValue property</short>
<short>Sets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetMaxValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetMinValue">
<short>Sets the value for the MinValue property</short>
<short>Sets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetMinValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetValueEmpty">
<short>Sets the value for the ValueEmpty property</short>
<short>Sets the value for the ValueEmpty property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.ValueEmpty"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetValueEmpty.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.SetIncrement">
<short>Sets the value for the Increment property</short>
<short>Sets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomFloatSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomFloatSpinEdit.SetIncrement.AIncrement">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomFloatSpinEdit.InitializeWnd">
<short>Creates or re-creates the handle for the windowed control</short>
<short>Creates or re-creates the handle for the windowed control.</short>
<descr/>
<seealso>
<link id="#lcl.stdctrls.TCustomEdit.InitializeWnd">TCustomEdit.InitializeWnd</link>
@ -234,7 +234,7 @@
</element>
<element name="TCustomFloatSpinEdit.FinalizeWnd">
<short>Frees the handle for the windowed control</short>
<short>Frees the handle for the windowed control.</short>
<descr/>
<seealso>
<link id="#lcl.controls.TWinControl.FinalizeWnd">TWinControl.FinalizeWnd</link>
@ -242,7 +242,7 @@
</element>
<element name="TCustomFloatSpinEdit.Loaded">
<short>Performs actions when LCL component streaming is completed</short>
<short>Performs actions when LCL component streaming is completed.</short>
<descr>
<p>
<var>Loaded</var> calls the inherited method on entry to determine the size for the control (and its children) and to apply property values inherited from the parent control (when assigned). Loaded calls <var>UpdateControl</var> when the internal update flag has been set for the control.
@ -254,7 +254,7 @@
</element>
<element name="TCustomFloatSpinEdit.KeyPress">
<short>Handles key press events for the control</short>
<short>Handles key press events for the control.</short>
<descr>
<p>
<var>KeyPress</var> is an overridden method used to handle key press events for the control. KeyPress calls the inherited method on entry. If the character in <var>Key</var> is not handled in the ancestor class, the argument is examined to determine if it is valid for the control. If Key is not a valid character, it is set to <b>#0</b> to ignore the key press event.
@ -272,20 +272,20 @@
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.KeyPress.Key">
<short>Character value for the key press event</short>
<short>Character value for the key press event.</short>
</element>
<element name="TCustomFloatSpinEdit.GetControlClassDefaultSize">
<short>Gets the default size for new instances of the class</short>
<short>Gets the default size for new instances of the class.</short>
<descr/>
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.GetControlClassDefaultSize.Result">
<short>Default size for the new class instance</short>
<short>Default size for the new class instance.</short>
</element>
<element name="TCustomFloatSpinEdit.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 style flags needed for the spin edit control, and sets the default values for properties in the class instance. The <var>GetControlClassDefaultSize</var> method is called and the return value is used to set the initial size for the control.
@ -294,12 +294,12 @@
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue">
<short>
Limits the specified value to the minimum and maximum values for the control
Limits the specified value to the minimum and maximum values for the control.
</short>
<descr>
<p>
@ -315,15 +315,15 @@
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue.Result">
<short>Value for the control limited to the range in MinValue and MaxValue</short>
<short>Value for the control limited to the range in MinValue and MaxValue.</short>
</element>
<element name="TCustomFloatSpinEdit.GetLimitedValue.AValue">
<short>Value examined in the method</short>
<short>Value examined in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr">
<short>
Converts the specified value to a String type using the spin edit settings
Converts the specified value to a String type using the spin edit settings.
</short>
<descr>
<p>
@ -333,15 +333,15 @@
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr.Result">
<short>String representation for the float value</short>
<short>String representation for the float value.</short>
</element>
<element name="TCustomFloatSpinEdit.ValueToStr.AValue">
<short>Float value converted to a string in the method</short>
<short>Float value converted to a string in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.StrToValue">
<short>
Converts the specified string to a float value according to spin edit settings
Converts the specified string to a float value according to spin edit settings.
</short>
<descr>
<p>
@ -351,14 +351,14 @@
<seealso/>
</element>
<element name="TCustomFloatSpinEdit.StrToValue.Result">
<short>Float value for the specified string</short>
<short>Float value for the specified string.</short>
</element>
<element name="TCustomFloatSpinEdit.StrToValue.S">
<short>String examined and converted to a float value in the method</short>
<short>String examined and converted to a float value in the method.</short>
</element>
<element name="TCustomFloatSpinEdit.DecimalPlaces">
<short>Number of the decimal places displayed in the spin edit control</short>
<short>Number of the decimal places displayed in the spin edit control.</short>
<descr>
<p>
<var>DecimalPlaces</var> is used in the <var>ValueToStr</var> method, and determines the decimal precision for the value displayed in the spin edit control.
@ -369,7 +369,7 @@
<element name="TCustomFloatSpinEdit.EditorEnabled">
<short>
Indicates whether the value for the control can be entered directly into its edit box
Indicates whether the value for the control can be entered directly into its edit box.
</short>
<descr>
<p>
@ -393,7 +393,7 @@
<element name="TCustomFloatSpinEdit.Increment">
<short>
Amount applied to the control value when the up or down arrow button is pushed
Amount applied to the control value when the up or down arrow button is pushed.
</short>
<descr>
<p>
@ -404,7 +404,7 @@
</element>
<element name="TCustomFloatSpinEdit.MinValue">
<short>Minimal value allowed for the spin edit control</short>
<short>Minimal value allowed for the spin edit control.</short>
<descr>
<p>
Minimal value allowed for the spin edit control. Set the MinValue property equal to MaxValue to allow any number to be selected.
@ -418,7 +418,7 @@
</element>
<element name="TCustomFloatSpinEdit.MaxValue">
<short>Maximal value allowed for the spin edit control</short>
<short>Maximal value allowed for the spin edit control.</short>
<descr>
<p>
Maximal value allowed for the spin edit control. Set the MinValue property equal to MaxValue to allow any number to be selected.
@ -432,7 +432,7 @@
</element>
<element name="TCustomFloatSpinEdit.Value">
<short>The value for the spin edit control</short>
<short>The value for the spin edit control.</short>
<descr>
<p>
<var>Value</var> is a <var>Double</var> property which contains the value for the spin edit control. Value is synchronized to the value in the widgetset class when its <var>Handle</var> has been assigned. Otherwise, the value in the member variable is used for the property value.
@ -452,7 +452,7 @@
</element>
<element name="TCustomFloatSpinEdit.ValueEmpty">
<short>Indicates if a value has not been assigned for the control</short>
<short>Indicates if a value has not been assigned for the control.</short>
<descr>
<var>ValueEmpty</var> is updated in the <var>TextChanged</var> method when a new value has been assigned to the control. Changing the value for the property causes the <var>UpdateControl</var> method to be called.
</descr>
@ -460,7 +460,7 @@
</element>
<element name="TFloatSpinEdit">
<short>Implements a float-based spin edit control</short>
<short>Implements a float-based spin edit control.</short>
<descr>
<p>
<var>TFloatSpinEdit</var> is a <var>TCustomFloatSpinEdit</var> descendant which implements a spin edit control for a <var>Float</var> value. It provides an edit control for the numeric value and up / down buttons that can be clicked to increment or decrement the <var>Value</var> for the control. TFloatSpinEdit sets the visibility for properties introduced in ancestor classes.
@ -477,7 +477,7 @@
<element name="TFloatSpinEdit.AutoSelected">
<short>
Indicates whether the selected content in the control has been automatically selected
Indicates whether the selected content in the control has been automatically selected.
</short>
<descr>
<p>
@ -544,7 +544,7 @@
<element name="TFloatSpinEdit.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="TCustomSpinEdit">
<short>The base class for an integer-based spin edit control</short>
<short>The base class for an integer-based spin edit control.</short>
<descr>
<p>
<var>TCustomSpinEdit</var> is a <var>TCustomFloatSpinEdit</var> descendant which implements a control used to edit, increment, and decrement an Integer value. It has arrow buttons to allow the user to increment / decrement the value and an edit box used to enter a value directly.
@ -559,95 +559,95 @@
</element>
<element name="TCustomSpinEdit.GetIncrement">
<short>Gets the value for the Increment property</short>
<short>Gets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetIncrement.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetMaxValue">
<short>Gets the value for the MaxValue property</short>
<short>Gets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetMaxValue.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetMinValue">
<short>Gets the value for the MinValue property</short>
<short>Gets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetMinValue.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.GetValue">
<short>Gets the value for the Value property</short>
<short>Gets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomSpinEdit.GetValue.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetIncrement">
<short>Sets the value for the Increment property</short>
<short>Sets the value for the Increment property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Increment"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetIncrement.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetMaxValue">
<short>Sets the value for the MaxValue property</short>
<short>Sets the value for the MaxValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MaxValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetMaxValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetMinValue">
<short>Sets the value for the MinValue property</short>
<short>Sets the value for the MinValue property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetMinValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.SetValue">
<short>Sets the value for the Value property</short>
<short>Sets the value for the Value property.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.Value"/>
</seealso>
</element>
<element name="TCustomSpinEdit.SetValue.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TCustomSpinEdit.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 ensures that <var>DecimalPlaces</var> is set to <b>0</b> (<b>zero</b>) for the <var>Integer</var> type used in the <var>Value</var> property.
@ -662,11 +662,11 @@
</seealso>
</element>
<element name="TCustomSpinEdit.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TCustomSpinEdit.GetLimitedValue">
<short>Gets the value for the control limited the range in MinValue and MaxValue</short>
<short>Gets the value for the control limited the range in MinValue and MaxValue.</short>
<descr>
<remark>
<var>GetLimitedValue</var> is implemented to return a <var>Double</var> value. This remains because the method is called from widgetset classes for both TFloatSpinEdit and TSpinEdit, and the method signature cannot be changed to use the <var>Integer</var> type desired for the implementation.
@ -681,14 +681,14 @@
</seealso>
</element>
<element name="TCustomSpinEdit.GetLimitedValue.Result">
<short>Range-limited value for the control</short>
<short>Range-limited value for the control.</short>
</element>
<element name="TCustomSpinEdit.GetLimitedValue.AValue">
<short>Value normalized to the range in MinValue and MaxValue</short>
<short>Value normalized to the range in MinValue and MaxValue.</short>
</element>
<element name="TCustomSpinEdit.Value">
<short>The value for the spin edit control</short>
<short>The value for the spin edit control.</short>
<descr/>
<seealso>
<link id="TCustomSpinEdit.MinValue"/>
@ -698,7 +698,7 @@
</element>
<element name="TCustomSpinEdit.MinValue">
<short>Minimal value allowed for the spin edit control</short>
<short>Minimal value allowed for the spin edit control.</short>
<descr>
<p>
Minimal value allowed for the spin edit. Set the MinValue property equal to MaxValue to allow any number to be selected.
@ -712,7 +712,7 @@
</element>
<element name="TCustomSpinEdit.MaxValue">
<short>Maximal value allowed for the spin edit control</short>
<short>Maximal value allowed for the spin edit control.</short>
<descr>
<p>
Maximal value allowed for the spin edit. Set the MinValue property equal to MaxValue to allow any number to be selected.
@ -727,7 +727,7 @@
<element name="TCustomSpinEdit.Increment">
<short>
The value by which the value of the control should be increased/decreased when the user clicks one of the arrows or one of the keyboard up/down arrows
The value by which the value of the control should be increased/decreased when the user clicks one of the arrows or one of the keyboard up/down arrows.
</short>
<descr/>
<seealso>
@ -738,7 +738,7 @@
</element>
<element name="TSpinEdit">
<short>Implements an integer-based spin edit control</short>
<short>Implements an integer-based spin edit control.</short>
<descr>
<p>
<var>TSpinEdit</var> is a <var>TCustomSpinEdit</var> descendant which implements an integer-based spin edit control. It provides an edit control where the Integer value can be entered directly, and has arrow buttons to allow the user to increment / decrement the value for the control.
@ -806,7 +806,7 @@
<element name="TSpinEdit.Visible" link="#lcl.controls.TControl.Visible"/>
<element name="Register">
<short>Registers components for use in the Lazarus IDE</short>
<short>Registers components for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are added to the Lazarus IDE component palette:

186
docs/xml/lcl/stdactns.xml
View File

@ -8,8 +8,8 @@
-->
<module name="StdActns">
<short>
Defines standard actions to be used in Action Lists in the LCL
</short>
Defines standard actions to be used in Action Lists in the LCL.
</short>
<descr>
<p>
<file>stdactns.pas</file> contains <var>TAction</var> descendents
@ -81,7 +81,7 @@
<element name="THintAction" link="#lcl.forms.TCustomHintAction">
<short>
<var>THintAction </var>- standard action for dealing with requests
for a <var>Hint</var>
for a <var>Hint</var>.
</short>
<descr/>
<seealso/>
@ -90,7 +90,7 @@
<element name="TEditAction">
<short>
<var>TEditAction </var>- base class for actions associated with the
various <var>Edit</var> menu options
various <var>Edit</var> menu options.
</short>
<descr/>
<seealso>
@ -101,14 +101,14 @@
<element name="TEditAction.FControl">
<short>
<var>FControl</var> - local variable holding the Edit control
associated with this action
associated with this action.
</short>
</element>
<element name="TEditAction.SetControl">
<short>
<var>SetControl</var> - specifies the Edit control associated with
this action
this action.
</short>
<descr/>
<seealso/>
@ -120,7 +120,7 @@
<element name="TEditAction.Notification" link="#rtl.classes.TComponent.Notification">
<short>
Handles notifcations when a control in the class instance is added
or removed
or removed.
</short>
<descr/>
<seealso/>
@ -133,7 +133,7 @@
</element>
<element name="TEditAction.Destroy" link="#rtl.classes.TBasicAction.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
Calls the inherited destructor.
</descr>
@ -153,7 +153,7 @@
</element>
<element name="TEditAction.Control">
<short>The Edit <var>Control</var> associated with this action</short>
<short>The Edit <var>Control</var> associated with this action.</short>
<descr>
<p>
Limits the target for the action to a specific control.
@ -165,7 +165,7 @@
<element name="TEditCut">
<short>
<var>TEditCut</var>- standard action associated with the
<var>Edit Cut</var> menu option
<var>Edit Cut</var> menu option.
</short>
<descr/>
<seealso>
@ -194,7 +194,7 @@
<element name="TEditCopy">
<short>
<var>TEditCopy</var> - standard action associated with the
<var>Edit Copy</var> menu option
<var>Edit Copy</var> menu option.
</short>
<descr/>
<seealso>
@ -223,7 +223,7 @@
<element name="TEditPaste">
<short>
<var>TEditPaste</var> - standard action associated with the
<var>Edit Paste</var> menu option
<var>Edit Paste</var> menu option.
</short>
<descr/>
<seealso/>
@ -250,7 +250,7 @@
<element name="TEditSelectAll">
<short>
<var>TEditSelectAll</var> - standard action associated with the
<var>Edit Select All </var>menu option
<var>Edit Select All </var>menu option.
</short>
<descr/>
<seealso/>
@ -277,7 +277,7 @@
<element name="TEditUndo">
<short>
<var>TEditUndo</var> - standard action associated with the
<var>Edit Undo</var> menu option
<var>Edit Undo</var> menu option.
</short>
<descr/>
<seealso/>
@ -304,7 +304,7 @@
<element name="TEditDelete">
<short>
<var>TEditDelete</var> - standard action associated with the
<var>Edit Delete</var> menu option
<var>Edit Delete</var> menu option.
</short>
<descr/>
<seealso/>
@ -331,7 +331,7 @@
<element name="THelpAction">
<short>
<var>THelpAction</var> - base class for actions associated with
the various <var>Help</var> menu options
the various <var>Help</var> menu options.
</short>
<descr/>
<seealso>
@ -340,14 +340,14 @@
</element>
<element name="THelpAction.Create" link="#rtl.classes.TBasicAction.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
Calls the inherited constructor.
</descr>
<seealso/>
</element>
<element name="THelpAction.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="THelpAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
@ -374,7 +374,7 @@
<element name="THelpContents">
<short>
<var>THelpContents</var> - standard action associated with the
<var>Help Contents</var> menu option
<var>Help Contents</var> menu option.
</short>
<descr/>
<seealso/>
@ -392,7 +392,7 @@
<element name="THelpTopicSearch">
<short>
<var>THelpTopicSearch</var> - standard action associated with the
<var>Help Topic Search</var> menu option
<var>Help Topic Search</var> menu option.
</short>
<descr/>
<seealso/>
@ -410,7 +410,7 @@
<element name="THelpOnHelp">
<short>
<var>THelpOnHelp</var> - standard action associated with the
<var>Help On Help</var> menu item (i.e. how to get help)
<var>Help On Help</var> menu item (i.e. how to get help).
</short>
<descr/>
<seealso/>
@ -428,7 +428,7 @@
<element name="THelpContextAction">
<short>
<var>THelpContextAction</var> - standard action for providing
context-sensitive <var>Help</var>
context-sensitive <var>Help</var>.
</short>
<descr/>
<seealso/>
@ -454,7 +454,7 @@
<element name="TCommonDialogClass">
<short>
<var>TCommonDialogClass</var> - class of <var>TCommonDialog</var>
<var>TCommonDialogClass</var> - class of <var>TCommonDialog</var>.
</short>
<descr/>
<seealso/>
@ -463,7 +463,7 @@
<element name="TCommonDialogAction">
<short>
<var>TCommonDialogAction</var> - base class for providing actions
associated with <var>Dialogs</var>
associated with <var>Dialogs</var>.
</short>
<descr/>
<seealso>
@ -479,21 +479,21 @@
<element name="TCommonDialogAction.FDialog">
<short>
<var>FDialog</var> - local variable holding the Dialog associated
with this action
with this action.
</short>
</element>
<element name="TCommonDialogAction.DoAccept">
<short>
<var>DoAccept</var> - perform the code for the
<var>OnAccept</var> event
<var>OnAccept</var> event.
</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.DoBeforeExecute">
<short>Performs the BeforeExecute notification when assigned</short>
<short>Performs the BeforeExecute notification when assigned.</short>
<descr/>
<seealso/>
</element>
@ -501,7 +501,7 @@
<element name="TCommonDialogAction.DoCancel">
<short>
<var>DoCancel</var> - perform the code for the
<var>OnCancel</var> event
<var>OnCancel</var> event.
</short>
<descr/>
<seealso/>
@ -510,7 +510,7 @@
<element name="TCommonDialogAction.GetDialogClass">
<short>
<var>GetDialogClass</var> - returns the class type for the dialog
associated with this action
associated with this action.
</short>
<descr/>
<seealso/>
@ -521,7 +521,7 @@
<element name="TCommonDialogAction.CreateDialog">
<short>
Create a new instance of the class type used in the Dialog property
Create a new instance of the class type used in the Dialog property.
</short>
<descr>
<p>
@ -536,12 +536,12 @@
</element>
<element name="TCommonDialogAction.Create" link="#rtl.classes.TBasicAction.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TCommonDialogAction.Create.TheOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TCommonDialogAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
@ -568,7 +568,7 @@
<element name="TCommonDialogAction.ExecuteResult">
<short>
<var>ExecuteResult</var> - the result of the execution:
True if successful
True if successful.
</short>
<descr/>
<seealso/>
@ -577,7 +577,7 @@
<element name="TCommonDialogAction.BeforeExecute">
<short>
<var>BeforeExecute</var> - event handler for performance before
execution of the action
execution of the action.
</short>
<descr/>
<seealso/>
@ -585,7 +585,7 @@
<element name="TCommonDialogAction.OnAccept">
<short>
<var>OnAccept</var> - event handler for a press of the Accept button
<var>OnAccept</var> - event handler for a press of the Accept button.
</short>
<descr/>
<seealso/>
@ -593,7 +593,7 @@
<element name="TCommonDialogAction.OnCancel">
<short>
<var>OnCancel</var> - event handler for a press of the Cancel button
<var>OnCancel</var> - event handler for a press of the Cancel button.
</short>
<descr/>
<seealso/>
@ -608,7 +608,7 @@
<element name="TFileAction">
<short>
<var>TFileAction</var> - base class for providing actions associated
with various file dialogs and menu options
with various file dialogs and menu options.
</short>
<descr/>
<seealso>
@ -618,7 +618,7 @@
<element name="TFileAction.GetFileName">
<short>
Gets the value for the FileName property
Gets the value for the FileName property.
</short>
<descr/>
<seealso>
@ -626,12 +626,12 @@
</seealso>
</element>
<element name="TFileAction.GetFileName.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFileAction.SetFileName">
<short>
Sets the value for the FileName property
Sets the value for the FileName property.
</short>
<descr/>
<seealso>
@ -639,13 +639,13 @@
</seealso>
</element>
<element name="TFileAction.SetFileName.AValue">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<element name="TFileAction.GetDialog">
<short>
<var>GetDialog</var> - returns a <var>TOpenDialog</var> for use in
this File action
this File action.
</short>
<descr/>
<seealso>
@ -653,12 +653,12 @@
</seealso>
</element>
<element name="TFileAction.GetDialog.Result">
<short>TOpenDialog instance used in the class</short>
<short>TOpenDialog instance used in the class.</short>
</element>
<element name="TFileAction.FileName">
<short>
File name returned from the dialog in the action
File name returned from the dialog in the action.
</short>
<descr>
<p>
@ -674,7 +674,7 @@
<element name="TFileOpen">
<short>
<var>TFileOpen</var> - standard action (including opening a dialog)
associated with the <var>File Open</var> menu option
associated with the <var>File Open</var> menu option.
</short>
<descr/>
<seealso>
@ -686,7 +686,7 @@
<element name="TFileOpen.GetDialog">
<short>
Gets the value for the Dialog property
Gets the value for the Dialog property.
</short>
<descr/>
<seealso>
@ -694,12 +694,12 @@
</seealso>
</element>
<element name="TFileOpen.GetDialog.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFileOpen.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
<short>
Gets the class reference used to create the Dialog for the action
Gets the class reference used to create the Dialog for the action.
</short>
<descr/>
<seealso>
@ -708,13 +708,13 @@
</seealso>
</element>
<element name="TFileOpen.GetDialogClass.Result">
<short>TCommonDialogClass reference used to create the Dialog</short>
<short>TCommonDialogClass reference used to create the Dialog.</short>
</element>
<element name="TFileOpen.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFileOpen.Dialog">
<short>The Open <var>Dialog</var> to be used with this action</short>
<short>The Open <var>Dialog</var> to be used with this action.</short>
<descr>
<p>
<var>Dialog</var> is a read-only <var>TOpenDialog</var> property
@ -738,7 +738,7 @@
<element name="TFileOpen.UseDefaultApp">
<short>
Indicates if the default application should be used to open the
file for the action
file for the action.
</short>
<descr>
<p>
@ -765,7 +765,7 @@
<element name="TFileOpenWith">
<short>
<var>TFileOpenWith</var> - standard action (including opening a
dialog) associated with the <var>File Open With</var> menu option
dialog) associated with the <var>File Open With</var> menu option.
</short>
<descr>
<p>
@ -784,7 +784,7 @@
<element name="TFileOpenWith.FFileName"/>
<element name="TFileOpenWith.FileName">
<short>File name for the Open With action</short>
<short>File name for the Open With action.</short>
<descr>
<var>FileName</var> is a <var>TFileName</var> property with the
file name used in the Open With action.
@ -795,7 +795,7 @@
<element name="TFileOpenWith.AfterOpen">
<short>
<var>AfterOpen</var> - event handler to be performed after file
is opened
is opened.
</short>
<descr/>
<seealso/>
@ -804,7 +804,7 @@
<element name="TFileSaveAs">
<short>
<var>TFileSaveAs</var> - standard action (including opening a dialog)
associated with the <var>File Save As</var> menu option
associated with the <var>File Save As</var> menu option.
</short>
<descr>
<p>
@ -820,14 +820,14 @@
</element>
<element name="TFileSaveAs.GetSaveDialog">
<short>Gets the value for the Dialog property</short>
<short>Gets the value for the Dialog property.</short>
<descr/>
<seealso>
<link id="TFileSaveAs.Dialog"/>
</seealso>
</element>
<element name="TFileSaveAs.GetSaveDialog.Result">
<short>Value for the Dialog property</short>
<short>Value for the Dialog property.</short>
</element>
<element name="TFileSaveAs.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
@ -842,7 +842,7 @@
<element name="TFileSaveAs.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFileSaveAs.Dialog">
<short>The Save <var>Dialog</var> to be used with this action</short>
<short>The Save <var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
@ -862,7 +862,7 @@
<element name="TFileExit">
<short>
<var>TFileExit</var> - standard action (closing file and terminating
application) associated with the <var>File Exit</var> menu option
application) associated with the <var>File Exit</var> menu option.
</short>
<descr/>
<seealso>
@ -906,7 +906,7 @@
<element name="TSearchAction">
<short>
<var>TSearchAction</var> - base class for the actions associated
with the various <var>Search</var> menu options
with the various <var>Search</var> menu options.
</short>
<descr/>
<seealso>
@ -917,12 +917,12 @@
<element name="TSearchAction.FControl">
<short>
<var>FControl</var> - local variable holding the control for
use with this action
use with this action.
</short>
</element>
<element name="TSearchAction.CreateDialog">
<short>Creates the class instance used in the Dialog property</short>
<short>Creates the class instance used in the Dialog property.</short>
<descr>
<p>
Calls the inherited CreateDialog method, and assigns the Search
@ -935,31 +935,31 @@
<element name="TSearchAction.Notification" link="#rtl.classes.TComponent.Notification">
<short>
Handles notifcations when a control in the class instance is added
or removed
or removed.
</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.Notification.AComponent">
<short>Component for the notification</short>
<short>Component for the notification.</short>
</element>
<element name="TSearchAction.Notification.Operation">
<short>Operation for the notification</short>
<short>Operation for the notification.</short>
</element>
<element name="TSearchAction.UpdateControl">
<short>
Updates the internal Control to the value in NewControl
Updates the internal Control to the value in NewControl.
</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.UpdateControl.NewControl">
<short>New value for the internal Control</short>
<short>New value for the internal Control.</short>
</element>
<element name="TSearchAction.PerformSearch">
<short>Performs the seach action using the Dialog options</short>
<short>Performs the seach action using the Dialog options.</short>
<descr>
<p>
Performs the search action using the options and search criteria
@ -972,18 +972,18 @@
<element name="TSearchAction.PerformSearch.Result">
<short>
True when the search value is found in the text for the
internal Control
internal Control.
</short>
</element>
<element name="TSearchAction.ShowNotFound">
<short>Displays a dialog with a "Not Found" message</short>
<short>Displays a dialog with a "Not Found" message.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchAction.Create" link="#rtl.classes.TBasicAction.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
Calls the inherited constructor, and sets the value for the
@ -993,11 +993,11 @@
<seealso/>
</element>
<element name="TSearchAction.Create.TheOwner">
<short>Owner for the class instance</short>
<short>Owner for the class instance.</short>
</element>
<element name="TSearchAction.Destroy" link="#rtl.classes.TBasicAction.Destroy">
<short>Destructor for the class instance</short>
<short>Destructor for the class instance.</short>
<descr>
<p>
Removes the free notification for the internal Control
@ -1020,7 +1020,7 @@
</element>
<element name="TSearchAction.Search">
<short>Performs the <var>Search</var> action</short>
<short>Performs the <var>Search</var> action.</short>
<descr/>
<seealso/>
</element>
@ -1049,7 +1049,7 @@
<element name="TSearchFind">
<short>
<var>TSearchFind</var> - the action associated with a Search and
Find dialog (as opposed to search and replace)
Find dialog (as opposed to search and replace).
</short>
<descr/>
<seealso>
@ -1070,13 +1070,13 @@
<seealso/>
</element>
<element name="TSearchFind.GetDialogClass.Result">
<short>Returns TFindDialog for the action</short>
<short>Returns TFindDialog for the action.</short>
</element>
<element name="TSearchFind.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TSearchFind.Dialog">
<short>The Find<var>Dialog</var> to be used with this action</short>
<short>The Find<var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
@ -1098,7 +1098,7 @@
<element name="TSearchReplace">
<short>
<var>TSearchReplace</var> - action associated with the <var>Search
and Replace</var> menu option and dialogs
and Replace</var> menu option and dialogs.
</short>
<descr/>
<seealso>
@ -1119,7 +1119,7 @@
<element name="TSearchReplace.Replace">
<short>
<var>Replace</var> - the method to perform the Replace action once
the specified text has been found
the specified text has been found.
</short>
<descr/>
<seealso/>
@ -1128,7 +1128,7 @@
<element name="TSearchReplace.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TSearchReplace.Dialog">
<short>The Replace<var>Dialog</var> to be used with this action</short>
<short>The Replace<var>Dialog</var> to be used with this action.</short>
<descr/>
<seealso/>
</element>
@ -1149,7 +1149,7 @@
<element name="TSearchFindFirst">
<short>
<var>TSearchFindFirst</var> - Search action to find the first match
<var>TSearchFindFirst</var> - Search action to find the first match.
</short>
<descr/>
<seealso>
@ -1159,7 +1159,7 @@
<element name="TSearchFindNext">
<short>
<var>TSearchFindNext</var> - search action to find the next match
<var>TSearchFindNext</var> - search action to find the next match.
</short>
<descr/>
<seealso>
@ -1172,12 +1172,12 @@
<element name="TSearchFindNext.SetSearchFind.AValue"/>
<element name="TSearchFindNext.Create" link="#rtl.classes.TBasicAction.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr/>
<seealso/>
</element>
<element name="TSearchFindNext.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<element name="TSearchFindNext.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget"/>
@ -1193,7 +1193,7 @@
<element name="TSearchFindNext.Notification" link="#rtl.classes.TComponent.Notification">
<short>
Handles notifcations when a component used in the class instance is
added or removed
added or removed.
</short>
<descr/>
<seealso/>
@ -1210,7 +1210,7 @@
<element name="TSearchFindNext.ImageIndex" link="#lcl.actnlist.TCustomAction.ImageIndex"/>
<element name="TSearchFindNext.SearchFind">
<short>The <var>SearchFind</var> action to use for searching</short>
<short>The <var>SearchFind</var> action to use for searching.</short>
<descr/>
<seealso/>
</element>
@ -1223,7 +1223,7 @@
<element name="TFontEdit">
<short>
<var>TFontEdit </var>- standard action for opening a
<var>Font Edit</var> dialog
<var>Font Edit</var> dialog.
</short>
<descr/>
<seealso>
@ -1232,14 +1232,14 @@
</element>
<element name="TFontEdit.GetDialog">
<short>Gets the value for the Dialog property</short>
<short>Gets the value for the Dialog property.</short>
<descr/>
<seealso>
<link id="TFontEdit.Dialog"/>
</seealso>
</element>
<element name="TFontEdit.GetDialog.Result">
<short>Value for the property</short>
<short>Value for the property.</short>
</element>
<element name="TFontEdit.GetDialogClass" link="#lcl.stdactns.TCommonDialogAction.GetDialogClass">
@ -1254,7 +1254,7 @@
<element name="TFontEdit.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TFontEdit.Dialog">
<short>The Font<var>Dialog</var> to use for this action</short>
<short>The Font<var>Dialog</var> to use for this action.</short>
<descr/>
<seealso/>
</element>
@ -1276,7 +1276,7 @@
<element name="TColorSelect">
<short>
<var>TColorSelect</var> - standard action for opening a <var>Color
Selection</var> dialog
Selection</var> dialog.
</short>
<descr/>
<seealso>
@ -1305,7 +1305,7 @@
<element name="TColorSelect.Caption" link="#lcl.actnlist.TCustomAction.Caption"/>
<element name="TColorSelect.Dialog">
<short>The Color<var>Dialog</var> to use with this action</short>
<short>The Color<var>Dialog</var> to use with this action.</short>
<descr/>
<seealso/>
</element>
@ -1325,7 +1325,7 @@
<element name="TColorSelect.OnHint" link="#lcl.actnlist.TCustomAction.OnHint"/>
<element name="Register">
<short>Registers component for use in the Lazarus IDE</short>
<short>Registers component for use in the Lazarus IDE.</short>
<descr>
<p>
The following components are registered but not displayed on the

1823
docs/xml/lcl/stdctrls.xml
View File

File diff suppressed because it is too large Load Diff

116
docs/xml/lcl/themes.xml
View File

@ -8,7 +8,7 @@ Themes
-->
<module name="Themes">
<short>
Implements Theme Services for supported platforms / widgetsets
Implements Theme Services for supported platforms / widgetsets.
</short>
<descr>
<p>
@ -38,7 +38,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
<element name="GraphType"/>
<element name="TThemedElement">
<short>Represents elements which can be themed</short>
<short>Represents elements which can be themed.</short>
<descr/>
<seealso/>
</element>
@ -116,7 +116,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedButton">
<short>Represents theme elements for buttons</short>
<short>Represents theme elements for buttons.</short>
<descr/>
<seealso/>
</element>
@ -212,7 +212,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedClock">
<short>Represents theme elements for a Clock</short>
<short>Represents theme elements for a Clock.</short>
<descr/>
<seealso/>
</element>
@ -228,7 +228,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
<!-- enumeration type Visibility: default -->
<element name="TThemedComboBox">
<short>Represents theme elemenets used to theme combo-box controls</short>
<short>Represents theme elemenets used to theme combo-box controls.</short>
<descr/>
<seealso/>
</element>
@ -252,7 +252,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedEdit">
<short>Represents theme elements used to theme Edit controls</short>
<short>Represents theme elements used to theme Edit controls.</short>
<descr/>
<seealso/>
</element>
@ -288,7 +288,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedExplorerBar">
<short>Represents theme elements used to theme an Explorer Bar</short>
<short>Represents theme elements used to theme an Explorer Bar.</short>
<descr/>
<seealso/>
</element>
@ -393,7 +393,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedHeader">
<short>Represents theme elements used to theme a Header control</short>
<short>Represents theme elements used to theme a Header control.</short>
<descr/>
<seealso/>
</element>
@ -438,7 +438,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedListview">
<short>Represents theme elements used to theme List View controls</short>
<short>Represents theme elements used to theme List View controls.</short>
<descr/>
<seealso/>
</element>
@ -477,7 +477,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedMenu">
<short>Represents theme elements used to theme Menus</short>
<short>Represents theme elements used to theme Menus.</short>
<descr/>
<seealso/>
</element>
@ -513,7 +513,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedPage">
<short>Represents theme elements used for themed Page controls</short>
<short>Represents theme elements used for themed Page controls.</short>
<descr/>
<seealso/>
</element>
@ -573,7 +573,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedProgress">
<short>Represents theme elements used to theme progress bar controls</short>
<short>Represents theme elements used to theme progress bar controls.</short>
<descr/>
<seealso/>
</element>
@ -597,7 +597,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedRebar">
<short>Represents theme elements used to theme Rebar controls</short>
<short>Represents theme elements used to theme Rebar controls.</short>
<descr/>
<seealso/>
</element>
@ -657,7 +657,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedScrollBar">
<short>Represents theme elements used to theme scroll bars</short>
<short>Represents theme elements used to theme scroll bars.</short>
<descr/>
<seealso/>
</element>
@ -819,7 +819,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedSpin">
<short>Represents theme elements used to theme spin button controls</short>
<short>Represents theme elements used to theme spin button controls.</short>
<descr/>
<seealso/>
</element>
@ -879,7 +879,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedStartPanel">
<short>Represents theme elements used to theme the Start Panel</short>
<short>Represents theme elements used to theme the Start Panel.</short>
<descr/>
<seealso/>
</element>
@ -936,7 +936,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedStatus">
<short>Represents theme elements used to theme status bars</short>
<short>Represents theme elements used to theme status bars.</short>
<descr/>
<seealso/>
</element>
@ -957,7 +957,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTab">
<short>Represents theme elements used to theme Tab controls</short>
<short>Represents theme elements used to theme Tab controls.</short>
<descr/>
<seealso/>
</element>
@ -1095,7 +1095,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTaskBand">
<short>Represents theme elements used to theme task bar bands</short>
<short>Represents theme elements used to theme task bar bands.</short>
<descr/>
<seealso/>
</element>
@ -1116,7 +1116,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTaskBar">
<short>Represents theme elements used to theme Task bars</short>
<short>Represents theme elements used to theme Task bars.</short>
<descr/>
<seealso/>
</element>
@ -1131,7 +1131,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedToolBar">
<short>Represents theme elements used to theme tool bars</short>
<short>Represents theme elements used to theme tool bars.</short>
<descr/>
<seealso/>
</element>
@ -1251,7 +1251,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedToolTip">
<short>Represents theme elements used to theme tool tips</short>
<short>Represents theme elements used to theme tool tips.</short>
<descr/>
<seealso/>
</element>
@ -1296,7 +1296,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTrackBar">
<short>Represents theme elements used to theme track bars</short>
<short>Represents theme elements used to theme track bars.</short>
<descr/>
<seealso/>
</element>
@ -1410,7 +1410,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTrayNotify">
<short>Represents theme elements used to theme tray nofications</short>
<short>Represents theme elements used to theme tray nofications.</short>
<descr/>
<seealso/>
</element>
@ -1428,7 +1428,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedTreeview">
<short>Represents theme elements used to theme tree view controls</short>
<short>Represents theme elements used to theme tree view controls.</short>
<descr/>
<seealso/>
</element>
@ -1464,7 +1464,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="TThemedWindow">
<short>Represents theme elements used to theme Windows</short>
<short>Represents theme elements used to theme Windows.</short>
<descr/>
<seealso/>
</element>
@ -1821,13 +1821,13 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
</element>
<element name="PThemedElementDetails">
<short>Pointer to a TThemedElementDetails instance</short>
<short>Pointer to a TThemedElementDetails instance.</short>
<descr/>
<seealso/>
</element>
<element name="TThemedElementDetails">
<short>Record type with a theme element, part, and state values</short>
<short>Record type with a theme element, part, and state values.</short>
<descr/>
<seealso/>
</element>
@ -1856,17 +1856,17 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
<seealso/>
</element>
<element name="TThemeOption.toShowButtonImages">
<short>Show images on buttons</short>
<short>Show images on buttons.</short>
</element>
<element name="TThemeOption.toShowMenuImages">
<short>show images on menus</short>
<short>show images on menus.</short>
</element>
<element name="TThemeOption.toUseGlyphEffects">
<short>Use hot / down effects on (button) glyphs</short>
<short>Use hot / down effects on (button) glyphs.</short>
</element>
<element name="TThemeServices">
<short>Implements theme services</short>
<short>Implements theme services.</short>
<descr>
<p>
<var>TThemeServices</var> is a small foot print class to provide the user with pure Windows XP theme related abilities like painting elements and text, or retrieving theme element details.
@ -1964,7 +1964,7 @@ Mike Lischke (public@soft-gems.net, www.soft-gems.net).
<element name="TThemeServices.Create">
<short>
Constructor for the class instance
Constructor for the class instance.
</short>
<descr>
<p>
@ -1980,7 +1980,7 @@ Calls <var>InitThemes</var> to detrmine if theme data is available. Sets the val
<element name="TThemeServices.Destroy">
<short>
Destructor for the class instance
Destructor for the class instance.
</short>
<descr/>
<seealso/>
@ -2066,7 +2066,7 @@ Destructor for the class instance
<element name="TThemeServices.GetDetailSize">
<short>
Gets the default dimensions for a theme element detail
Gets the default dimensions for a theme element detail.
</short>
<descr>
<p>
@ -2084,7 +2084,7 @@ Gets the default size for a theme element detail. -1 in the Width and Height for
<element name="TThemeServices.GetDetailRegion">
<short>
Gets the handle to the region for a theme element
Gets the handle to the region for a theme element.
</short>
<descr/>
<seealso/>
@ -2140,7 +2140,7 @@ Use of toUseGlyphEffects is OS-dependent. The option is used for Linux. It is no
</element>
<element name="TThemeServices.GetTextExtent">
<short>Calculates the bounding rectangle for the text or caption in a theme element</short>
<short>Calculates the bounding rectangle for the text or caption in a theme element.</short>
<descr/>
<seealso/>
</element>
@ -2168,7 +2168,7 @@ Use of toUseGlyphEffects is OS-dependent. The option is used for Linux. It is no
<element name="TThemeServices.ColorToRGB">
<short>
Converts a TColor value to the Cardinal color constant needed for a theme element detail
Converts a TColor value to the Cardinal color constant needed for a theme element detail.
</short>
<descr/>
<seealso/>
@ -2185,7 +2185,7 @@ Converts a TColor value to the Cardinal color constant needed for a theme elemen
<element name="TThemeServices.ContentRect">
<short>
Adjusts the bounding rectangle for a theme element to contain the content area only
Adjusts the bounding rectangle for a theme element to contain the content area only.
</short>
<descr/>
<seealso/>
@ -2205,7 +2205,7 @@ Adjusts the bounding rectangle for a theme element to contain the content area o
<element name="TThemeServices.DrawEdge">
<short>
Default drawing for the edges on a themed element
Default drawing for the edges on a themed element.
</short>
<descr/>
<seealso/>
@ -2231,7 +2231,7 @@ Default drawing for the edges on a themed element
<element name="TThemeServices.DrawElement">
<short>
Draws a theme element using the specified theme element details
Draws a theme element using the specified theme element details.
</short>
<descr/>
<seealso/>
@ -2251,7 +2251,7 @@ Draws a theme element using the specified theme element details
<element name="TThemeServices.DrawIcon">
<short>
Draws the icon for a theme element
Draws the icon for a theme element.
</short>
<descr>
<p>
@ -2299,7 +2299,7 @@ Overloaded to provide WIndows and non-Windows variants. Overridden in the TWin32
<element name="TThemeServices.DrawText">
<short>
Draws the text for a themed control
Draws the text for a themed control.
</short>
<descr>
<p>
@ -2344,7 +2344,7 @@ Draws the text for a themed control
<element name="TThemeServices.PaintBorder">
<short>
Default painting method for the borders for a control
Default painting method for the borders for a control.
</short>
<descr>
<p>
@ -2361,7 +2361,7 @@ Default painting method for the borders for a control
</element>
<element name="TThemeServices.UpdateThemes">
<short>Reloads theme elements and details when UseThemes is True</short>
<short>Reloads theme elements and details when UseThemes is True.</short>
<descr>
<p>
Called from the <var>Create</var> constructor. Think of it as the theme counterpart for the <var>Loaded</var> method used for components.
@ -2373,7 +2373,7 @@ Called from the <var>Create</var> constructor. Think of it as the theme counterp
</element>
<element name="TThemeServices.DottedBrush">
<short>Bitmap Handle for the Dotted Pattern Brush used to draw theme elements</short>
<short>Bitmap Handle for the Dotted Pattern Brush used to draw theme elements.</short>
<descr/>
<link id="ThemeServices.DrawElement"/>
</element>
@ -2391,7 +2391,7 @@ Called from the <var>Create</var> constructor. Think of it as the theme counterp
</element>
<element name="TThemeServices.OnThemeChange">
<short>Event handler signalled when the current window theme has been changed</short>
<short>Event handler signalled when the current window theme has been changed.</short>
<descr>
<p>
<var>OnThemeChange</var> is a <var>TNotifyEvent</var> property with the event handler signalled when the current window theme has been changed. Applications must implement and assign an object procedure to the handler to respond to the event notification.
@ -2404,7 +2404,7 @@ Called from the <var>Create</var> constructor. Think of it as the theme counterp
<element name="ThemeServices">
<short>
Provides access to the Theme Services singleton for the widgetset
Provides access to the Theme Services singleton for the widgetset.
</short>
<descr>
<p>
@ -2414,7 +2414,7 @@ Provides access to the Theme Services singleton for the widgetset
<seealso/>
</element>
<element name="ThemeServices.Result">
<short>TThemeServices instance for the widgetset</short>
<short>TThemeServices instance for the widgetset.</short>
</element>
<element name="ThemedElementDetailsEqual">
@ -2444,7 +2444,7 @@ Do not modify the copyright in any way! Usage of this unit is prohibited without
<element name="TThemesImageDrawEvent">
<short>
Specifies an event handler signalled to draw an image in an image list to a Canvas instance
Specifies an event handler signalled to draw an image in an image list to a Canvas instance.
</short>
<descr>
<p>
@ -2455,42 +2455,42 @@ Specifies an event handler signalled to draw an image in an image list to a Canv
</element>
<element name="TThemesImageDrawEvent.AImageList">
<short>
Image list with the image drawn in the event handler
Image list with the image drawn in the event handler.
</short>
</element>
<element name="TThemesImageDrawEvent.ACanvas">
<short>
TCanvas instance where the image is drawn
TCanvas instance where the image is drawn.
</short>
</element>
<element name="TThemesImageDrawEvent.AX">
<short>
Horizontal canvas coordinate where the image is drawn
Horizontal canvas coordinate where the image is drawn.
</short>
</element>
<element name="TThemesImageDrawEvent.AY">
<short>
Vertical canvas coordinate where the image is drawn
Vertical canvas coordinate where the image is drawn.
</short>
</element>
<element name="TThemesImageDrawEvent.AIndex">
<short>
Ordinal position in the image list for the image drawn in the event handler
Ordinal position in the image list for the image drawn in the event handler.
</short>
</element>
<element name="TThemesImageDrawEvent.ADrawEffect">
<short>
Drawing effect applied to the image
Drawing effect applied to the image.
</short>
</element>
<element name="TThemesImageDrawEvent.AImageWidth">
<short>
Width for the rendered image
Width for the rendered image.
</short>
</element>
<element name="TThemesImageDrawEvent.ARefControl">
<short>
Reference to the control with the Canvas updated in the event handler
Reference to the control with the Canvas updated in the event handler.
</short>
</element>

94
docs/xml/lcl/timepopup.xml
View File

@ -7,7 +7,7 @@
====================================================================
-->
<module name="TimePopup">
<short>Contains forms, types, and routines used to display a pop-up for TTimeEdit</short>
<short>Contains forms, types, and routines used to display a pop-up for TTimeEdit.</short>
<descr>
<p>
<file>timepopup.pas</file> contains the <var>TTimePopupForm</var> form and the <var>ShowTimePopup</var> routine used to create, configure, and display the pop-up form.
@ -36,7 +36,7 @@
<element name="WSForms"/>
<element name="TReturnTimeEvent">
<short>Specifies an event handler signalled to get a time return value</short>
<short>Specifies an event handler signalled to get a time return value.</short>
<descr>
<p>
<var>TReturnTimeEvent</var> specifies an event handler signalled to validate or assign a time value. It is an object procedure which must be implemented in an application to respond to the event notification.
@ -57,14 +57,14 @@
</seealso>
</element>
<element name="TReturnTimeEvent.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TReturnTimeEvent.ATime">
<short>Time value examined or updated in the event handler</short>
<short>Time value examined or updated in the event handler.</short>
</element>
<element name="TTimePopupForm">
<short>Implements a form displayed to capture a time value</short>
<short>Implements a form displayed to capture a time value.</short>
<descr>
<p>
<var>TTimePopupForm</var> implements a form displayed to capture and return a time value.
@ -90,7 +90,7 @@
<element name="TTimePopupForm.MoreLessBtn"/>
<element name="TTimePopupForm.GridsDblClick">
<short>Implements the OnDblClick event handler for grids controls on the form</short>
<short>Implements the OnDblClick event handler for grids controls on the form.</short>
<descr>
<p>
Calls <var>ReturnTime</var> to signal the <var>OnReturnTime</var> event handler (when assigned) and close the form.
@ -103,11 +103,11 @@
</seealso>
</element>
<element name="TTimePopupForm.GridsDblClick.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TTimePopupForm.GridsKeyDown">
<short>Implements the OnKeyDown event handler for grid controls on the form</short>
<short>Implements the OnKeyDown event handler for grid controls on the form.</short>
<descr>
<p>
<var>GridsKeyDown</var> ensures that the virtual key in <var>Key</var> and <var>Shift</var> is applied, when required. GridsKeyDown calls for form methods for the following:
@ -125,18 +125,18 @@
<seealso/>
</element>
<element name="TTimePopupForm.GridsKeyDown.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TTimePopupForm.GridsKeyDown.Key">
<short>Virtual key code examined in the method</short>
<short>Virtual key code examined in the method.</short>
</element>
<element name="TTimePopupForm.GridsKeyDown.Shift">
<short>Key Modifier examined in the method</short>
<short>Key Modifier examined in the method.</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas">
<short>
Sets the canvas text style for a grid on the form
Sets the canvas text style for a grid on the form.
</short>
<descr>
<p>
@ -149,28 +149,28 @@
<seealso/>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.sender">
<short>Control updated in the method</short>
<short>Control updated in the method.</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aCol">
<short>Ignored</short>
<short>Ignored.</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aRow">
<short>Ignored</short>
<short>Ignored.</short>
</element>
<element name="TTimePopupForm.GridPrepareCanvas.aState">
<short>Ignored</short>
<short>Ignored.</short>
</element>
<element name="TTimePopupForm.MoreLessBtnClick">
<short>
Implements the OnClick event handler for the MoreLessBtn button on the form
Implements the OnClick event handler for the MoreLessBtn button on the form.
</short>
<descr>
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.MoreLessBtnClick.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TTimePopupForm.FClosed"/>
@ -181,19 +181,19 @@
<element name="TTimePopupForm.ActivateDoubleBuffered">
<short>
Ensures that the DoubleBuffered property is updated with the current value from the widget set class
Ensures that the DoubleBuffered property is updated with the current value from the widget set class.
</short>
<descr/>
<seealso/>
</element>
<element name="TTimePopupForm.CalcGridHeights">
<short>Calculates the total height for the Hours and Minutes grids on the form</short>
<short>Calculates the total height for the Hours and Minutes grids on the form.</short>
<descr/>
</element>
<element name="TTimePopupForm.GetTime">
<short>Gets a TDateTime value for the selected cells in Hours and Minutes grids</short>
<short>Gets a TDateTime value for the selected cells in Hours and Minutes grids.</short>
<descr>
Calls EncodeTime to get the return value for the selected cells.
</descr>
@ -201,26 +201,26 @@
</element>
<element name="TTimePopupForm.GetTime.Result">
<short>
TDateTime value for the selected cells; only the time portion of the value is relevant
TDateTime value for the selected cells; only the time portion of the value is relevant.
</short>
</element>
<element name="TTimePopupForm.Initialize">
<short>Initializes the form using the origin and time values specified</short>
<short>Initializes the form using the origin and time values specified.</short>
<descr>
Calls KeepInView to ensure that the form origin remains visible on the current monitor. Called from the ShowTimePopup routine.
</descr>
<seealso/>
</element>
<element name="TTimePopupForm.Initialize.PopupOrigin">
<short>Upper left coordinates for the form</short>
<short>Upper left coordinates for the form.</short>
</element>
<element name="TTimePopupForm.Initialize.ATime">
<short>Initial time value displayed on the form</short>
<short>Initial time value displayed on the form.</short>
</element>
<element name="TTimePopupForm.KeepInView">
<short>Ensures that form remains visible on the current monitor</short>
<short>Ensures that form remains visible on the current monitor.</short>
<descr>
<p>
KeepInView ensures that form remains visible on the current monitor. KeepInView tries to put the form on a "nice" place on the screen and make sure the entire form is visible. TheCaller typically will be a TTimeEdit control, and uses the following logic:
@ -234,11 +234,11 @@
<seealso/>
</element>
<element name="TTimePopupForm.KeepInView.PopupOrigin">
<short>Upper left coordinates where the form is displayed</short>
<short>Upper left coordinates where the form is displayed.</short>
</element>
<element name="TTimePopupForm.ReturnTime">
<short>Validates the current time value for the form</short>
<short>Validates the current time value for the form.</short>
<descr>
<p>
<var>ReturnTime</var> is a procedure used to validate and possibly update the current time value for the form. <var>GetTime</var> is called to get the time value using the selected cells in the Hour and Minute grids.
@ -258,7 +258,7 @@
</element>
<element name="TTimePopupForm.SetLayout">
<short>Sets the layout used in Minute grid for the form</short>
<short>Sets the layout used in Minute grid for the form.</short>
<descr>
<p>
<var>SimpleLayout</var> indicates whether the Minutes grid on the form use the simple layout. Simple layout uses a 30 minute interval between cells in the grid, and offers a more compact appearance. When SimpleLayout is False, a 5 minute interval is used between cells in the Minute grid.
@ -268,20 +268,20 @@
</seealso>
</element>
<element name="TTimePopupForm.SetLayout.SimpleLayout">
<short>Uses the compact 30 minute interval when True</short>
<short>Uses the compact 30 minute interval when True.</short>
</element>
<element name="TTimePopupForm.SetTime">
<short>Sets the time value displayed on the form</short>
<short>Sets the time value displayed on the form.</short>
<descr/>
<seealso/>
</element>
<element name="TTimePopupForm.SetTime.ATime">
<short>Time value applied to the Hour and Minute grid</short>
<short>Time value applied to the Hour and Minute grid.</short>
</element>
<element name="TTimePopupForm.FormClose">
<short>Performs actions needed when the form is closed</short>
<short>Performs actions needed when the form is closed.</short>
<descr>
<p>
<var>FormClose</var> reimplements the FormClose event handler for the form to ensure that the <var>FormDeactivate</var> method is removed from the registered deactivate handlers in the global <var>Application</var> instance. FormClose sets the value in <var>CloseAction</var> to <var>caFree</var> to free the form instance.
@ -294,14 +294,14 @@
</seealso>
</element>
<element name="TTimePopupForm.FormClose.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TTimePopupForm.FormClose.CloseAction">
<short>Close action to perform on exit form the method</short>
<short>Close action to perform on exit form the method.</short>
</element>
<element name="TTimePopupForm.FormCreate">
<short>Performs actions needed when the form instance is created</short>
<short>Performs actions needed when the form instance is created.</short>
<descr>
<p>
<var>FormCreate</var> reimplements the FormCreate method to initialize the form instance, and register its deactivation handler. FormCreate sets the form to us the Simple layout, calls <var>SetLayout</var>, and registers the <var>FormDeactivate</var> method as a deactivation handler in the global <var>Application</var> instance.
@ -314,11 +314,11 @@
</seealso>
</element>
<element name="TTimePopupForm.FormCreate.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="TTimePopupForm.FormDeactivate">
<short>Performs action needed when the form is deactivated</short>
<short>Performs action needed when the form is deactivated.</short>
<descr>
<p>
<var>FormDeactivate</var> reimplements the FormDeactivate event handler for the form. FormDeactivate call the <var>Hide</var> method to immediately hide the form. Otherwise, it would remain visible while in a Drag operation, for example. If not already active, the <var>Close</var> method is called prior to exiting from the method.
@ -330,12 +330,12 @@
</seealso>
</element>
<element name="TTimePopupForm.FormDeactivate.Sender">
<short>Object for the event notification</short>
<short>Object for the event notification.</short>
</element>
<element name="ShowTimePopup">
<short>
Creates, initializes, and displays a TTimePopupForm instance
Creates, initializes, and displays a TTimePopupForm instance.
</short>
<descr>
<p>
@ -348,27 +348,27 @@
</seealso>
</element>
<element name="ShowTimePopup.Position">
<short>Coordinates where the form is displayed</short>
<short>Coordinates where the form is displayed.</short>
</element>
<element name="ShowTimePopup.ATime">
<short>Initial time value for the form</short>
<short>Initial time value for the form.</short>
</element>
<element name="ShowTimePopup.DoubleBufferedForm">
<short>Indicates if DoubleBuffered is enabled in the form instance</short>
<short>Indicates if DoubleBuffered is enabled in the form instance.</short>
</element>
<element name="ShowTimePopup.OnReturnTime">
<short>Event handler signalled when the time value is changed</short>
<short>Event handler signalled when the time value is changed.</short>
</element>
<element name="ShowTimePopup.OnShowHide">
<short>Event handler signalled when the form is show or hidden</short>
<short>Event handler signalled when the form is show or hidden.</short>
</element>
<element name="ShowTimePopup.SimpleLayout">
<short>
True indicates the simple (compact) layout is used for the Minute grid on the form
True indicates the simple (compact) layout is used for the Minute grid on the form.
</short>
</element>
<element name="ShowTimePopup.ACaller">
<short>Control with the time value updated using the pop-up form</short>
<short>Control with the time value updated using the pop-up form.</short>
</element>
</module>

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

@ -8,7 +8,7 @@
-->
<module name="TmSchema">
<short>
Contains types and constants used for theme elements and details in theme services
Contains types and constants used for theme elements and details in theme services.
</short>
<descr>
<p>

62
docs/xml/lcl/toolwin.xml
View File

@ -8,8 +8,8 @@
-->
<module name="Toolwin">
<short>
Implements a control which can paint its client area with optional borders
</short>
Implements a control which can paint its client area with optional borders.
</short>
<descr>
<p>
<file>toolwin.pp</file> implements a control which can paint its client area with optional borders using a raised or lowered drawing style. It defines the common ancestor for controls like TToolBar and TCoolBar.
@ -29,7 +29,7 @@
<!-- enumeration type Visibility: default -->
<element name="TEdgeBorder">
<short>
Enumeration with values that indicate the border edges to draw in TToolWindow
Enumeration with values that indicate the border edges to draw in TToolWindow.
</short>
<descr>
<p>
@ -43,25 +43,25 @@
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeBorder.ebLeft">
<short>Draws the border on the left edge of the control</short>
<short>Draws the border on the left edge of the control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeBorder.ebTop">
<short>Draws the border on the top edge of the control</short>
<short>Draws the border on the top edge of the control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeBorder.ebRight">
<short>Draws the border on the right edge of the control</short>
<short>Draws the border on the right edge of the control.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeBorder.ebBottom">
<short>Draws the border on the bottom edge of the control</short>
<short>Draws the border on the bottom edge of the control.</short>
</element>
<!-- set type Visibility: default -->
<element name="TEdgeBorders">
<short>
Set used to store TEdgeBorder enumeration values
Set used to store TEdgeBorder enumeration values.
</short>
<descr>
<p>
@ -77,7 +77,7 @@
<!-- enumeration type Visibility: default -->
<element name="TEdgeStyle">
<short>
Enumeration type with values that specify the drawing style for borders
Enumeration type with values that specify the drawing style for borders.
</short>
<descr>
<p>
@ -91,21 +91,21 @@
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeStyle.esNone">
<short>No edge style is used</short>
<short>No edge style is used.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeStyle.esRaised">
<short>Edge is drawn with a raised appearance</short>
<short>Edge is drawn with a raised appearance.</short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TEdgeStyle.esLowered">
<short>Edge is drawn with a lowered or sunken appearance</short>
<short>Edge is drawn with a lowered or sunken appearance.</short>
</element>
<!-- object Visibility: default -->
<element name="TToolWindow" link="#LCL.Controls.TCustomControl">
<short>
Implements a control which can paint its client area with borders
Implements a control which can paint its client area with borders.
</short>
<descr>
<p>
@ -130,49 +130,49 @@
<!-- procedure Visibility: private -->
<element name="TToolWindow.SetEdgeBorders">
<short>Sets the value in the EdgeBorders property</short>
<short>Sets the value in the EdgeBorders property.</short>
<descr></descr>
<seealso>
<link id="TToolWindow.EdgeBorders"/>
</seealso>
</element>
<element name="TToolWindow.SetEdgeBorders.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TToolWindow.SetEdgeInner">
<short>Sets the value for the EdgeInner property</short>
<short>Sets the value for the EdgeInner property.</short>
<descr></descr>
<seealso>
<link id="TToolWindow.EdgeInner"/>
</seealso>
</element>
<element name="TToolWindow.SetEdgeInner.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<!-- procedure Visibility: private -->
<element name="TToolWindow.SetEdgeOuter">
<short>Sets the value in the EdgeOuter property</short>
<short>Sets the value in the EdgeOuter property.</short>
<descr></descr>
<seealso>
<link id="TToolWindow.EdgeOuter"/>
</seealso>
</element>
<element name="TToolWindow.SetEdgeOuter.Value">
<short>New value for the property</short>
<short>New value for the property.</short>
</element>
<!-- variable Visibility: protected -->
<element name="TToolWindow.FUpdateCount">
<short>Internal counter used in BeginUpdate and EndUpdate</short>
<short>Internal counter used in BeginUpdate and EndUpdate.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TToolWindow.AdjustClientRect">
<short>
Adjusts the client rectangle when borders are drawn for the control
Adjusts the client rectangle when borders are drawn for the control.
</short>
<descr>
<p>
@ -186,13 +186,13 @@
</seealso>
</element>
<element name="TToolWindow.AdjustClientRect.ARect">
<short>Client rectangle for the control</short>
<short>Client rectangle for the control.</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TToolWindow.Paint">
<short>
Draws the control with the borders and style needed
Draws the control with the borders and style needed.
</short>
<descr>
<p>
@ -208,7 +208,7 @@
<!-- constructor Visibility: public -->
<element name="TToolWindow.Create">
<short>Constructor for the class instance</short>
<short>Constructor for the class instance.</short>
<descr>
<p>
<var>Create</var> is the constructor for the class instance, and calls the inherited constructor using <var>TheOwner</var> as the owner of the control. Create sets the default values for the following properties:
@ -229,19 +229,19 @@
</seealso>
</element>
<element name="TToolWindow.Create.TheOwner">
<short>Owner of the class instance</short>
<short>Owner of the class instance.</short>
</element>
<!-- procedure Visibility: public -->
<element name="TToolWindow.BeginUpdate">
<short>Increments the internal counter for buffering calls to Update</short>
<short>Increments the internal counter for buffering calls to Update.</short>
<descr></descr>
<seealso></seealso>
</element>
<!-- procedure Visibility: public -->
<element name="TToolWindow.EndUpdate">
<short>Decrements the internal counter for buffering calls to Update</short>
<short>Decrements the internal counter for buffering calls to Update.</short>
<descr></descr>
<seealso></seealso>
</element>
@ -249,7 +249,7 @@
<!-- property Visibility: public -->
<element name="TToolWindow.EdgeBorders">
<short>
Indicates the edges to be drawn with a border on the control
Indicates the edges to be drawn with a border on the control.
</short>
<descr>
<p>
@ -267,8 +267,8 @@
<!-- property Visibility: public -->
<element name="TToolWindow.EdgeInner">
<short>
Specifies the drawing style used for the inner border of the control
</short>
Specifies the drawing style used for the inner border of the control.
</short>
<descr>
<p>
<var>EdgeInner</var> is a <var>TEdgeStyle</var> property that specifies the drawing style used for the inner border of the control. The default value for the property is <var>esRaised</var>.
@ -290,7 +290,7 @@
<!-- property Visibility: public -->
<element name="TToolWindow.EdgeOuter">
<short>
Specifies the drawing style used for the outer border of the control
Specifies the drawing style used for the outer border of the control.
</short>
<descr>
<p>

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

@ -9,7 +9,7 @@
-->
<module name="UTrace">
<short>Defines an assertion error handler used for tracebacks in the debugger</short>
<short>Defines an assertion error handler used for tracebacks in the debugger.</short>
<descr>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).

594
docs/xml/lcl/valedit.xml
View File

File diff suppressed because it is too large Load Diff

6
docs/xml/lcl/wscontrols.xml
View File

@ -7,7 +7,7 @@
======================================================================
-->
<module name="WSControls">
<short>Contains the base interface classes for widgetset controls</short>
<short>Contains the base interface classes for widgetset controls.</short>
<descr>
<p>
This file is part of the Lazarus Component Library (<b>LCL</b>).
@ -16,7 +16,7 @@
<element name="DefBtnColors">
<short>Default colors used for button faces and button text</short>
<short>Default colors used for button faces and button text.</short>
<descr>
DefBtnColors is an array type which contains the default colors used for button faces and button text in the widgetset class.
</descr>
@ -372,7 +372,7 @@
<element name="TWSWinControl.GetPreferredSize">
<short>
Returns the preferred size of a widget, independent of current Width, Height, child controls and scrollbars
Returns the preferred size of a widget, independent of current Width, Height, child controls and scrollbars.
</short>
<descr>
<p>

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

@ -178,7 +178,7 @@
<!-- procedure Visibility: public -->
<element name="TCustomXMLPropStorage.StorageNeeded">
<short>Ask the underlying storage object for an entry</short>
<short>Ask the underlying storage object for an entry.</short>
<descr />
<errors />
<seealso />