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

Docs: Documentation updates for LCL and LazUtils. Issue #37946, patch from Don Siders.

Browse Source 
git-svn-id: trunk@64041 -
This commit is contained in:
juha 2020-10-17 19:25:36 +00:00
parent dde6f4959a
commit 8cad7c0bd0
13 changed files with 482 additions and 211 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -711,7 +711,7 @@
</element>
<element name="TFileSearcher.Create">
<short>Creates new file searcher object</short>
<short>Creates a new file searcher object</short>
<descr/>
<errors/>
<seealso/>
@ -723,16 +723,43 @@
</short>
<descr>
<p>
Searches for files in the specified path. When a matching file is found, the OnFileFound event is invoked. For directories, the OnDirectoryFound event is signalled. You can abort the search process by calling the Stop method in either of these events.
Searches for files matching a specified mask found in the specified search paths. <var>ASearchPath</var> contains the locations examined in the method, and can contain multiple path names separated by the value in <var>PathSeparator</var>. Each delimited path value in <var>ASearchPath</var> is resolved by calling the <var>ResolveDots</var> function, and processed in the method.
</p>
<p>
The value in the <var>CaseSensitive</var> argument is used to add or remove mask options for the search mask in ASearchMask. Set CaseSensitive to <b>True</b> before calling Search to perform file name comparisions with case sensitivity.
</p>
<p>
<var>ASearchSubDirs</var> includes subdirectories found in ASearchMask in the search process when set to <b>True</b>.
</p>
<p>
Set the value in <var>FileAttribute</var> to control the file attributes included in the search process. The default value (<var>faAnyFile</var>) allows all files to be considered.
</p>
<p>
Set the value in <var>DirectoryAttribute</var> to control whether directory names are included in the search process. The default value (<var>faDirectory</var>) includes directory names.
</p>
<p>
Set the value in <var>FollowSymLink</var> to indicate whether symbolic links in the file system are followed in the method.
</p>
<p>
When a matching file is found, the OnFileFound event is signalled. For directories, the OnDirectoryFound event is signalled. When a new directory is processed in the method, the OnDirectoryEnter events is signalled. Applications must assign a handler to the events to respond to the notifications. You can abort the search process by calling the Stop method in the handler for these events.
</p>
</descr>
<errors>
<p>Calls RaiseSearchingError to raise an exception if the Search method has already been called and has not completed.
</p>
</errors>
<seealso>
<link id="TFileSearcher.OnFileFound"/>
<link id="TFileSearcher.OnDirectoryFound"/>
<link id="TFileSearcher.OnDirectoryEnter"/>
<link id="TFileSearcher.FileAttribute"/>
<link id="TFileSearcher.DirectoryAttribute"/>
<link id="TFileSearcher.FollowSymLink"/>
<link id="TFileSearcher.PathSeparator"/>
<link id="TFileSearcher.MaskSeparator"/>
<link id="TFileIterator.Stop"/>
</seealso>
</element>
<element name="TFileSearcher.Search.ASearchPath">
<short>Base path for searching files</short>
</element>
@ -740,7 +767,7 @@
<short>Mask used to determine file names that match in the search</short>
</element>
<element name="TFileSearcher.Search.ASearchSubDirs">
<short>Indicates if sub directories are searched recursively</short>
<short>Indicates if subdirectories are searched recursively</short>
</element>
<element name="TFileSearcher.Search.CaseSensitive">
<short>Indicates if file names are compared using case sensitivity</short>

195
docs/xml/lazutils/lazcollections.xml
View File

@ -153,7 +153,107 @@
</seealso>
</element>
<!-- generic class Visibility: default -->
<element name="TLazFifoQueue">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.FList"/>
<element name="TLazFifoQueue.FQueueSize"/>
<element name="TLazFifoQueue.FTotalItemsPopped"/>
<element name="TLazFifoQueue.FTotalItemsPushed"/>
<element name="TLazFifoQueue.GetIsEmpty">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.GetIsEmpty.Result">
<short/>
</element>
<element name="TLazFifoQueue.GetIsFull">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.GetIsFull.Result">
<short/>
</element>
<element name="TLazFifoQueue.Create">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.Create.AQueueDepth">
<short/>
</element>
<element name="TLazFifoQueue.Grow">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.Grow.ADelta">
<short/>
</element>
<element name="TLazFifoQueue.PushItem">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.PushItem.Result">
<short/>
</element>
<element name="TLazFifoQueue.PushItem.AItem">
<short/>
</element>
<element name="TLazFifoQueue.PopItem">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.PopItem.Result">
<short/>
</element>
<element name="TLazFifoQueue.PopItem.AItem">
<short/>
</element>
<element name="TLazFifoQueue.QueueSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.TotalItemsPopped">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.TotalItemsPushed">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.IsEmpty">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazFifoQueue.IsFull">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue">
<short>
Implements a thread-safe FIFO queue for items of a generic type
@ -179,18 +279,48 @@
</seealso>
</element>
<element name="TLazThreadedQueue.TLazTypedFifoQueue">
<short/>
<descr/>
<seealso/>
</element>
<!-- variable Visibility: private -->
<element name="TLazThreadedQueue.FMonitor"/>
<element name="TLazThreadedQueue.FList"/>
<element name="TLazThreadedQueue.FFifoQueue"/>
<element name="TLazThreadedQueue.FPushTimeout"/>
<element name="TLazThreadedQueue.FPopTimeout"/>
<element name="TLazThreadedQueue.FQueueSize"/>
<element name="TLazThreadedQueue.FTotalItemsPopped"/>
<element name="TLazThreadedQueue.FTotalItemsPushed"/>
<element name="TLazThreadedQueue.FHasRoomEvent"/>
<element name="TLazThreadedQueue.FHasItemEvent"/>
<element name="TLazThreadedQueue.FShutDown"/>
<element name="TLazThreadedQueue.GetQueueSize">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.GetQueueSize.Result">
<short/>
</element>
<element name="TLazThreadedQueue.GetTotalItemsPopped">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.GetTotalItemsPopped.Result">
<short/>
</element>
<element name="TLazThreadedQueue.GetTotalItemsPushed">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.GetTotalItemsPushed.Result">
<short/>
</element>
<element name="TLazThreadedQueue.TryPushItem">
<short>Tries to add the specified item to the queue</short>
<descr>
@ -224,7 +354,60 @@
<short>Item removed from the queue in the method</short>
</element>
<!-- constructor Visibility: public -->
<element name="TLazThreadedQueue.TryPushItemUnprotected">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.TryPushItemUnprotected.Result">
<short/>
</element>
<element name="TLazThreadedQueue.TryPushItemUnprotected.AItem">
<short/>
</element>
<element name="TLazThreadedQueue.TryPopItemUnprotected">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.TryPopItemUnprotected.Result">
<short/>
</element>
<element name="TLazThreadedQueue.TryPopItemUnprotected.AItem">
<short/>
</element>
<element name="TLazThreadedQueue.Lock">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.Unlock">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.CreateFifoQueue">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.CreateFifoQueue.Result">
<short/>
</element>
<element name="TLazThreadedQueue.CreateFifoQueue.AQueueDepth">
<short/>
</element>
<element name="TLazThreadedQueue.FifoQueue">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazThreadedQueue.Create">
<short>Constructor for the class instance</short>
<descr>

9
docs/xml/lazutils/lazlogger.xml
View File

@ -219,6 +219,15 @@
<short></short>
</element>
<element name="DbgSTime">
<short/>
<descr/>
<seealso/>
</element>
<element name="DbgSTime.Result">
<short/>
</element>
<element name="dbgMemRange">
<short></short>
<descr></descr>

17
docs/xml/lazutils/lazloggerbase.xml
View File

@ -13,6 +13,14 @@
<descr>
</descr>
<!-- unresolved externals -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="Types"/>
<element name="Math"/>
<element name="LazClasses"/>
<element name="LazUTF8"/>
<!-- enumeration type Visibility: default -->
<element name="TLazLoggerLogGroupFlag">
<short></short>
@ -2187,6 +2195,15 @@
<short></short>
</element>
<element name="DbgSTime">
<short/>
<descr/>
<seealso/>
</element>
<element name="DbgSTime.Result">
<short/>
</element>
<!-- function Visibility: default -->
<element name="dbgMemRange">
<short></short>

145
docs/xml/lazutils/lazloggerdummy.xml
View File

@ -13,6 +13,13 @@
<descr>
</descr>
<!-- unresolved externals -->
<element id="Classes"/>
<element id="SysUtils"/>
<element id="FileUtil"/>
<element id="Types"/>
<element id="LazClasses"/>
<!-- enumeration type Visibility: default -->
<element name="TLazLoggerLogGroupFlag">
<short></short>
@ -21,18 +28,13 @@
<seealso>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLazLoggerLogGroupFlag.lgfAddedByParamParser">
<short></short>
</element>
<!-- enumeration value Visibility: default -->
<element name="TLazLoggerLogGroupFlag.lgfNoDefaultEnabledSpecified">
<short></short>
</element>
<!-- set type Visibility: default -->
<element name="TLazLoggerLogGroupFlags">
<short></short>
<descr>
@ -41,7 +43,6 @@
</seealso>
</element>
<!-- record type Visibility: default -->
<element name="TLazLoggerLogGroup">
<short></short>
<descr>
@ -50,7 +51,6 @@
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLazLoggerLogGroup.ConfigName">
<short></short>
<descr>
@ -59,7 +59,6 @@
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLazLoggerLogGroup.Enabled">
<short></short>
<descr>
@ -68,7 +67,6 @@
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLazLoggerLogGroup.Flags">
<short></short>
<descr>
@ -77,7 +75,6 @@
</seealso>
</element>
<!-- variable Visibility: default -->
<element name="TLazLoggerLogGroup.FOpenedIndents">
<short></short>
<descr>
@ -86,7 +83,6 @@
</seealso>
</element>
<!-- pointer type Visibility: default -->
<element name="PLazLoggerLogGroup">
<short></short>
<descr>
@ -95,7 +91,6 @@
</seealso>
</element>
<!-- procedure type Visibility: default -->
<element name="TLazLoggerWriteEvent">
<short></short>
<descr>
@ -103,23 +98,16 @@
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TLazLoggerWriteEvent.Sender">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TLazLoggerWriteEvent.S">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="TLazLoggerWriteEvent.Handled">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="DebuglnStack">
<short></short>
<descr>
@ -129,13 +117,10 @@
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="DebuglnStack.s">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="DbgOut">
<short></short>
<descr>
@ -145,214 +130,131 @@
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.Args">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s1">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s2">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s3">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s4">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s5">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s6">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s7">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s8">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s9">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s10">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s11">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s12">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s13">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s14">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s15">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s16">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s17">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DbgOut.s18">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="DebugLn">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.Args">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s1">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s2">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s3">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s4">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s5">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s6">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s7">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s8">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s9">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s10">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s11">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s12">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s13">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s14">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s15">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s16">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s17">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="DebugLn.s18">
<short></short>
</element>
@ -778,18 +680,22 @@
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="dbghex.Result">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="dbghex.i">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="DbgSTime">
<short/>
<descr/>
<seealso/>
</element>
<element name="DbgSTime.Result">
<short/>
</element>
<element name="dbgMemRange">
<short></short>
<descr>
@ -846,7 +752,24 @@
<short></short>
</element>
<!-- class Visibility: default -->
<element name="TLazLoggerBlockHandler">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerBlockHandler.IncreaseIndent">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerBlockHandler.DecreaseIndent">
<short/>
<descr/>
<seealso/>
</element>
<element name="TLazLoggerLogGroupList">
<short></short>
<descr>

76
docs/xml/lcl/comboex.xml
View File

@ -50,7 +50,7 @@
<short>Enables auto suggest</short>
</element>
<element name="TAutoCompleteOption.acoAutoAppend">
<short>Enables auto appending items to the combo box box</short>
<short>Enables auto appending items to the combo-box</short>
</element>
<element name="TAutoCompleteOption.acoSearch">
<short>Enables searching items for the current value in the edit control</short>
@ -93,7 +93,7 @@
<var>TComboBoxExStyle</var> is an enumerated type with values representing the display styles available in <var>TCustomComboBoxEx</var>. TComboBoxExStyle is the type used to implement the <var>Style</var> property in <var>TCustomComboBoxEx</var> and <var>TComboBoxEx</var>.
</p>
<p>
TComboBoxExStyle replaces the values used in the ancestor class; there is no need for the various owner-drawn styles from the ancestor control. The extended combo box controls are always owner-drawn using the fixed style in its <var>DrawItem</var> method.
TComboBoxExStyle replaces the values used in the ancestor class; there is no need for the various owner-drawn styles from the ancestor control. The extended combo-box controls are always owner-drawn using the fixed style in its <var>DrawItem</var> method.
</p>
</descr>
<seealso>
@ -492,10 +492,10 @@
<short>Space reserved between the Image and the caption for the item</short>
<descr>
<p>
The default value for the property is <b>-1</b> and indicates that indent spacing is not used for the Combo Box item. The value is assigned when the <var>AddItem</var> method in <var>TComboExItems</var> is used to create the item using the parameter value passed to the method. Changing the value for the property causes the <var>Changed</var> method to be called to update the current item.
The default value for the property is <b>-1</b> and indicates that indent spacing is not used for the Combo-Box item. The value is assigned when the <var>AddItem</var> method in <var>TComboExItems</var> is used to create the item using the parameter value passed to the method. Changing the value for the property causes the <var>Changed</var> method to be called to update the current item.
</p>
<p>
The value in Indent is used when the <var>DrawItem</var> method in <var>TCustomComboBoxEx</var> is called to render an extended item in the Combo Box.
The value in Indent is used when the <var>DrawItem</var> method in <var>TCustomComboBoxEx</var> is called to render an extended item in the Combo-Box.
</p>
</descr>
<seealso>
@ -506,7 +506,7 @@
<element name="TComboExItem.OverlayImageIndex">
<short>
Ordinal position for the image drawn as an overlay for the Image in the combo box item
Ordinal position for the image drawn as an overlay for the Image in the combo-box item
</short>
<descr>
<p>
@ -522,7 +522,7 @@
<element name="TComboExItem.SelectedImageIndex">
<short>
Ordinal position for the image drawn when the item is selected in the Combo Box
Ordinal position for the image drawn when the item is selected in the Combo-Box
</short>
<descr/>
<seealso></seealso>
@ -971,14 +971,14 @@
<element name="TCustomComboBoxEx">
<short>
Implements the base class for an extended/enhanced combo box
Implements the base class for an extended/enhanced combo-box
</short>
<descr>
<p>
<var>TCustomComboBoxEx</var> is a <var>TCustomComboBox</var> descendant which implements the base class for <var>TComboBoxEx</var>.
</p>
<p>
TCustomComboBoxEx provides an extended combo box with added features and capabilities like auto completion, additional display styles, more editing options, and a list with Images used in the control. Another key feature in the class is an extended Items property which provides normal, selected, and overlay image indexes and allows indentation between the image and caption for items in the combo box. A pointer to arbitrary data for Items used in sort operations is also provided.
TCustomComboBoxEx provides an extended combo-box with added features and capabilities like auto completion, additional display styles, more editing options, and a list with Images used in the control. Another key feature in the class is an extended Items property which provides normal, selected, and overlay image indexes and allows indentation between the image and caption for items in the combo-box. A pointer to arbitrary data for Items used in sort operations is also provided.
</p>
</descr>
<seealso>
@ -1069,7 +1069,7 @@
</element>
<element name="TCustomComboBoxEx.FTextHeight">
<short>Internal derived text height for an item in the combo box</short>
<short>Internal derived text height for an item in the combo-box</short>
<descr/>
<seealso></seealso>
</element>
@ -1089,7 +1089,7 @@
<short>Draws an item in the control</short>
<descr>
<p>
<var>DrawItem</var> is an overridden procedure used to draw an item in the extended combo box control.
<var>DrawItem</var> is an overridden procedure used to draw an item in the extended combo-box control.
</p>
<p>
Index contains the ordinal position for the TComboExItem instance in ItemsEx that is drawn in the method.
@ -1101,7 +1101,7 @@
<var>State</var> contains the owner draw state used to render the item, and determines the window, border, and font colors for the control.
</p>
<p>
DrawItem uses <var>ThemeServices</var> to get theme details applied to enabled items in the combo box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the item.
DrawItem uses <var>ThemeServices</var> to get theme details applied to enabled items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the item.
</p>
<p>
When <var>Images</var> have been assigned for the control, the image index appropriate to the value in State is determined. The value <var>odSelected</var> causes the <var>SelectedImageIndex</var> for the item is be used. Otherwise, the <var>ImageIndex</var> for the item is used.
@ -1216,11 +1216,11 @@
<element name="TCustomComboBoxEx.Add">
<short>
Adds a new item to the extended combo box control
Adds a new item to the extended combo-box control
</short>
<descr>
<p>
<var>Add</var> is an overloaded method used to add a new item to the extended combo box control. Both procedure and function variants are provided.
<var>Add</var> is an overloaded method used to add a new item to the extended combo-box control. Both procedure and function variants are provided.
</p>
<p>
The function variant accepts no arguments, and returns an Integer value with the ordinal position in ItemsEx where the new item was inserted. The caption for the new item is set to the TComboExItem.cDefCaption constant.
@ -1254,7 +1254,7 @@
<short>Adds the specified item and object instance to the control</short>
<descr>
<p>
<var>AddItem</var> is a procedure used to create a new item in the extended combo box control with the specified caption and object data. <var>Item</var> contains the caption assigned to the new <var>TComboExItem</var> instance. AnObject is an object with the data stored in the new TComboExItem instance.
<var>AddItem</var> is a procedure used to create a new item in the extended combo-box control with the specified caption and object data. <var>Item</var> contains the caption assigned to the new <var>TComboExItem</var> instance. AnObject is an object with the data stored in the new TComboExItem instance.
</p>
<p>
AddItem calls <var>Insert</var> to create, update, and store the item in the <var>ItemsEx</var> property.
@ -1352,19 +1352,19 @@
<short>Ordinal position where the new item is stored</short>
</element>
<element name="TCustomComboBoxEx.Insert.ACaption">
<short>Caption for the new combo box item</short>
<short>Caption for the new combo-box item</short>
</element>
<element name="TCustomComboBoxEx.Insert.AIndent">
<short>Indent spacing for the new combo box item</short>
<short>Indent spacing for the new combo-box item</short>
</element>
<element name="TCustomComboBoxEx.Insert.AImgIdx">
<short>Image index for the new combo box item</short>
<short>Image index for the new combo-box item</short>
</element>
<element name="TCustomComboBoxEx.Insert.AOverlayImgIdx">
<short>Overlay image index for the new combo box item</short>
<short>Overlay image index for the new combo-box item</short>
</element>
<element name="TCustomComboBoxEx.Insert.ASelectedImgIdx">
<short>Selected image index for the new combo box item</short>
<short>Selected image index for the new combo-box item</short>
</element>
<element name="TCustomComboBoxEx.AutoCompleteOptions">
@ -1385,7 +1385,7 @@
<short>Specifies the width for images displayed in the control</short>
<descr>
<p>
<var>ImagesWidth</var> is an <var>Integer</var> property used to specify the width for <var>Images</var> displayed in the extended combo box control. The property value is the image size used at the design-time display density (PPI). The value may be adjusted in the <var>DrawItem</var> method to a scaled value relative to the PPI setting for the current <var>Font</var> in the control. The scaled value determines the image resolution requested when accessing the Images assigned for the control.
<var>ImagesWidth</var> is an <var>Integer</var> property used to specify the width for <var>Images</var> displayed in the extended combo-box control. The property value is the image size used at the design-time display density (PPI). The value may be adjusted in the <var>DrawItem</var> method to a scaled value relative to the PPI setting for the current <var>Font</var> in the control. The scaled value determines the image resolution requested when accessing the Images assigned for the control.
</p>
<p>
The default value for the property is zero (<b>0</b>) and indicates that an explicit value has not been assigned for the property.
@ -1408,7 +1408,7 @@
</short>
<descr>
<p>
<var>ItemsEx</var> is a <var>TComboExItems</var> property which provides access to the extended items defined for the combo box control. ItemsEx uses <var>TComboExItem</var> as the <var>ItemClass</var> for the collection. The collection is maintained using the <var>Add</var>, <var>AddItem</var>, <var>Delete</var>, <var>DeleteSelected</var>, and <var>Clear</var> methods. Use <var>AssignItemsEx</var> to set the values in the collection to the values from a specific source.
<var>ItemsEx</var> is a <var>TComboExItems</var> property which provides access to the extended items defined for the combo-box control. ItemsEx uses <var>TComboExItem</var> as the <var>ItemClass</var> for the collection. The collection is maintained using the <var>Add</var>, <var>AddItem</var>, <var>Delete</var>, <var>DeleteSelected</var>, and <var>Clear</var> methods. Use <var>AssignItemsEx</var> to set the values in the collection to the values from a specific source.
</p>
<p>
Values in ItemsEx are used in the <var>DrawItem</var> method to render the item(s) using the theme details for the control.
@ -1428,7 +1428,7 @@
<element name="TCustomComboBoxEx.Style">
<short>
Specifies the control style used for the edit in the combo box control
Specifies the control style used for the edit in the combo-box control
</short>
<descr>
<p>
@ -1451,11 +1451,11 @@
<element name="TCustomComboBoxEx.StyleEx">
<short>
Enables feature or behaviors in the extended combo box control
Enables feature or behaviors in the extended combo-box control
</short>
<descr>
<p>
<var>StyleEx</var> is a <var>TComboBoxExStyles</var> property used to store <var>TComboBoxExStyleEx</var> values which enable features in the extended combo box control. Including a value from the enumeration enables the corresponding feature or behavior in the control. See <link id="TComboBoxExStyleEx"/> for more information on the enumeration values and their meanings.
<var>StyleEx</var> is a <var>TComboBoxExStyles</var> property used to store <var>TComboBoxExStyleEx</var> values which enable features in the extended combo-box control. Including a value from the enumeration enables the corresponding feature or behavior in the control. See <link id="TComboBoxExStyleEx"/> for more information on the enumeration values and their meanings.
</p>
<p>
The default value for the property is an empty set ([]).
@ -1468,7 +1468,7 @@
</element>
<element name="TComboBoxEx" link="#lcl.comboex.TCustomComboBoxEx">
<short>Implements an extended Combo Box component</short>
<short>Implements an extended combo-box component</short>
<descr></descr>
<seealso>
<link id="TCustomComboBoxEx"/>
@ -1605,7 +1605,7 @@
<element name="TCustomCheckCombo">
<short>
Implements the base class for a combo box which displays checkboxes for items in the control
Implements the base class for a combo-box which displays checkboxes for items in the control
</short>
<descr></descr>
<seealso></seealso>
@ -1879,7 +1879,7 @@
<element name="TCustomCheckCombo.DrawItem">
<short>
Draws a checkbox item defined in the combo box control
Draws a checkbox item defined in the combo-box control
</short>
<descr>
<p>
@ -1895,7 +1895,7 @@
<var>State</var> contains the owner draw state used to render the checkbox item, and determines the window and font colors for the checkbox.
</p>
<p>
DrawItem uses <var>ThemeServices</var> to get theme element details applied to checkbox items in the combo box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the check box.
DrawItem uses <var>ThemeServices</var> to get theme element details applied to checkbox items in the combo-box. DrawItem ensures that a valid text height is available for the control <var>Canvas</var>, and is used to draw the text for the check box.
</p>
<p>
DrawItem configures the Canvas to use the brush style and font color needed for the value in State. Text drawing flags are derived for the item, and the text is rendered by calling the <var>DrawText</var> method in ThemeServices.
@ -1917,10 +1917,10 @@
</element>
<element name="TCustomCheckCombo.DropDown" link="#lcl.StdCtrls.TCustomComboBox.DropDown">
<short>Displays the drop down for the combo box</short>
<short>Displays the drop down for the combo-box</short>
<descr>
<p>
<var>DropDown</var> is an overridden method used to display the drop down for the combo box if it is not already visible. DropDown calls the inherited method to trigger the <var>OnDropDown</var> method (when assigned). When the drop down is already visible, the value in an enabled at <var>ItemIndex</var> is <var>Toggle</var>d.
<var>DropDown</var> is an overridden method used to display the drop down for the combo-box if it is not already visible. DropDown calls the inherited method to trigger the <var>OnDropDown</var> method (when assigned). When the drop down is already visible, the value in an enabled at <var>ItemIndex</var> is <var>Toggle</var>d.
</p>
</descr>
<seealso>
@ -2012,7 +2012,7 @@
<short>Handles key down events for the control</short>
<descr>
<p>
<var>KeyDown</var> is the overridden method used to handle key down events for the control. KeyDown ensures that Return (<var>VK_RETURN</var>) and Space (<var>VK_SPACE</var>) are applied to the control. Return causes the value for an enabled item to be toggled when highlighted. Space also toggles the value in an enabled checkbox, and makes the item selected before hiding the drop down for the combo box.
<var>KeyDown</var> is the overridden method used to handle key down events for the control. KeyDown ensures that Return (<var>VK_RETURN</var>) and Space (<var>VK_SPACE</var>) are applied to the control. Return causes the value for an enabled item to be toggled when highlighted. Space also toggles the value in an enabled checkbox, and makes the item selected before hiding the drop down for the combo-box.
</p>
<p>
KeyDown calls the inherited method.
@ -2098,13 +2098,13 @@
<short>Toggles the value for the current item selected in the control</short>
<descr>
<p>
<var>Select</var> is an overridden procedure used to toggle the value for the current item in the combo box. Select calls the inherited method.
<var>Select</var> is an overridden procedure used to toggle the value for the current item in the combo-box. Select calls the inherited method.
</p>
<p>
For the Windows platform, the value for the selection cannot be changed if the combo box is not in a dropped down state. This can be achieved in code by calling the <var>DropDown</var> method.
For the Windows platform, the value for the selection cannot be toggled if the combo-box is already in a dropped-down state (when the <var>DropDown</var> method has been called).
</p>
<p>
Select calls the <var>Toggle</var> method using the value in <var>ItemIndex</var> as the affected checkbox item. The internal flag used to track drop down state is reset prior to exiting from the method.
Select calls the <var>Toggle</var> method using the value in <var>ItemIndex</var> as the affected checkbox item. The internal flag used to track drop down state is reset prior to exiting from the method. Toggle is not called when ItemIndex contains a negative value, or when the item at the position in ItemIndex is not enabled.
</p>
<p>
Alternatively, you can use the <var>Checked</var> property to assign an explicit <var>Boolean</var> value for the checkbox in ItemIndex.
@ -2305,10 +2305,10 @@
</short>
<descr>
<p>
<var>Checked</var> is an indexed <var>Boolean</var> property which provides access to the checked state for a checkbox item defined in the control. AIndex specifies the ordinal position in Items for the checkbox. Checked uses the value from the TCheckComboItemState object stored in the Items property. True indicates that TCheckComboItemState.Checked contains the value cbChecked. False indicates that it contains the value cbUnchecked.
<var>Checked</var> is an indexed <var>Boolean</var> property which provides access to the checked state for a checkbox item defined in the control. <var>AIndex</var> specifies the ordinal position in Items for the checkbox. Checked uses the value from the <var>TCheckComboItemState</var> object stored in the <var>Items</var> property. <b>True</b> indicates that TCheckComboItemState.Checked contains the value <var>cbChecked</var>. <b>False</b> indicates that it contains the value <var>cbUnchecked</var>.
</p>
<p>
Changing the value for the property causes the OnItemChange event handler to be signalled, and the Invalidate method is called when AIndex is also the selected ItemIndex for the control.
Changing the value for the property causes the <var>OnItemChange</var> event handler to be signalled, and the <var>Invalidate</var> method is called when <var>AIndex</var> is also the selected <var>ItemIndex</var> for the control.
</p>
</descr>
<seealso>
@ -2393,7 +2393,7 @@
</element>
<element name="TCheckComboBox" link="#lcl.comboex.TCustomCheckCombo">
<short>Custom combo box which displays checkboxes for the items in the control</short>
<short>Custom combo-box which displays checkboxes for the items in the control</short>
<descr/>
<seealso/>
</element>
@ -2466,7 +2466,7 @@
<short>Registers components for use in the Lazarus IDE</short>
<descr>
<p>
<var>Register</var> is a procedure used to register components in the <file>comboex.pas</file> unit for use in the Lazarus IDE. Register adds the <var>TComboBoxEx</var> and <var>TCheckComboBox</var> components to the <b>Misc</b> tab in the Lazarus IDE.
<var>Register</var> is a procedure used to register components in the <file>comboex.pas</file> unit for use in the Lazarus IDE. Register adds the <var>TComboBoxEx</var> and <var>TCheckComboBox</var> components to the <b>Misc</b> tab in the Lazarus IDE.
</p>
</descr>
<seealso/>

45
docs/xml/lcl/customtimer.xml
View File

@ -10,24 +10,14 @@
<short>Contains the definition of the base class for <var>TTimer</var></short>
<descr/>
<!-- unresolved external references -->
<element name="Classes">
<short/>
</element>
<element name="SysUtils">
<short/>
</element>
<element name="LCLStrConsts">
<short/>
</element>
<element name="LCLType">
<short/>
</element>
<element name="InterfaceBase">
<short/>
</element>
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LCLProc"/>
<element name="LCLStrConsts"/>
<element name="LCLType"/>
<element name="InterfaceBase"/>
<element name="CustApp"/>
<!-- object Visibility: default -->
<element name="TCustomTimer">
<short>
Defines the base class for <var>TTimer</var>
@ -59,7 +49,6 @@
</seealso>
</element>
<!-- variable Visibility: private -->
<element name="TCustomTimer.FInterval"/>
<element name="TCustomTimer.FOnStartTimer"/>
<element name="TCustomTimer.FOnStopTimer"/>
@ -67,7 +56,6 @@
<element name="TCustomTimer.FOnTimer"/>
<element name="TCustomTimer.FEnabled"/>
<!-- procedure Visibility: private -->
<element name="TCustomTimer.Timer">
<short>
Procedure called when the timer interval has elapsed
@ -77,7 +65,10 @@
<var>Timer</var> is a private procedure called when the <var>Interval</var> for the timer has elapsed. Timer calls the <var>DoOnTimer</var> method to perform a notification using the <var>OnTimer</var> event (when assigned). Assign a procedure to the <var>OnTimer</var> event handler to perform actions needed when the <var>Interval</var> for the timer has elapsed.
</p>
<p>
The <var>Timer</var> procedure is passed as an argument when the timer handle is created in the underlying widget set for the platform or OS in the UpdateTimer method.
If an exception occurs in DoOnTimer, the <var>HandleException</var> method in the <var>CustomApplication</var> singleton is called.
</p>
<p>
The <var>Timer</var> procedure is passed as an argument when the timer handle is created for the widget set in its UpdateTimer method.
</p>
<remark>
Please note that the <var>OnTimer</var> event notification is not performed when <var>Enabled</var> contains <b>False</b> or when <var>Interval</var> contains the value <b>0</b> (<b>zero</b>).
@ -88,6 +79,8 @@
<link id="TCustomTimer.Enabled"/>
<link id="TCustomTimer.Interval"/>
<link id="TCustomTimer.UpdateTimer"/>
<link id="#fcl.CustApp.TCustomApplication.HandleException"/>
<link id="#fcl.CustApp.CustomApplication"/>
</seealso>
</element>
<element name="TCustomTimer.SetEnabled">
@ -117,7 +110,6 @@
<element name="TCustomTimer.SetOnTimer.Value">
<short><var>TNotifyEvent</var> handler signalled when the timer has expired</short>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.DoOnTimer">
<short><var>DoOnTimer</var> signals the <var>OnTimer</var> event handler</short>
<descr>
@ -143,7 +135,6 @@
<link id="TCustomTimer.Interval"/>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.UpdateTimer">
<short>Updates the Timer to reflect the current properties</short>
<descr>
@ -174,7 +165,6 @@
<link id="TCustomTimer.Loaded"/>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.KillTimer">
<short>Stops execution of the timer class instance</short>
<descr>
@ -191,9 +181,7 @@
<link id="TCustomTimer.Destroy"/>
</seealso>
</element>
<!-- procedure Visibility: protected -->
<element name="TCustomTimer.Loaded" link="#rtl.Classes.TComponent.Loaded"/>
<!-- constructor Visibility: public -->
<element name="TCustomTimer.Create">
<short>
<var>Create</var> - constructor for <var>TCustomTimer</var>: calls inherited <var>Create</var>, sets up handle and initializes timer interval</short>
@ -219,11 +207,9 @@
<link id="TCustomTimer.OnTimer"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="TCustomTimer.Create.AOwner">
<short>Component which owns the timer class instance</short>
</element>
<!-- destructor Visibility: public -->
<element name="TCustomTimer.Destroy">
<short>Destructor for the timer class instance</short>
<descr>
@ -246,7 +232,6 @@
<link id="TCustomTimer.OnStopTimer"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Enabled">
<short>Indicates if the timer is ready to start</short>
<descr>
@ -264,7 +249,6 @@
<link id="TCustomTimer.OnTimer"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.Interval">
<short>The <var>Interval</var> (in milliseconds) for timer notifications</short>
<descr>
@ -289,7 +273,6 @@
<link id="TCustomTimer.OnTimer"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnTimer">
<short>Event handler signalled when the Interval for the timer has elapsed</short>
<descr>
@ -317,7 +300,6 @@
<link id="TCustomTimer.UpdateTimer"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStartTimer">
<short>Event handler signalled when the timer is started</short>
<descr>
@ -344,7 +326,6 @@
<link id="TCustomTimer.OnTimer"/>
</seealso>
</element>
<!-- property Visibility: published -->
<element name="TCustomTimer.OnStopTimer">
<short>
<var>OnStopTimer</var> - event handler for stopping the timer</short>

8
docs/xml/lcl/editbtn.xml
View File

@ -1344,10 +1344,11 @@
<element name="TCustomControlFilterEdit.OnButtonClick" link="#lcl.editbtn.TCustomEditButton.OnButtonClick"/>
<element name="TCustomControlFilterEdit.OnChange" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnChange"/>
<element name="TCustomControlFilterEdit.OnClick" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnClick"/>
<element name="TCustomControlFilterEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TCustomControlFilterEdit.OnDblClick" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnDblClick"/>
<element name="TCustomControlFilterEdit.OnDragDrop" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnDragDrop"/>
<element name="TCustomControlFilterEdit.OnDragOver" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnDragOver"/>
<element name="TCustomControlFilterEdit.OnEditingDone" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnEditingDone"/>
<element name="TCustomControlFilterEdit.OnEditingDone" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnEditingDone"/>
<element name="TCustomControlFilterEdit.OnEndDrag" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnEndDrag"/>
<element name="TCustomControlFilterEdit.OnEnter" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnEnter"/>
<element name="TCustomControlFilterEdit.OnExit" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnExit"/>
@ -1800,6 +1801,7 @@
<element name="TFileNameEdit.OnButtonClick" link="#lcl.editbtn.TCustomEditButton.OnButtonClick"/>
<element name="TFileNameEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange"/>
<element name="TFileNameEdit.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TFileNameEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TFileNameEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TFileNameEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TFileNameEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
@ -2123,6 +2125,7 @@
<element name="TDirectoryEdit.OnButtonClick" link="#lcl.editbtn.TCustomEditButton.OnButtonClick"/>
<element name="TDirectoryEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange"/>
<element name="TDirectoryEdit.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TDirectoryEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TDirectoryEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TDirectoryEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TDirectoryEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>
@ -2665,6 +2668,7 @@
<element name="TDateEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange"/>
<element name="TDateEdit.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds"/>
<element name="TDateEdit.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TDateEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TDateEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TDateEdit.OnEditingDone" link="#LCL.Controls.TControl.OnEditingDone"/>
<element name="TDateEdit.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
@ -3010,6 +3014,7 @@
<element name="TTimeEdit.OnChangeBounds" link="#LCL.Controls.TControl.OnChangeBounds"/>
<element name="TTimeEdit.OnClick" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnClick"/>
<element name="TTimeEdit.OnDblClick" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnDblClick"/>
<element name="TTimeEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TTimeEdit.OnEditingDone" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnEditingDone"/>
<element name="TTimeEdit.OnEnter" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnEnter"/>
<element name="TTimeEdit.OnExit" link="#LCL.GroupedEdit.TCustomAbstractGroupedEdit.OnExit"/>
@ -3295,6 +3300,7 @@
<element name="TCalcEdit.OnButtonClick" link="#lcl.editbtn.TCustomEditButton.OnButtonClick"/>
<element name="TCalcEdit.OnChange" link="#LCL.StdCtrls.TCustomEdit.OnChange"/>
<element name="TCalcEdit.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TCalcEdit.OnContextPopup" link="#lcl.groupededit.TCustomAbstractGroupedEdit.OnContextPopup"/>
<element name="TCalcEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TCalcEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TCalcEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>

40
docs/xml/lcl/extctrls.xml
View File

@ -2941,6 +2941,8 @@
<element name="TCustomRadioGroup.FItems"/>
<element name="TCustomRadioGroup.FLastClickedItemIndex"/>
<element name="TCustomRadioGroup.FOnClick"/>
<element name="TCustomRadioGroup.FOnItemEnter"/>
<element name="TCustomRadioGroup.FOnItemExit"/>
<element name="TCustomRadioGroup.FOnSelectionChanged"/>
<element name="TCustomRadioGroup.FReading"/>
<element name="TCustomRadioGroup.FUpdatingItems"/>
@ -2975,7 +2977,6 @@
<element name="TCustomRadioGroup.ItemEnter" link="#LCL.Controls.TWinControl.DoEnter">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TCustomRadioGroup.ItemEnter.Sender">
@ -2985,7 +2986,6 @@
<element name="TCustomRadioGroup.ItemExit" link="#LCL.Controls.TWinControl.DoExit">
<short/>
<descr/>
<errors/>
<seealso/>
</element>
<element name="TCustomRadioGroup.ItemExit.Sender">
@ -3387,6 +3387,40 @@
</seealso>
</element>
<element name="TCustomRadioGroup.OnItemEnter">
<short>Event handler signalled when a radio button in the group receives focus</short>
<descr>
<p>
<var>OnItemEnter</var> is a <var>TNotifyEvent</var> property that implements the event handler signalled when a radio button in the group receives focus. An application must implement and assign an object procedure to the property to respond to the event notification.
</p>
<p>
OnItemEnter is signalled from the <var>ItemEnter</var> method (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomRadioGroup.ItemEnter"/>
<link id="TCustomRadioGroup.UpdateItems"/>
<link id="#lcl.stdctrls.TRadioButton.OnEnter"/>
</seealso>
</element>
<element name="TCustomRadioGroup.OnItemExit">
<short>Event handler signalled when a radio button in the group loses focus</short>
<descr>
<p>
OnItemExit is a TNotifyEvent property which implements an event handler signalled when a radio button in the group loses focus. An application must implement and assign an object procedure to the property to respond to the event notification.
</p>
<p>
OnItemExit is signalled from the <var>ItemExit</var> method (when assigned).
</p>
</descr>
<seealso>
<link id="TCustomRadioGroup.ItemExit"/>
<link id="TCustomRadioGroup.UpdateItems"/>
<link id="#lcl.stdctrls.TRadioButton.OnExit"/>
</seealso>
</element>
<element name="TCustomRadioGroup.OnSelectionChanged">
<short>Event called when the selected item changes</short>
<descr>
@ -3477,6 +3511,8 @@
<element name="TRadioGroup.OnEndDrag" link="#LCL.Controls.TControl.OnEndDrag"/>
<element name="TRadioGroup.OnEnter" link="#LCL.Controls.TWinControl.OnEnter"/>
<element name="TRadioGroup.OnExit" link="#LCL.Controls.TWinControl.OnExit"/>
<element name="TRadioGroup.OnItemEnter" link="#lcl.extctrls.TCustomRadioGroup.OnItemEnter"/>
<element name="TRadioGroup.OnItemExit" link="#lcl.extctrls.TCustomRadioGroup.OnItemExit"/>
<element name="TRadioGroup.OnKeyDown" link="#LCL.Controls.TWinControl.OnKeyDown"/>
<element name="TRadioGroup.OnKeyPress" link="#LCL.Controls.TWinControl.OnKeyPress"/>
<element name="TRadioGroup.OnKeyUp" link="#LCL.Controls.TWinControl.OnKeyUp"/>

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

@ -131,6 +131,21 @@
<element name="TPreviewFileDialog.FPreviewFileControl"/>
<element name="TPreviewFileDialog.GetPreviewFileControl">
<short>Gets the value for the PreviewFileControl property</short>
<descr>
<p>
Calls <var>CreatePreviewControl</var> if a <var>TPreviewFileControl</var> instance has not already been created for the dialog.
</p>
</descr>
<seealso>
<link id="TPreviewFileDialog.PreviewFileControl"/>
</seealso>
</element>
<element name="TPreviewFileDialog.GetPreviewFileControl.Result">
<short>Value for the property</short>
</element>
<element name="TPreviewFileDialog.WSRegisterClass" link="#LCL.LCLClasses.TLCLComponent.WSRegisterClass"/>
<element name="TPreviewFileDialog.CreatePreviewControl">

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

@ -2042,10 +2042,12 @@
<element name="TCustomForm.FShowInTaskbar" link="#lcl.forms.TCustomForm.ShowInTaskBar"/>
<element name="TCustomForm.FWindowState" link="#lcl.forms.TCustomForm.WindowState"/>
<element name="TCustomForm.FDelayedEventCtr"/>
<element name="TCustomForm.FDelayedWMMove"/>
<element name="TCustomForm.FDelayedWMSize"/>
<element name="TCustomForm.FDelayedOnChangeBounds"/>
<element name="TCustomForm.FDelayedOnResize"/>
<element name="TCustomForm.FIsFirstOnShow"/>
<element name="TCustomForm.FIsFirstOnActivate"/>
<element name="TCustomForm.FIsFirstRestore"/>
<element name="TCustomForm.FWindowStateChanged"/>
<element name="TCustomForm.GetClientHandle" link="#lcl.forms.TCustomForm.ClientHandle"/>
<element name="TCustomForm.GetClientHandle.Result">
<short/>
@ -2156,13 +2158,13 @@
</short>
<descr>
<p>
<var>DelayedEvent</var> are a mechanism used to reduce the number of move, resize, show, and activate messages that occur for forms and their child controls.
<var>DelayedEvent</var> is a mechanism used to reduce the number of move, resize, show, and activate messages that occur for forms and their child controls.
</p>
<p>
<var>DelayedEvent</var> discards duplicate calls to the method; only the most recent message is processed. It is used in conjunction with the <var>QueueAsyncCall</var> method in <var>TApplication</var>. DelayedEvent decrements an internal counter used to track the number of pending delayed event messages. When the counter reaches zero (0), the message is applied.
</p>
<p>
When <var>WindowState</var> is changed to <var>wsNormal</var>, the window origin or size is restored and <var>DoOnChangeBounds</var> is called. For delayed <var>WMSize</var> messages, the <var>DoOnShow</var> and/or <var>Activate</var> methods are called for the message.
When <var>WindowState</var> is changed to <var>wsNormal</var>, the window origin or size is restored for the delayed event. For delayed <var>OnChangeBounds</var> and <var>OnChangeBounds</var> messages, the <var>DoOnShow</var> and/or <var>Activate</var> methods are called for the corresponding message when the form is <var>Active</var>. If the form has not already been displayed and activated, the Activate, DoOnResize, or the DoOnChangeBounds method is called for the corresponding delayed message.
</p>
<p>
DelayedEvent is used in the implementation of the <var>WMSize</var> and <var>WMMove</var> methods.
@ -2287,10 +2289,20 @@
<link id="TCustomForm.Active"/>
</seealso>
</element>
<element name="TCustomForm.SetWindowState" link="#lcl.forms.TCustomForm.WindowState"/>
<element name="TCustomForm.SetWindowState.Value">
<short/>
<element name="TCustomForm.SetWindowState">
<short>Sets the value for the WindowState property</short>
<descr>
<p>
SetWindowState sets the value for the WindowState property.
</p>
</descr>
<seealso/>
</element>
<element name="TCustomForm.SetWindowState.Value">
<short>New value for the property</short>
</element>
<element name="TCustomForm.AddHandler">
<short>Adds a form notification handler with the specified type and code</short>
<descr>
@ -2317,7 +2329,9 @@
</p>
</descr>
<errors>
Raises a catchable exception if the Code has not been assigned for the form Handler.
<p>
Raises a catchable exception if the Code property has not been assigned for the TMethod instance in Handler. Raised with the message 'TCustomForm.AddHandler'.
</p>
</errors>
<seealso>
<link id="TCustomForm.AddHandlerClose"/>
@ -2742,6 +2756,9 @@
<dt>wsMinimized</dt>
<dd>Calls the Minimize method in Application, or Restore if the Form is already minimized</dd>
</dl>
<p>
If the value in WindowState has been changed, the method honors the value in the Position property if it was set to maximized at design-time.
</p>
<p>
When the <var>OnWindowStateChange</var> event handler has been assigned for the form, it is signalled for the current class instance.
</p>
@ -4242,7 +4259,7 @@
<link id="#LCL.Controls.TControl.DoOnChangeBounds"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomForm.ShowInTaskBar">
<short>How the form is represented in the system Task Bar</short>
<descr>
@ -4262,24 +4279,41 @@
<link id="TApplication.TaskBarBehavior"/>
</seealso>
</element>
<!-- property Visibility: public -->
<element name="TCustomForm.Visible" link="#LCL.Controls.TControl.Visible"/>
<!-- property Visibility: public -->
<element name="TCustomForm.WindowState">
<short>Whether the form is currently minimized, maximized or normal (restored).
<short>
Indicates whether the form is displayed in a minimized, maximized, fullscreen or normal state
</short>
<descr>Default is 'normal' (i.e. not minimized nor maximized)</descr>
<descr>
<p>
<var>WindowState</var> is a <var>TWindowState</var> property which indicates whether the form is currently displayed minimized, maximized, fullscreen or normal (restored) state. The default value is <var>wsNormal</var> (i. e. neither minimized nor maximized).
</p>
<p>
Changing the value for the property at run-time causes the <var>ShowWindow</var> routine to be called with the Integer display command representing the new property value. The action is not performed at design-time, or when <var>Showing</var> is set to <b>False</b>.
</p>
</descr>
<seealso>
<link id="TCustomForm.Showing"/>
<link id="TWindowState"/>
<link id="#lcl.lclintf.ShowWindow"/>
</seealso>
</element>
<!-- "class of" type Visibility: default -->
<element name="TCustomFormClass" link="#lcl.forms.TCustomForm"/>
<element name="TCustomFormClass">
<short>Class reference for the TCustomForm class</short>
<descr>
<p>
Used primarily in the implementation of window classes for the Lazarus IDE.
</p>
</descr>
<seealso>
<link id="#lcl.forms.TCustomForm"/>
</seealso>
</element>
<!-- object Visibility: default -->
<element name="TForm" link="#lcl.forms.TCustomForm"/>
<element name="TForm.FLCLVersion" link="#lcl.forms.TForm.LCLVersion"/>
<element name="TForm.LCLVersionIsStored" link="#lcl.forms.TForm.LCLVersion"/>
<element name="TForm.LCLVersionIsStored.Result">

29
docs/xml/lcl/groupededit.xml
View File

@ -107,6 +107,7 @@
<element name="TCustomAbstractGroupedEdit.FOnBuddyClick"/>
<element name="TCustomAbstractGroupedEdit.FOnEditClick"/>
<element name="TCustomAbstractGroupedEdit.FOnEditChange"/>
<element name="TCustomAbstractGroupedEdit.FOnEditContextPopup"/>
<element name="TCustomAbstractGroupedEdit.FOnEditDblClick"/>
<element name="TCustomAbstractGroupedEdit.FOnEditDragDrop"/>
<element name="TCustomAbstractGroupedEdit.FOnEditDragOver"/>
@ -442,6 +443,21 @@
<short>Object instance for the event notification</short>
</element>
<element name="TCustomAbstractGroupedEdit.InternalOnEditContextPopup">
<short>Executes the OnEditContextPopup handler for the control</short>
<descr/>
<seealso/>
</element>
<element name="TCustomAbstractGroupedEdit.InternalOnEditContextPopup.Sender">
<short/>
</element>
<element name="TCustomAbstractGroupedEdit.InternalOnEditContextPopup.MousePos">
<short/>
</element>
<element name="TCustomAbstractGroupedEdit.InternalOnEditContextPopup.Handled">
<short/>
</element>
<element name="TCustomAbstractGroupedEdit.InternalOnEditDragDrop">
<short>Executes the OnEditDragDrop event handler for the control</short>
<descr></descr>
@ -1318,6 +1334,18 @@
</seealso>
</element>
<element name="TCustomAbstractGroupedEdit.EditContextPopup">
<short/>
<descr/>
<seealso/>
</element>
<element name="TCustomAbstractGroupedEdit.EditContextPopup.MousePos">
<short/>
</element>
<element name="TCustomAbstractGroupedEdit.EditContextPopup.Handled">
<short/>
</element>
<element name="TCustomAbstractGroupedEdit.EditDblClick">
<short></short>
<descr></descr>
@ -2187,6 +2215,7 @@
</element>
<element name="TCustomAbstractGroupedEdit.OnClick" link="#LCL.Controls.TControl.OnClick"/>
<element name="TCustomAbstractGroupedEdit.OnContextPopup" link="#lcl.controls.TControl.OnContextPopup"/>
<element name="TCustomAbstractGroupedEdit.OnDblClick" link="#LCL.Controls.TControl.OnDblClick"/>
<element name="TCustomAbstractGroupedEdit.OnDragDrop" link="#LCL.Controls.TControl.OnDragDrop"/>
<element name="TCustomAbstractGroupedEdit.OnDragOver" link="#LCL.Controls.TControl.OnDragOver"/>

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

@ -4983,6 +4983,17 @@
<short>Value for the property</short>
</element>
<element name="TCustomEdit.GetTextHint">
<short>Gets the value for the TextHint property</short>
<descr/>
<seealso>
<link id="TCustomEdit.TextHint"/>
</seealso>
</element>
<element name="TCustomEdit.GetTextHint.Result">
<short>Value for the property</short>
</element>
<element name="TCustomEdit.SetCaretPos" link="#lcl.stdctrls.TCustomEdit.CaretPos">
<short>Sets the value for the CaretPos property</short>
<descr/>