mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-07 14:38:01 +02:00
Docs: LCL,LazUtils. Updates topic content. Fixes broken or missing links. Fixes spelling errors.
git-svn-id: trunk@65424 -
This commit is contained in:
dsiders
parent
c19e36a6e7
commit
8ea00ae159
@ -577,7 +577,7 @@
|
||||
<short>Starts an update process for the component.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>BeginUpdate</var> is a method used to start an update process for the component. It increments an internal update counter used to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifcations. The counter value is used in the <var>Changing</var> and <var>Changed</var> methods, and controls when the event notifications are enabled and performed.
|
||||
<var>BeginUpdate</var> is a method used to start an update process for the component. It increments an internal update counter used to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifications. The counter value is used in the <var>Changing</var> and <var>Changed</var> methods, and controls when the event notifications are enabled and performed.
|
||||
</p>
|
||||
<p>
|
||||
Use EndUpdate to decrement the internal update counter.
|
||||
@ -600,7 +600,7 @@
|
||||
<var>EndUpdate</var> is a method used to finish an active update process for the component.
|
||||
</p>
|
||||
<p>
|
||||
For each call to <var>BeginUpdate</var>, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifcations.
|
||||
For each call to <var>BeginUpdate</var>, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate <var>OnChanging</var> and <var>OnChange</var> event notifications.
|
||||
</p>
|
||||
<p>
|
||||
EndUpdate decrements the internal update counter incremented by calling BeginUpdate. When the update counter is a postive non-zero value, the <var>Changed</var> method is not called and the <var>OnChange</var> event handler is not signalled.
|
||||
|
||||
@ -697,7 +697,7 @@
|
||||
</element>
|
||||
|
||||
<element name="TListControlItems.Update">
|
||||
<short>Performs a notifcation when an item in the collection has been changed.</short>
|
||||
<short>Performs a notification when an item in the collection has been changed.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Update</var> is an overridden method in <var>TListControlItems</var> used to send a notification to observers when the value in <var>AItem</var> has been changed. Update calls the inherited method in <var>TCollection</var>.
|
||||
|
||||
@ -3569,7 +3569,7 @@ ADialog.FooterText := '(c) Copyright 1960-2021, Acme Corporation LLC.' + #10 +
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>RadioButtons</var> is a <var>TTaskDialogButtons</var> proprety with the collection of defined radio buttons for the Task dialog.
|
||||
<var>RadioButtons</var> is a <var>TTaskDialogButtons</var> property with the collection of defined radio buttons for the Task dialog.
|
||||
</p>
|
||||
<p>
|
||||
Radio buttons are displayed in the main content area for the Task dialog, below the values in <var>Text</var> and <var>ExpandedText</var>. Use of radio buttons is optional. They are displayed when items have been added to the collection. The <var>TTaskDialogRadioButtonItem</var> items in the collection are passed as an argument when the <var>Execute</var> method is called.
|
||||
|
||||
@ -92,16 +92,16 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
<element name="TFPSharpInterpolation.Execute.x">
|
||||
<short></short>
|
||||
<short>Horizontal coordinate.</short>
|
||||
</element>
|
||||
<element name="TFPSharpInterpolation.Execute.y">
|
||||
<short></short>
|
||||
<short>Vertical coordinate.</short>
|
||||
</element>
|
||||
<element name="TFPSharpInterpolation.Execute.w">
|
||||
<short></short>
|
||||
<short>Width for the output.</short>
|
||||
</element>
|
||||
<element name="TFPSharpInterpolation.Execute.h">
|
||||
<short></short>
|
||||
<short>Height for the output.</short>
|
||||
</element>
|
||||
|
||||
<!-- class Visibility: default -->
|
||||
@ -456,6 +456,24 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TLazCanvas.ExtraFontData">
|
||||
<short>Member with extra FreeType font data from the canvas or device context.</short>
|
||||
<descr>Used in custom-drawn LCL controls.</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TLazCanvas.ImageFormat">
|
||||
<short>Member with the TLazCanvasImageFormat instance used to speed up drawing.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TLazCanvas.SelectedBitmap">
|
||||
<short>Member with the GDI Handle for an image.</short>
|
||||
<descr>Used in custom-drawn LCL controls.</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TLazCanvas.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
@ -577,7 +595,7 @@
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLazCanvas.AlphaBlendIgnoringDestPixels">
|
||||
<short></short>
|
||||
<short>Performs an AlphaBlend operation assuming a white background.</short>
|
||||
<descr>
|
||||
<p>
|
||||
This is a safer version for use where the destination pixels may not be consistent or valid. It will draw as if the target area contained opaque white pixels.
|
||||
|
||||
@ -317,8 +317,12 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TLazDockTree.FindBorderControl">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Gets the control with the specified dock zone and anchor side.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Returns the DockSite if no controls are found using the specified zone and anchor side.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -495,18 +499,11 @@
|
||||
<element name="TLazDockPages.Page.Index">
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazDockPages.ActivePageComponent" link="#LCL.ComCtrls.TCustomNotebook.ActivePageComponent">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLazDockPages.Pages" link="#LCL.ComCtrls.TCustomNotebook.Pages">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLazDockPages.ActivePageComponent" link="#lcl.comctrls.TCustomTabControl.ActivePageComponent"/>
|
||||
<element name="TLazDockPages.Pages" link="#lcl.comctrls.TCustomTabControl.Pages"/>
|
||||
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="DockAlignOrientations">
|
||||
<short/>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
-->
|
||||
<module name="LResources">
|
||||
<short>
|
||||
Maintains a global list of Lazarus resources and provides methods and types to stream components.
|
||||
Maintains a global list of Lazarus resources, and provides methods and types used to stream components.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -32,9 +32,13 @@
|
||||
</descr>
|
||||
|
||||
<!-- unresolved type reference Visibility: default -->
|
||||
<element name="Windows"/>
|
||||
<element name="Classes"/>
|
||||
<element name="SysUtils"/>
|
||||
<element name="Types"/>
|
||||
<element name="RtlConsts"/>
|
||||
<element name="TypInfo"/>
|
||||
<element name="Variants"/>
|
||||
<element name="LCLProc"/>
|
||||
<element name="LCLStrConsts"/>
|
||||
<element name="LazConfigStorage"/>
|
||||
@ -52,21 +56,21 @@
|
||||
</element>
|
||||
<!-- array type Visibility: default -->
|
||||
<element name="TFilerSignature">
|
||||
<short/>
|
||||
<short>
|
||||
Signature for a the version of the TFiler instance used to read or write value using a Lazarus Resource Stream (LRS file).
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TLResource">
|
||||
<short>The Lazarus resource descriptor class.
|
||||
</short>
|
||||
<short>Describes a Lazarus resource stored in TLResourceList.</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: public -->
|
||||
<element name="TLResource.Name">
|
||||
<short>The resource name.</short>
|
||||
<short>Name for the Lazarus resource.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -78,50 +82,52 @@
|
||||
</element>
|
||||
<!-- variable Visibility: public -->
|
||||
<element name="TLResource.Value">
|
||||
<short>The resource value.</short>
|
||||
<short>The value for the resource.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TLResourceList">
|
||||
<short>The container class for all Lazarus resources.
|
||||
</short>
|
||||
<short>Container class used for Lazarus resource descriptions.</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element link="#lcl.lresources.TLResourceList.Items" name="TLResourceList.FList">
|
||||
<short>Main list with all resource pointers.</short>
|
||||
<short>Member with the list for resource descriptions.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TLResourceList.FMergeList">
|
||||
<short>List needed for mergesort.</short>
|
||||
<short>List used to MergeSort resources in the list.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TLResourceList.FSortedCount">
|
||||
<short>0 .. FSortedCount-1 resources are sorted.</short>
|
||||
<short>The number of resource descriptions in the sorted list.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: private -->
|
||||
<element name="TLResourceList.FindPosition">
|
||||
<short>Returns the index of the named resource, -1 if not found.
|
||||
</short>
|
||||
<descr>The list is sorted, if required.
|
||||
<short>Returns the index of the named resource, or -1 if not found.</short>
|
||||
<descr>
|
||||
<p>
|
||||
The list is sorted, if required.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLResourceList.FindPosition.Result">
|
||||
<short/>
|
||||
<short>
|
||||
Ordinal position for the named resource in the list, or -1 when not found.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TLResourceList.FindPosition.Name">
|
||||
<short/>
|
||||
<short>Name of the resource to locate in the list of descriptions.</short>
|
||||
</element>
|
||||
<!-- function Visibility: private -->
|
||||
<element link="#lcl.lresources.TLResourceList.Items" name="TLResourceList.GetItems"/>
|
||||
@ -140,7 +146,7 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: private -->
|
||||
<element name="TLResourceList.MergeSort">
|
||||
<short>MergeSort sorting part.</short>
|
||||
<short>Implements a MergeSort for the resource descriptions in the list.</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -180,33 +186,51 @@
|
||||
<short/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TLResourceList.Create"/>
|
||||
<element name="TLResourceList.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Allocates resources needed for the internal lists used in the class instance, and sets the default values for internal members.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TLResourceList.Destroy"/>
|
||||
<element name="TLResourceList.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Frees the values in and resources allocated to the internal lists for the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLResourceList.Add">
|
||||
<short>Adds a resource.</short>
|
||||
<descr>ValueType is stored in uppercase.
|
||||
<short>Adds a resource description to the list with the specified values.</short>
|
||||
<descr>
|
||||
<p>
|
||||
ValueType is stored in uppercase.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLResourceList.Add.Name">
|
||||
<short/>
|
||||
<short>Name for the resource.</short>
|
||||
</element>
|
||||
<element name="TLResourceList.Add.ValueType">
|
||||
<short/>
|
||||
<short>Name for the Type used in the value.</short>
|
||||
</element>
|
||||
<element name="TLResourceList.Add.Value">
|
||||
<short>A sinlge value string.</short>
|
||||
<short>A single AnsiString value string for the type.</short>
|
||||
</element>
|
||||
<element name="TLResourceList.Add.Values">
|
||||
<short>The value split into an string array.</short>
|
||||
<short>An array with the String values for the type.</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TLResourceList.Find">
|
||||
<short>Returns the resource of the given name (and type).
|
||||
</short>
|
||||
<short>Returns the resource in the list with the given name and type.</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
@ -222,17 +246,17 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TLResourceList.Count">
|
||||
<short>The number of listed resources.</short>
|
||||
<short>Gets the number of resource descriptions in the list.</short>
|
||||
<descr/>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TLResourceList.Count.Result">
|
||||
<short/>
|
||||
<short>The number of resource descriptions in the list.</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TLResourceList.Items">
|
||||
<short>Indexed access to the resource list.</short>
|
||||
<short>Provides Indexed access to the resource descriptions in the list.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -309,7 +333,15 @@
|
||||
<short/>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TLazarusResourceStream.Destroy"/>
|
||||
<element name="TLazarusResourceStream.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the UnlockResource and FreeResource routines when resource descriptors are used for the platform. Calls the inherited method prior to exit.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TLazarusResourceStream.Write">
|
||||
<short>Raises an error on an attempt to write to the stream.</short>
|
||||
@ -336,38 +368,66 @@
|
||||
</element>
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TAbstractTranslator">
|
||||
<short>Abstract base class for translators.</short>
|
||||
<short>Abstract base class for translators used in the LCL.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TAbstractTranslator</var> is a class which specifies the base class string and property translators used in the Lazarus Component Library (<b>LCL</b>). It defines an abstract virtual method used to translate string properties when they are read from a Lazarus Resource Stream (<b>LRS</b>).
|
||||
</p>
|
||||
<p>
|
||||
Do not create instances of TAbstractTranslator; use one of the descendent class like <var>TUpdateTranslator</var>, <var>TDefaultTranslator</var>, or <var>TPOTranslator</var>.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#lcl.lcltranslator.TUpdateTranslator">TUpdateTranslator</link>
|
||||
<link id="#lcl.lcltranslator.TDefaultTranslator">TDefaultTranslator</link>
|
||||
<link id="#lcl.lcltranslator.TPOTranslator">TPOTranslator</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TAbstractTranslator.TranslateStringProperty">
|
||||
<short>The base class for an TReader.OnReadStringProperty handler.</short>
|
||||
<short>Specifies a method used to translate a String property.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TranslateStringProperty</var> is an abstract virtual method which defines the method used to translate a <var>String</var> property in a persistent object instance. TranslateStringProperty must be implemented in a descendent class to perform the actions needed to retrieve and translate the specified property value.
|
||||
</p>
|
||||
<p>
|
||||
The address for the method is assigned as the <var>OnReadStringProperty</var> event handler in <var>TReader</var> class instances.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TLRSObjectReader"/>
|
||||
<link id="#rtl.classes.TReader">TReader</link>
|
||||
<link id="#rtl.classes.TFiler">TFiler</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TAbstractTranslator.TranslateStringProperty.Sender">
|
||||
<short/>
|
||||
<short>Object for the event notification.</short>
|
||||
</element>
|
||||
<element name="TAbstractTranslator.TranslateStringProperty.Instance">
|
||||
<short/>
|
||||
<short>Persistent object with the property value translated in the method.</short>
|
||||
</element>
|
||||
<element name="TAbstractTranslator.TranslateStringProperty.PropInfo">
|
||||
<short/>
|
||||
<short>RTTI information for the property translated in the method.</short>
|
||||
</element>
|
||||
<element name="TAbstractTranslator.TranslateStringProperty.Content">
|
||||
<short/>
|
||||
<short>
|
||||
Variable parameter where the translated value for the property is returned.
|
||||
</short>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="LRSTranslator">
|
||||
<short>The default translator instance to use in <link id="CreateLRSReader"/>.
|
||||
<short>
|
||||
Variable with the default translator used in CreateLRSReader.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
The value for the variable is assigned when SetDefaultLang is called.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="CreateLRSReader"/>
|
||||
<link id="#lcl.lcltranslator.SetDefaultLang">SetDefaultLang</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<!-- enumeration type Visibility: default -->
|
||||
<element name="TLRSItemType">
|
||||
@ -396,14 +456,15 @@
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TLRSORStackItem.Name">
|
||||
<short/>
|
||||
<short>Name for the item on the LRS Reader Object stack.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TLRSORStackItem.ItemType">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Identifies the type for the stack item.</short>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
@ -1554,13 +1615,33 @@
|
||||
<short/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TLRPositionLinks.Create"/>
|
||||
<element name="TLRPositionLinks.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Allocates the internal list used to store values in the Data property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TLRPositionLinks.Destroy"/>
|
||||
<element name="TLRPositionLinks.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Frees resources allocated for the Data property, and calls the inherited method prior to exit.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLRPositionLinks.Clear">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>Removes items stored in the Data property.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Sets the value in the Count property to 0, which causes the items stored in Data to be freed.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
@ -1626,7 +1707,9 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TLRPositionLinks.Add">
|
||||
<short/>
|
||||
<short>
|
||||
Adds a new item to the Data property using the specified positions and pointer to the item data.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -1934,12 +2017,31 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TUTF8Parser.Create"/>
|
||||
<element name="TUTF8Parser.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Create</var> is the constructor for the class instance.
|
||||
</p>
|
||||
<p>
|
||||
Create allocates a 4K buffer used to store the values read from Stream. The buffer is examined in the methods for the class. It initializes internal members used in the parser implementation to their default values. The internal buffer is loaded with the first 4K block of values in Stream, and the NextToken method is called to position the parser on the first token in the buffered values.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TUTF8Parser.Create.Stream">
|
||||
<short/>
|
||||
<short>Stream with the values parser in the class.</short>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TUTF8Parser.Destroy"/>
|
||||
<element name="TUTF8Parser.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Destroy</var> is the overridden destructor for the class instance. It moves the stream to the position returned from <var>SourcePos</var> (the position for the last processed value in the internal buffer). Destroy free the memory allocated for the internal buffer in the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TUTF8Parser.CheckToken">
|
||||
<short>Asserts that Token is of the expected type.</short>
|
||||
@ -2115,77 +2217,90 @@
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- class Visibility: default -->
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TCustomLazComponentQueue">
|
||||
<short>A queue to stream components, used for multithreading or network.
|
||||
</short>
|
||||
<short>A queue to stream components, used for multithreading or network.</short>
|
||||
<descr>
|
||||
<p>
|
||||
The function ConvertComponentAsString converts a component to binary format
|
||||
with a leading size information (using WriteLRSInt64MB).
|
||||
</p><p>
|
||||
When streaming components over network, they will arrive in chunks.
|
||||
</p><p>
|
||||
TCustomLazComponentQueue tells you, if a whole component has arrived.
|
||||
ConvertComponentAsString converts a component to binary format with a leading size information (using WriteLRSInt64MB).
|
||||
</p>
|
||||
<p>
|
||||
When streaming components over network, they will arrive in chunks. TCustomLazComponentQueue tells you, if a whole component has arrived.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TCustomLazComponentQueue.FOnFindComponentClass" link="#lcl.lresources.TCustomLazComponentQueue.OnFindComponentClass"/>
|
||||
<!-- variable Visibility: protected -->
|
||||
<element name="TCustomLazComponentQueue.FQueue">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<short>Member with the dynamic storage for the queue..</short>
|
||||
</element>
|
||||
<!-- function Visibility: protected -->
|
||||
<element name="TCustomLazComponentQueue.ReadComponentSize">
|
||||
<short/>
|
||||
<short>Reads the component size and the length for the size value.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.ReadComponentSize.Result">
|
||||
<short/>
|
||||
<short>False if there is not enough storage in the queue for the component size.</short>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.ReadComponentSize.ComponentSize">
|
||||
<short/>
|
||||
<short>Size of the component.</short>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.ReadComponentSize.SizeLength">
|
||||
<short/>
|
||||
<short>Number of bytes needed for the component size value.</short>
|
||||
</element>
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.Create"/>
|
||||
<element name="TCustomLazComponentQueue.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Allocates resources needed for the internal queue storage.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.Create.TheOwner">
|
||||
<short/>
|
||||
<short>Owner of the class instance.</short>
|
||||
</element>
|
||||
<!-- destructor Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.Destroy"/>
|
||||
<element name="TCustomLazComponentQueue.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Frees resources allocated to the internal queue storage.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.Clear">
|
||||
<short/>
|
||||
<short>Clears all values in the internal queue storage.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.Write">
|
||||
<short/>
|
||||
<short>Pushes values in Buffer onto the internal storage queue.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.Write.Result">
|
||||
<short/>
|
||||
<short>Number of bytes added to the queue in the method.</short>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.Write.Buffer">
|
||||
<short/>
|
||||
<short>Untyped buffer with values pushed onto the internal queue storage.</short>
|
||||
</element>
|
||||
<element name="TCustomLazComponentQueue.Write.Count">
|
||||
<short/>
|
||||
<short>Number of bytes in Buffer.</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.CopyFrom">
|
||||
<short/>
|
||||
<short>
|
||||
Copies the specified number of bytes from the stream and pushes the values onto the queue.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2200,7 +2315,9 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.HasComponent">
|
||||
<short/>
|
||||
<short>
|
||||
Determines whether the queue contains the entire contents of the component at the top of the queue.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2209,7 +2326,7 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.ReadComponent">
|
||||
<short/>
|
||||
<short>Reads a component from the queue and sets it owner.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2224,8 +2341,8 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.ConvertComponentAsString">
|
||||
<short>Converts a component to binary format
|
||||
with a leading size information (using WriteLRSInt64MB).
|
||||
<short>
|
||||
Converts a component to binary format with a leading size information (using WriteLRSInt64MB).
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -2238,57 +2355,71 @@
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TCustomLazComponentQueue.OnFindComponentClass">
|
||||
<short/>
|
||||
<short>
|
||||
Event handler signalled to get the class type for the specified class name in a TReader instance.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- class Visibility: default -->
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TLazComponentQueue">
|
||||
<short/>
|
||||
<short>Publishes property from the ancestor class.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLazComponentQueue.Name">
|
||||
<short/>
|
||||
<short>Published Name for the component queue.</short>
|
||||
</element>
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TLazComponentQueue.OnFindComponentClass">
|
||||
<short/>
|
||||
<short>
|
||||
Published event handler used to get the class type for a give class name.
|
||||
</short>
|
||||
</element>
|
||||
<!-- record type Visibility: default -->
|
||||
<!-- record type Visibility: default -->
|
||||
<element name="TPropertyToSkip">
|
||||
<short>Item of TPropertiesToSkip.</short>
|
||||
<descr/>
|
||||
<short>
|
||||
Contains information about a property omitted from LCL component streaming.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TPropertyToSkip</var> is a record type with information about a property in a persistent class that is omitted during LCL component streaming. TPropertyToSkip is the type maintained in the TPropertiesToSkip list when the RegisterPropertyToSkip routine is called.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TPropertyToSkip.PersistentClass">
|
||||
<short/>
|
||||
<short>Class type for the persistent object with the omitted property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TPropertyToSkip.PropertyName">
|
||||
<short/>
|
||||
<short>Name for the omitted property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TPropertyToSkip.Note">
|
||||
<short/>
|
||||
<short>A note about the omitted property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="TPropertyToSkip.HelpKeyword">
|
||||
<short/>
|
||||
<short>Help keyword for the omitted property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- pointer type Visibility: default -->
|
||||
<element name="PRemovedProperty" link="#lcl.lresources.TPropertyToSkip"/>
|
||||
<!-- class Visibility: default -->
|
||||
<!-- class Visibility: default -->
|
||||
<element name="TPropertiesToSkip">
|
||||
<short/>
|
||||
<short>
|
||||
Implements a list used to store properties which are skipped during LCL streaming.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2318,7 +2449,9 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TPropertiesToSkip.Notify">
|
||||
<short/>
|
||||
<short>
|
||||
Handles a notification action when the specified Pointer is added to or removed from the list.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2330,7 +2463,9 @@
|
||||
</element>
|
||||
<!-- procedure Visibility: protected -->
|
||||
<element name="TPropertiesToSkip.DoPropertyNotFound">
|
||||
<short/>
|
||||
<short>
|
||||
Determines if the specified property type and name exists and is handled in the list.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2354,51 +2489,63 @@
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TPropertiesToSkip.IndexOf">
|
||||
<short/>
|
||||
<short>
|
||||
Gets the ordinal position in the list where the property type and name is stored.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.IndexOf.Result">
|
||||
<short/>
|
||||
<short>Ordinal position in the list, or -1 when not found.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.IndexOf.AInstance">
|
||||
<short/>
|
||||
<short>Property instance to locate in the list.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.IndexOf.APropertyName">
|
||||
<short/>
|
||||
<short>Name for the property type to locate in the list.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.IndexOf.AClass">
|
||||
<short/>
|
||||
<short>Class type for the property to located in the list.</short>
|
||||
</element>
|
||||
<!-- function Visibility: public -->
|
||||
<element name="TPropertiesToSkip.Add">
|
||||
<short/>
|
||||
<short>
|
||||
Adds the specified property type and name to the list when not already present.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Add.Result">
|
||||
<short/>
|
||||
<short>
|
||||
Ordinal position in the list where the skipped property was found or stored.
|
||||
</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Add.APersistentClass">
|
||||
<short/>
|
||||
<short>Class type for the skipped property.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Add.APropertyName">
|
||||
<short/>
|
||||
<short>Name for the skipped property.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Add.ANote">
|
||||
<short/>
|
||||
<short>Note to associate with the skipped property.</short>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Add.AHelpKeyWord">
|
||||
<short/>
|
||||
<short>Help keyword for the skipped property.</short>
|
||||
</element>
|
||||
<!-- property Visibility: public -->
|
||||
<element name="TPropertiesToSkip.Items">
|
||||
<short/>
|
||||
<descr/>
|
||||
<short>
|
||||
Provides indexed access to skipped properties in the list by their ordinal position.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Items is an indexed PRemovedProperty property used to access skipped property definitions by their ordinal position in the list. Read and write access for the property value ensures the inherited Get or Put methods are called.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TPropertiesToSkip.Items.AIndex">
|
||||
<short/>
|
||||
<short>Ordinal position for the indexed property value.</short>
|
||||
</element>
|
||||
<!-- constant Visibility: default -->
|
||||
<element name="ObjStreamMaskInherited">
|
||||
@ -2418,25 +2565,25 @@
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="LazarusResources" link="#lcl.lresources.TLResourceList">
|
||||
<short>The list of all loaded standard resources.</short>
|
||||
<short>The list with all of the loaded standard resources.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="PropertiesToSkip">
|
||||
<short/>
|
||||
<short>Unit global variable with all of the registered skipped properties.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="LRSObjectReaderClass">
|
||||
<short/>
|
||||
<short>Class type for Lazarus Object Reader instances.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<!-- variable Visibility: default -->
|
||||
<element name="LRSObjectWriterClass">
|
||||
<short/>
|
||||
<short>Class type for Lazarus Object Writer instances.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -2688,9 +2835,10 @@
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="BinaryToLazarusResourceCode">
|
||||
<short/>
|
||||
<descr>FPC is not optimized for building a constant string out of thousands of lines.
|
||||
It needs huge amounts of memory and becomes very slow.
|
||||
Therefore big files are split into several strings.
|
||||
<descr>
|
||||
<p>
|
||||
FPC is not optimized for building a constant string out of thousands of lines. It needs huge amounts of memory and becomes very slow. Therefore big files are split into several strings.
|
||||
</p>
|
||||
</descr>
|
||||
<errors/>
|
||||
<seealso/>
|
||||
|
||||
@ -9,12 +9,15 @@
|
||||
<remark>
|
||||
Please note that <var>ExtCtrls</var> has a dependency on the <var>popupnotifier</var> unit; circular dependencies between <var>popupnotifier</var> and other units should be avoided.
|
||||
</remark>
|
||||
<p>
|
||||
This file is part of the Lazarus Component Library (<b>LCL</b>).
|
||||
</p>
|
||||
</descr>
|
||||
|
||||
<!-- enumeration type Visibility: default -->
|
||||
<element name="TNotifierXButtonButtonState">
|
||||
<short>
|
||||
Button states for the popup notifier buttons.
|
||||
Button states for the pop-up notifier buttons.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
@ -194,31 +197,33 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TNotifierForm</var> is a THintWindow descendant that implements the form used for TPopupNotifier. TNotifierForm has private members that are used for the title, text, icon, and button in the popup notification.TNotifierForm provides methods which paint, hide, and handle resizing for the form.
|
||||
<var>TNotifierForm</var> is a <var>THintWindow</var> descendant that implements the form used for <var>TPopupNotifier</var>. TNotifierForm has private members that are used for the title, text, icon, and button on the pop-up notification form.TNotifierForm provides methods which paint, hide, and handle resizing for the form.
|
||||
</p>
|
||||
</descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
<seealso>
|
||||
<link id="TPopupNotifier"/>
|
||||
<link id="#lcl.forms.THintWindow"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TNotifierForm.lblTitle">
|
||||
<short>Title for the form.</short>
|
||||
<short>Label with the Title for the form.</short>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TNotifierForm.lblText">
|
||||
<short>Text for the form.</short>
|
||||
<short>Label with the Text for the form.</short>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TNotifierForm.imgIcon">
|
||||
<short>Icon for the form.</short>
|
||||
<short>Image with the Icon for the form.</short>
|
||||
</element>
|
||||
|
||||
<!-- variable Visibility: private -->
|
||||
<element name="TNotifierForm.btnX">
|
||||
<short>Button for the form.</short>
|
||||
<short>Custom Button for the form.</short>
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: private -->
|
||||
@ -234,7 +239,6 @@
|
||||
HideForm is assigned as the OnClick event handler in TLabel and TNotifierXButton members created for the form.
|
||||
</p>
|
||||
</descr>
|
||||
<errors></errors>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
@ -276,7 +280,7 @@
|
||||
|
||||
<!-- constructor Visibility: public -->
|
||||
<element name="TNotifierForm.Create">
|
||||
<short></short>
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Create</var> is the constructor for the class instance. Create calls the inherited constructor using AOwner as the owner for the class instance. Create sets the BorderStyle to bsNone, and calculates the Width and Height for the form. Create allocates resources and initializes the Icon, Title, Text, and Button for the form. The Color for the form is set to clInfoBk.
|
||||
@ -316,14 +320,33 @@
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TNotifierForm.Paint">
|
||||
<short>Draws the form background and icon image.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Paint is an overridden method in TNotifierForm used to render the form to its Canvas using values in the Color and ImgIcon properties. Canvas is updated with the brush style and color needed, and its FillRect method is called to paint the background for the form. The bitmap in ImgIcon is drawn on the Canvas when it has been assigned.
|
||||
</p>
|
||||
<p>
|
||||
Paint re-implements the method, and does not call the inherited method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.forms.THintWindow.Paint"/>
|
||||
<link id="#lcl.controls.TCustomControl.Canvas"/>
|
||||
<link id="#lcl.graphics.TCanvas.FillRect"/>
|
||||
<link id="#lcl.graphics.TPicture.Bitmap"/>
|
||||
<link id="#lcl.forms.TCustomForm.Color"/>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<!-- object Visibility: default -->
|
||||
<element name="TPopupNotifier">
|
||||
<short>
|
||||
Implements a popup notification component.
|
||||
Implements a pop-up notification component.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TPopupNotifier</var> is a TComponent descendant which implements a popup notification component. TPopupNotifier includes a TNotifierForm member which displays the contents of the notification. TPopupNotifier provides methods and properties that allow access to the form and its controls. TPopupNotifier also provides methods which display and hide the form.
|
||||
<var>TPopupNotifier</var> is a TComponent descendant which implements a pop-up notification component. TPopupNotifier includes a TNotifierForm member which displays the contents of the notification. TPopupNotifier provides methods and properties that allow access to the form and its controls. TPopupNotifier also provides methods which display and hide the form.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -336,7 +359,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetColor</var> is a TColor function used to get the value for the Color property in the form which displays the popup notification. GetColor is the read access specifier for the Color property.
|
||||
<var>GetColor</var> is a TColor function used to get the value for the Color property in the form which displays the pop-up notification. GetColor is the read access specifier for the Color property.
|
||||
</p>
|
||||
<p>
|
||||
Use Color to read or write the value for the property.
|
||||
@ -357,7 +380,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetColor</var> is procedure used to set color for the form which displays the popup notification. SetColor is the write access specifier for the Color property. SetColor stores the specified value in the Color property for the notification form.
|
||||
<var>SetColor</var> is procedure used to set color for the form which displays the pop-up notification. SetColor is the write access specifier for the Color property. SetColor stores the specified value in the Color property for the notification form.
|
||||
</p>
|
||||
<p>
|
||||
Use Color to read or write the value for the property.
|
||||
@ -378,7 +401,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetIcon</var> is a TPicture function which gets the icon for the popup notification form. GetIcon is the read access specifier for the Icon property.
|
||||
<var>GetIcon</var> is a TPicture function which gets the icon for the pop-up notification form. GetIcon is the read access specifier for the Icon property.
|
||||
</p>
|
||||
<p>
|
||||
Use Icon to read or write the value for the property.
|
||||
@ -397,7 +420,7 @@
|
||||
<short>Sets the icon for the notification form.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetIcon</var> is a procedure which sets the Icon for the popup notification form to the specified value. SetIcon is the write access specifier for the Icon property.
|
||||
<var>SetIcon</var> is a procedure which sets the Icon for the pop-up notification form to the specified value. SetIcon is the write access specifier for the Icon property.
|
||||
</p>
|
||||
<p>
|
||||
Use Icon to read or write the value in the property.
|
||||
@ -418,7 +441,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetText</var> is a String function which gets the value of the Text label for the popup notification form. GetText is the read access specifier for the Text property. GetText returns the Caption for the corresponding TLabel on the popup notification form.
|
||||
<var>GetText</var> is a String function which gets the value of the Text label for the pop-up notification form. GetText is the read access specifier for the Text property. GetText returns the Caption for the corresponding TLabel on the pop-up notification form.
|
||||
</p>
|
||||
<p>
|
||||
Use Text to read or write the value for the property.
|
||||
@ -439,7 +462,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetText</var> is a procedure which sets the text on the popup notification form to the specified value. SetText is the write access specifier for the Text property. SetText stores the specified value in the caption of the corresponding TLabel on the popup notification form.
|
||||
<var>SetText</var> is a procedure which sets the text on the pop-up notification form to the specified value. SetText is the write access specifier for the Text property. SetText stores the specified value in the caption of the corresponding TLabel on the pop-up notification form.
|
||||
</p>
|
||||
<p>
|
||||
Use Text to read or write the value for the property.
|
||||
@ -458,7 +481,7 @@
|
||||
<short>Gets the title for the notification form.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetTitle</var> is a String function which gets the title displayed on the popup notification form. GetTitle is the read access specifier for the Title property. GetTitle returns the value for the caption in the corresponding TLabel on the notification form.
|
||||
<var>GetTitle</var> is a String function which gets the title displayed on the pop-up notification form. GetTitle is the read access specifier for the Title property. GetTitle returns the value for the caption in the corresponding TLabel on the notification form.
|
||||
</p>
|
||||
<p>
|
||||
Use Title to read or write the value in the property.
|
||||
@ -479,7 +502,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetTitle</var> is a procedure which sets the value for the title on the popup notification form. SetTitle is the write access specifier for the Title property. SetTitle stores the specified value in the caption of the TLabel for the popup notification form.
|
||||
<var>SetTitle</var> is a procedure which sets the value for the title on the pop-up notification form. SetTitle is the write access specifier for the Title property. SetTitle stores the specified value in the caption of the TLabel for the pop-up notification form.
|
||||
</p>
|
||||
<p>
|
||||
Use Title to read or write the value for the property.
|
||||
@ -500,7 +523,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetVisible</var> is a Boolean function which gets the value for the Visible property in the popup notification form. GetVisible is the read access specifier for the Visible property.
|
||||
<var>GetVisible</var> is a Boolean function which gets the value for the Visible property in the pop-up notification form. GetVisible is the read access specifier for the Visible property.
|
||||
</p>
|
||||
<p>
|
||||
Use Visible to read or write the value for the property.
|
||||
@ -521,13 +544,13 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetVisible</var> is a procedure which sets the value in the Visible property for the popup notification form. SetVisible is the write access specifier for the Visible property.
|
||||
<var>SetVisible</var> is a procedure which sets the value in the Visible property for the pop-up notification form. SetVisible is the write access specifier for the Visible property.
|
||||
</p>
|
||||
<p>
|
||||
Use Visible to read or write the value for the property.
|
||||
</p>
|
||||
<p>
|
||||
Use Show or ShowAtPos to display the popup notification form for the component. Use Hide to close the popup notification form for the component.
|
||||
Use Show or ShowAtPos to display the pop-up notification form for the component. Use Hide to close the pop-up notification form for the component.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -545,7 +568,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>GetOnClose</var> is a TCloseEvent function which gets the OnClose event handler assigned to the popup notification form. GetOnClose is the read access specifier for the OnClose property.
|
||||
<var>GetOnClose</var> is a TCloseEvent function which gets the OnClose event handler assigned to the pop-up notification form. GetOnClose is the read access specifier for the OnClose property.
|
||||
</p>
|
||||
<p>
|
||||
Use OnClose to read or write the value for the property.
|
||||
@ -562,11 +585,11 @@
|
||||
<!-- procedure Visibility: private -->
|
||||
<element name="TPopupNotifier.SetOnClose">
|
||||
<short>
|
||||
Sets the OnClose event handler for the popup notification form.
|
||||
Sets the OnClose event handler for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>SetOnClose</var> is a procedure which sets the OnClose event handler in the popup notification form to the specified value. SetOnClose is the write access specifier for the OnClose property.
|
||||
<var>SetOnClose</var> is a procedure which sets the OnClose event handler in the pop-up notification form to the specified value. SetOnClose is the write access specifier for the OnClose property.
|
||||
</p>
|
||||
<p>
|
||||
Use OnClose to read or write the value in the property.
|
||||
@ -583,11 +606,11 @@
|
||||
<!-- variable Visibility: public -->
|
||||
<element name="TPopupNotifier.vNotifierForm">
|
||||
<short>
|
||||
Form which displays the popup notification.
|
||||
Form which displays the pop-up notification.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>vNotifierForm</var> is a public TNotifierForm member which represents the form used to display the popup notification. vNotifierForm is instantiated in Create but not displayed; its Visible property is set to False. vNotifierForm is displayed using the Show or ShowAtPos methods. Use the Hide method to hide the form. vNotifierForm is freed in the Destroy method.
|
||||
<var>vNotifierForm</var> is a public <var>TNotifierForm</var> member which represents the form used to display the pop-up notification. vNotifierForm is instantiated in Create but not displayed; its Visible property is set to False. vNotifierForm is displayed using the Show or ShowAtPos methods. Use the Hide method to hide the form. vNotifierForm is freed in the Destroy method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -618,7 +641,7 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Destroy</var> is the destructor for the component instance. Destroy calls the Hide method for the popup notification form, and frees the the vNotifierForm member. Destroy calls the inherited destructor prior to exiting from the method.
|
||||
<var>Destroy</var> is the destructor for the component instance. Destroy calls the <var>Hide</var> method for the pop-up notification form, and frees the the vNotifierForm member. Destroy calls the inherited destructor prior to exiting from the method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -627,11 +650,11 @@
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPopupNotifier.Hide">
|
||||
<short>
|
||||
Hides the popup notification form.
|
||||
Hides the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Hide</var> is a procedure which hides the popup notification form for the component. Hide calls the Hide method in VNotifierForm.
|
||||
<var>Hide</var> is a procedure which hides the pop-up notification form for the component. Hide calls the Hide method in VNotifierForm.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -640,11 +663,11 @@
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPopupNotifier.Show">
|
||||
<short>
|
||||
Displays the popup notification.
|
||||
Displays the pop-up notification.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Show</var> is a procedure which displays the popup notification form for the component. Show calls the Show method in vNotifierForm.
|
||||
<var>Show</var> is a procedure which displays the pop-up notification form for the component. Show calls the Show method in vNotifierForm.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -653,11 +676,11 @@
|
||||
<!-- procedure Visibility: public -->
|
||||
<element name="TPopupNotifier.ShowAtPos">
|
||||
<short>
|
||||
Displays the popup notification form at the specified position.
|
||||
Displays the pop-up notification form at the specified position.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ShowAtPos</var> is a procedure which displays the popup notification form at the specified position on the screen. Values in X and Y are corrected to fit the screen dimensions, similar to the mechanism used for TPopupMenu. ShowAtPos calls the Show method in vNotifierForm to display the popup notification form.
|
||||
<var>ShowAtPos</var> is a procedure which displays the pop-up notification form at the specified position on the screen. Values in X and Y are corrected to fit the screen dimensions, similar to the mechanism used for <var>TPopupMenu</var>. ShowAtPos calls the <var>Show</var> method in vNotifierForm to display the pop-up notification form.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -676,11 +699,11 @@
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.Color">
|
||||
<short>
|
||||
Color for the popup notification form.
|
||||
Color for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Color</var> is a TColor property that provides access to the Color property in the popup notification form. GetColor is the read access specifier for the property. SetColor is the write access specifier for the property.
|
||||
<var>Color</var> is a <var>TColor</var> property that provides access to the background color for the pop-up notification form. GetColor is the read access specifier for the property. SetColor is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -689,11 +712,11 @@
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.Icon">
|
||||
<short>
|
||||
Icon for the popup notification form.
|
||||
Icon for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Icon</var> is a TPicture property that provides access to the Icon for the popup notification form. GetIcon is the read access specifier for the property. SetIcon is the write access specifier for the property.
|
||||
<var>Icon</var> is a <var>TPicture</var> property that provides access to the Icon for the pop-up notification form. GetIcon is the read access specifier for the property. SetIcon is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -702,37 +725,58 @@
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.Text">
|
||||
<short>
|
||||
Text for the popup notification form.
|
||||
Text for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Text</var> is a String property that provides access to the text for the popup notification form. GetText is the read access specifier for the property. SetText is the write access specifier for the property.
|
||||
<var>Text</var> is a String property that provides access to the text for the pop-up notification form. GetText is the read access specifier for the property. SetText is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TPopupNotifier.TextFont">
|
||||
<short>Font used for the Text displayed on the form.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TextFont</var> is a <var>TFont</var> property with the font face used for the <var>Text</var> displayed on the form. Changing the value for the property causes the font to be assigned to the <var>TLabel</var> instance used to display the value in Text.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.Title">
|
||||
<short>
|
||||
Title for the popup notification form.
|
||||
Title for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Title</var> is a String property that provides access to the title for the popup notification form. GetTitle is the read access specifier for the property. SetTitle is the write access specifier for the property.
|
||||
<var>Title</var> is a String property that provides access to the title for the pop-up notification form. GetTitle is the read access specifier for the property. SetTitle is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
</element>
|
||||
|
||||
<element name="TPopupNotifier.TitleFont">
|
||||
<short>Font used for the Title displayed on the form.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TitleFont</var> is a <var>TFont</var> property with the font face used for the
|
||||
<var>Title</var> displayed on the form. Changing the value for the property causes the font to be assigned to the <var>TLabel</var> instance used to display the value in Title.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.Visible">
|
||||
<short>
|
||||
Value for the Visible property in the popup notification form.
|
||||
Value for the Visible property in the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Visible</var> is a Boolean property that provides access to the Visible property for the popup notification form. GetVisible is the read access specifier for the property. SetVisible is the write access specifier for the property.
|
||||
<var>Visible</var> is a <var>Boolean</var> property that provides access to the Visible property for the pop-up notification form. GetVisible is the read access specifier for the property. SetVisible is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -741,11 +785,11 @@
|
||||
<!-- property Visibility: published -->
|
||||
<element name="TPopupNotifier.OnClose">
|
||||
<short>
|
||||
OnClose event handler for the popup notification form.
|
||||
OnClose event handler for the pop-up notification form.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>OnClose</var> is a TCloseEven property that provides access to the OnClose event handler for the popup notification form. GetOnClose is the read access specifier for the property. SetOnClose is the write access specifier for the property.
|
||||
<var>OnClose</var> is a TCloseEven property that provides access to the OnClose event handler for the pop-up notification form. GetOnClose is the read access specifier for the property. SetOnClose is the write access specifier for the property.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso></seealso>
|
||||
@ -769,7 +813,21 @@
|
||||
</element>
|
||||
|
||||
<!-- procedure Visibility: default -->
|
||||
<element name="Register"/>
|
||||
<element name="Register">
|
||||
<short>Registers components for use on the Lazarus IDE component palette.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Register adds the following components to the Lazarus IDE component palette:
|
||||
</p>
|
||||
<p>
|
||||
<b>Common Controls</b> Tab
|
||||
</p>
|
||||
<ul>
|
||||
<li>TPopupNotifier</li>
|
||||
</ul>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
</module>
|
||||
<!-- popupnotifier -->
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
====================================================================
|
||||
-->
|
||||
<module name="ReplaceDlgUnit">
|
||||
<short/>
|
||||
<short>Contains the form which implements a Replace Dialog.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Only the .lfm file is used by the LCL (dialogs.pp). This unit is itself is not compiled into the LCL. This form is used to design the .lfm file.
|
||||
@ -31,7 +31,7 @@
|
||||
<element name="ExtCtrls"/>
|
||||
|
||||
<element name="TReplaceDialog">
|
||||
<short/>
|
||||
<short>Forward declaration for the class.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
@ -88,336 +88,574 @@
|
||||
</element>
|
||||
|
||||
<element name="TEditAction">
|
||||
<short>
|
||||
<var>TEditAction </var>- base class for actions associated with the
|
||||
various <var>Edit</var> menu options.
|
||||
</short>
|
||||
<descr/>
|
||||
<short>The base class for standard editing actions applied to an edit control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditAction</var> is a <var>TAction</var> descendant which defines the base class for standard editing actions applied to an edit control. It provides a <var>Control</var> property with the <var>TCustomEdit</var> control where the action is applied. It provides an overridden <var>HandlesTarget</var> method to determine if the action can be applied to a specified control.
|
||||
</p>
|
||||
<p>
|
||||
Do not create instances of TEditAction. Use one of the descendent classes that implement <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods, like:
|
||||
</p>
|
||||
<ul>
|
||||
<li>TEditCut</li>
|
||||
<li>TEditCopy</li>
|
||||
<li>TEditPaste</li>
|
||||
<li>TEditUndo</li>
|
||||
<li>TEditSelectAll</li>
|
||||
<li>TEditDelete</li>
|
||||
</ul>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TAction">TAction</link>
|
||||
<link id="#lcl.actnlist.TCustomAction">TCustomAction</link>
|
||||
<link id="#lcl.actnlist.TContainedAction">TContainedAction</link>
|
||||
<link id="#rtl.classes.TBasicAction">TBasicAction</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.FControl">
|
||||
<short>
|
||||
<var>FControl</var> - local variable holding the Edit control
|
||||
associated with this action.
|
||||
</short>
|
||||
<short>Member with the edit control for the editing action.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.SetControl">
|
||||
<short>
|
||||
<var>SetControl</var> - specifies the Edit control associated with
|
||||
this action.
|
||||
</short>
|
||||
<short>Sets the value for the Control property.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TEditAction.Control"/>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditAction.SetControl.AValue">
|
||||
<short/>
|
||||
<short>New value for the Control property.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.Notification" link="#rtl.classes.TComponent.Notification">
|
||||
<element name="TEditAction.Notification">
|
||||
<short>
|
||||
Handles notifcations when a control in the class instance is added
|
||||
or removed.
|
||||
Handles the notification performed when a component is added to or removed from the class instance.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method on entry. Ensures that the value in the <var>Control</var> member is set to <b>Nil</b> when the component is removed from the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditAction.Notification.AComponent">
|
||||
<short/>
|
||||
<short>Component for the notification.</short>
|
||||
</element>
|
||||
<element name="TEditAction.Notification.Operation">
|
||||
<short/>
|
||||
<short>Operation performed for the component.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.Destroy" link="#rtl.classes.TBasicAction.Destroy">
|
||||
<element name="TEditAction.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
Calls the inherited destructor.
|
||||
</descr>
|
||||
<seealso/>
|
||||
<descr/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.Destroy">TBasicAction.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditAction.HandlesTarget">
|
||||
<short>
|
||||
Indicates if the editing action can be used for the specified target control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>HandlesTarget</var> is a <var>Boolean</var> function which indicates if the editing action can be applied to the object in Target. The return value is <b>True</b> when:
|
||||
</p>
|
||||
<ul>
|
||||
<li>Target has been assigned.</li>
|
||||
<li>Control and Target are the same object instance, or...</li>
|
||||
<li>Control is unassigned, and Target is a TCustomEdit descendant.</li>
|
||||
</ul>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.HandlesTarget">TBasicAction.HandlesTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditAction.HandlesTarget.Result">
|
||||
<short/>
|
||||
<short>True when the action can be applied to the target.</short>
|
||||
</element>
|
||||
<element name="TEditAction.HandlesTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the target control for the action.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditAction.Control">
|
||||
<short>The Edit <var>Control</var> associated with this action.</short>
|
||||
<short>The edit control associated with this action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Limits the target for the action to a specific control.
|
||||
<var>Control</var> is a <var>TCustomEdit</var> property with the control for the standard editing action. Control limits the target for the action to a specific control. Setting a new value for the property causes a free notification to be added or removed as needed for the new property value.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="TEditAction.Notification"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
<link id="#rtl.classes.TComponent.FreeNotification">TComponent.FreeNotification</link>
|
||||
<link id="#rtl.classes.TComponent.RemoveFreeNotification">TComponent.RemoveFreeNotification</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditCut">
|
||||
<short>
|
||||
<var>TEditCut</var>- standard action associated with the
|
||||
<var>Edit Cut</var> menu option.
|
||||
Editing action used to cut the selected value in a control to the clipboard.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditCut</var> is a <var>TEditAction</var> descendant which performs a cut to clipboard editing action for a <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditCut.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditCut.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>CutToClipboard</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.CutToClipboard">TCustomEdit.CutToClipboard</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditCut.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditCut.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditCut.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
Target is the object instance examined in the method. It is cast to the <var>TCustomEdit</var> type used in the <var>Control</var> property. The <var>Enabled</var> property is set to <b>True</b> when the control in Target has an active text selection (<var>SelLength</var> is not 0).
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditCut.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditCopy">
|
||||
<short>
|
||||
<var>TEditCopy</var> - standard action associated with the
|
||||
<var>Edit Copy</var> menu option.
|
||||
Editing action used to copy the selected value in a control to the clipboard.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditCopy</var> is a <var>TEditAction</var> descendant which performs a copy to clipboard editing action for the selected value in a <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditCopy.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditCopy.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>CopyToClipboard</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.CopyToClipboard">TCustomEdit.CopyToClipboard</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditCopy.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditCopy.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditCopy.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
Target is the object instance examined in the method. It is cast to the <var>TCustomEdit</var> type used in the <var>Control</var> property. The <var>Enabled</var> property is set to <b>True</b> when the control in Target has an active text selection (<var>SelLength</var> is not 0).
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditCopy.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditPaste">
|
||||
<short>
|
||||
<var>TEditPaste</var> - standard action associated with the
|
||||
<var>Edit Paste</var> menu option.
|
||||
Editing action used to paste values from the clipboard into the specified control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditPaste</var> is a <var>TEditAction</var> descendant which copies the contents of the clipboard editing action into the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditPaste.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditPaste.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget sets the value in Enabled to True when values in the Clipboard includes the CF_TEXT content format.
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#lcl.clipbrd.Clipboard">Clipboard</link>
|
||||
<link id="#lcl.clipbrd.TClipboard.HasFormat">TClipboard.HasFormat</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditPaste.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditPaste.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditPaste.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>PasteFromClipboard</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.CopyToClipboard">TCustomEdit.PasteFromClipboard</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditPaste.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditSelectAll">
|
||||
<short>
|
||||
<var>TEditSelectAll</var> - standard action associated with the
|
||||
<var>Edit Select All </var>menu option.
|
||||
Editing action used to select all of the content in the value for the specified control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditSelectAll</var> is a <var>TEditAction</var> descendant which selects all of the content in the value for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditSelectAll.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditSelectAll.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>SelectAll</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.SelectAll">TCustomEdit.SelectAll</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditSelectAll.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditSelectAll.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditSelectAll.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and its Text property is checked for an existing text value. UpdateTarget sets the value in Enabled to True when Text is not an empty string ('').
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.Text">TCustomEdit.Text</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditSelectAll.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditUndo">
|
||||
<short>
|
||||
<var>TEditUndo</var> - standard action associated with the
|
||||
<var>Edit Undo</var> menu option.
|
||||
Editing action used to Undo the previous change to the value for the specified control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditUndo</var> is a <var>TEditAction</var> descendant which reverses the previous change to the value for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditUndo.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditUndo.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>Undo</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.Undo">TCustomEdit.Undo</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditUndo.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditUndo.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditUndo.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and its CanUndo method is called to get the value assigned to the Enabled property.
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.CanUndo">TCustomEdit.CanUndo</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditUndo.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditDelete">
|
||||
<short>
|
||||
<var>TEditDelete</var> - standard action associated with the
|
||||
<var>Edit Delete</var> menu option.
|
||||
Editing action used to remove the current selection in the specified control.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>TEditDelete</var> is a <var>TEditAction</var> descendant which removes the current selected text for the specified <var>TCustomEdit</var> control. It re-implements the <var>UpdateTarget</var> and <var>ExecuteTarget</var> methods to use the TCustomEdit type for the affected control.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TEditAction"/>
|
||||
<link id="#lcl.stdctrls.TCustomEdit">TCustomEdit</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TEditDelete.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditDelete.ExecuteTarget">
|
||||
<short>Executes the action for the specified target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>ExecuteTarget</var> is an overridden method used to execute the editing action for the specified target control. It re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
<var>Target</var> is the object instance where the editing action is applied. It is cast to a <var>TCustomEdit</var> type, and its <var>ClearSelection</var> method is called to perform the editing action.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.ClearSelection">TCustomEdit.ClearSelection</link>
|
||||
<link id="#rtl.classes.TBasicAction.ExecuteTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditDelete.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance where the editing action is applied.</short>
|
||||
</element>
|
||||
|
||||
<element name="TEditDelete.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="TEditDelete.UpdateTarget">
|
||||
<short>Updates the enabled state for the action.</short>
|
||||
<descr>
|
||||
<p>
|
||||
<var>UpdateTarget</var> is an overridden method used to update values in the action based on settings in the specified <var>Target</var> control. UpdateTarget re-implements the method introduced in the ancestor class.
|
||||
</p>
|
||||
<p>
|
||||
Target is the object instance with values examined in the method. It is cast to the TCustomEdit type used in the Control property, and sets Enabled to True when text is currently selected in the control.
|
||||
</p>
|
||||
<p>
|
||||
UpdateTarget is called from the <var>UpdateActions</var> method in <var>TCustomForm</var> when actions and action lists are updated during an application idle state.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#lcl.stdctrls.TCustomEdit.SelLength">TCustomEdit.SelLength</link>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TEditDelete.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="THelpAction">
|
||||
<short>
|
||||
<var>THelpAction</var> - base class for actions associated with
|
||||
the various <var>Help</var> menu options.
|
||||
The base class for standard help actions.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>THelpAction</var> is a <var>TAction</var> descendant which implements the base class for help actions. It is used as the ancestor for classes including: THelpContents, THelpTopicSearch, THelpOnHelp , and THelpContextAction.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="THelpContents"/>
|
||||
<link id="THelpTopicSearch"/>
|
||||
<link id="THelpOnHelp"/>
|
||||
<link id="THelpContextAction"/>
|
||||
<link id="#lcl.actnlist.TAction">TAction</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="THelpAction.Create" link="#rtl.classes.TBasicAction.Create">
|
||||
<element name="THelpAction.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
Calls the inherited constructor.
|
||||
<p>
|
||||
Calls the inherited constructor.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="THelpAction.Create.TheOwner">
|
||||
<short>Owner of the class instance.</short>
|
||||
</element>
|
||||
|
||||
<element name="THelpAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="THelpAction.HandlesTarget">
|
||||
<short>Determines whether the help action can be applied to the Target control.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.HandlesTarget">TBasicAction.HandlesTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="THelpAction.HandlesTarget.Result">
|
||||
<short/>
|
||||
<short>True if the action can be applied to the target control.</short>
|
||||
</element>
|
||||
<element name="THelpAction.HandlesTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the control examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="THelpAction.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="THelpAction.UpdateTarget">
|
||||
<short>
|
||||
Updates the enabled state for the action using values in the target control.
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.UpdateTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="THelpAction.UpdateTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with values examined in the method.</short>
|
||||
</element>
|
||||
|
||||
<element name="THelpContents">
|
||||
<short>
|
||||
<var>THelpContents</var> - standard action associated with the
|
||||
<var>Help Contents</var> menu option.
|
||||
Help action used to display a Table of Contents for the HelpContext.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="THelpContents.ExecuteTarget" link="#rtlClasses.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<element name="THelpContents.ExecuteTarget">
|
||||
<short>Executes the help action for the HelpContext.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited method.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.UpdateTarget">TBasicAction.ExecuteTarget</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="THelpContents.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the context for the help action.</short>
|
||||
</element>
|
||||
|
||||
<element name="THelpTopicSearch">
|
||||
<short>
|
||||
<var>THelpTopicSearch</var> - standard action associated with the
|
||||
<var>Help Topic Search</var> menu option.
|
||||
Help action used to search for a help topic.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="THelpTopicSearch.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<element name="THelpTopicSearch.ExecuteTarget">
|
||||
<short>Executes the help action for the help context.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="THelpTopicSearch.ExecuteTarget.Target">
|
||||
<short/>
|
||||
<short>Object instance with the help context.</short>
|
||||
</element>
|
||||
|
||||
<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).
|
||||
Help action used to display the Help on Help topic, or "How to Get Help".
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="THelpOnHelp.ExecuteTarget">
|
||||
<short/>
|
||||
<short>Executes the help action.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -427,15 +665,14 @@
|
||||
|
||||
<element name="THelpContextAction">
|
||||
<short>
|
||||
<var>THelpContextAction</var> - standard action for providing
|
||||
context-sensitive <var>Help</var>.
|
||||
Help action used to get help for a specific help context.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="THelpContextAction.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<short/>
|
||||
<element name="THelpContextAction.ExecuteTarget">
|
||||
<short>Executes the help action.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -443,8 +680,8 @@
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="THelpContextAction.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<short/>
|
||||
<element name="THelpContextAction.UpdateTarget">
|
||||
<short>Updates the enabled state for the help action.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
@ -454,16 +691,19 @@
|
||||
|
||||
<element name="TCommonDialogClass">
|
||||
<short>
|
||||
<var>TCommonDialogClass</var> - class of <var>TCommonDialog</var>.
|
||||
Class reference for the TCommonDialog type.
|
||||
</short>
|
||||
<descr/>
|
||||
<descr>
|
||||
<p>
|
||||
Contains the class reference used to create new dialog instances in TCommonDialogAction. TCommonDialogClass is the type returned from the GetDialogClass method in TCommonDialogAction.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCommonDialogAction">
|
||||
<short>
|
||||
<var>TCommonDialogAction</var> - base class for providing actions
|
||||
associated with <var>Dialogs</var>.
|
||||
Dialog action used to create, configure, and display a dialog.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso>
|
||||
@ -525,26 +765,31 @@
|
||||
</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls GetDialogClass to get the class reference used to create
|
||||
the dialog instance. When assigned, it is created and stored in
|
||||
the Dialog property. It Name is set to the ClassName for the
|
||||
class reference, and it is marked as a sub-component for the
|
||||
class instance.
|
||||
Calls GetDialogClass to get the class reference used to create the dialog instance. When assigned, it is created and stored in the Dialog property. It Name is set to the ClassName for the class reference, and it is marked as a sub-component for the class instance.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TCommonDialogAction.Create" link="#rtl.classes.TBasicAction.Create">
|
||||
<element name="TCommonDialogAction.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<descr>
|
||||
<p>
|
||||
<var>Create</var> is the overridden constructor for the class instance, and calls the inherited method on entry. Create calls <var>CreateDialog</var> to create and configure a new instance of the dialog class type used in the implementation. It sets the value in <var>Enabled</var> to <b>True</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso>
|
||||
<link id="TCommonDialogAction.CreateDialog"/>
|
||||
<link id="TCommonDialogAction.GetDialogClass"/>
|
||||
<link id="#lcl.actnlist.TCustomAction.Enabled">TCustomAction.Enabled</link>
|
||||
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TCommonDialogAction.Create.TheOwner">
|
||||
<short>Owner for the class instance.</short>
|
||||
<short>Owner of the class instance.</short>
|
||||
</element>
|
||||
|
||||
<element name="TCommonDialogAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
|
||||
<element name="TCommonDialogAction.HandlesTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -556,7 +801,7 @@
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TCommonDialogAction.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<element name="TCommonDialogAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -882,7 +1127,7 @@
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TFileExit.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<element name="TFileExit.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
@ -932,13 +1177,15 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TSearchAction.Notification" link="#rtl.classes.TComponent.Notification">
|
||||
<element name="TSearchAction.Notification">
|
||||
<short>
|
||||
Handles notifcations when a control in the class instance is added
|
||||
Handles notifications when a control in the class instance is added
|
||||
or removed.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TSearchAction.Notification.AComponent">
|
||||
<short>Component for the notification.</short>
|
||||
@ -982,42 +1229,36 @@
|
||||
<seealso/>
|
||||
</element>
|
||||
|
||||
<element name="TSearchAction.Create" link="#rtl.classes.TBasicAction.Create">
|
||||
<element name="TSearchAction.Create">
|
||||
<short>Constructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Calls the inherited constructor, and sets the value for the
|
||||
internal Control to <b>Nil</b>.
|
||||
Calls the inherited constructor, and sets the value for the internal Control to <b>Nil</b>.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.Create">TBasicAction.Create</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TSearchAction.Create.TheOwner">
|
||||
<short>Owner for the class instance.</short>
|
||||
</element>
|
||||
|
||||
<element name="TSearchAction.Destroy" link="#rtl.classes.TBasicAction.Destroy">
|
||||
<element name="TSearchAction.Destroy">
|
||||
<short>Destructor for the class instance.</short>
|
||||
<descr>
|
||||
<p>
|
||||
Removes the free notification for the internal Control
|
||||
(when assigned), and calls the inherited destructor.
|
||||
Removes the free notification for the internal Control (when assigned), and calls the inherited destructor.
|
||||
</p>
|
||||
</descr>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TBasicAction.Destroy">TBasicAction.Destroy</link>
|
||||
</seealso>
|
||||
</element>
|
||||
|
||||
<element name="TSearchAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchAction.HandlesTarget.Result">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TSearchAction.HandlesTarget.Target">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TSearchAction.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget"/>
|
||||
<element name="TSearchAction.HandlesTarget.Result"/>
|
||||
<element name="TSearchAction.HandlesTarget.Target"/>
|
||||
|
||||
<element name="TSearchAction.Search">
|
||||
<short>Performs the <var>Search</var> action.</short>
|
||||
@ -1028,23 +1269,19 @@
|
||||
<short/>
|
||||
</element>
|
||||
|
||||
<element name="TSearchAction.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget">
|
||||
<element name="TSearchAction.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchAction.UpdateTarget.Target">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TSearchAction.UpdateTarget.Target"/>
|
||||
|
||||
<element name="TSearchAction.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget">
|
||||
<element name="TSearchAction.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchAction.ExecuteTarget.Target">
|
||||
<short/>
|
||||
</element>
|
||||
<element name="TSearchAction.ExecuteTarget.Target"/>
|
||||
|
||||
<element name="TSearchFind">
|
||||
<short>
|
||||
@ -1180,23 +1417,37 @@
|
||||
<short>Owner of the class instance.</short>
|
||||
</element>
|
||||
|
||||
<element name="TSearchFindNext.HandlesTarget" link="#rtl.classes.TBasicAction.HandlesTarget"/>
|
||||
<element name="TSearchFindNext.HandlesTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchFindNext.HandlesTarget.Result"/>
|
||||
<element name="TSearchFindNext.HandlesTarget.Target"/>
|
||||
|
||||
<element name="TSearchFindNext.UpdateTarget" link="#rtl.classes.TBasicAction.UpdateTarget"/>
|
||||
<element name="TSearchFindNext.UpdateTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchFindNext.UpdateTarget.Target"/>
|
||||
|
||||
<element name="TSearchFindNext.ExecuteTarget" link="#rtl.classes.TBasicAction.ExecuteTarget"/>
|
||||
<element name="TSearchFindNext.ExecuteTarget">
|
||||
<short/>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
</element>
|
||||
<element name="TSearchFindNext.ExecuteTarget.Target"/>
|
||||
|
||||
<element name="TSearchFindNext.Notification" link="#rtl.classes.TComponent.Notification">
|
||||
<element name="TSearchFindNext.Notification">
|
||||
<short>
|
||||
Handles notifcations when a component used in the class instance is
|
||||
Handles notifications when a component used in the class instance is
|
||||
added or removed.
|
||||
</short>
|
||||
<descr/>
|
||||
<seealso/>
|
||||
<seealso>
|
||||
<link id="#rtl.classes.TComponent.Notification">TComponent.Notification</link>
|
||||
</seealso>
|
||||
</element>
|
||||
<element name="TSearchFindNext.Notification.AComponent"/>
|
||||
<element name="TSearchFindNext.Notification.Operation"/>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user