From 8ea00ae159846e87afd262e8bf5765eeff33a840 Mon Sep 17 00:00:00 2001 From: dsiders Date: Fri, 9 Jul 2021 03:06:46 +0000 Subject: [PATCH] Docs: LCL,LazUtils. Updates topic content. Fixes broken or missing links. Fixes spelling errors. git-svn-id: trunk@65424 - --- docs/xml/lazutils/textstrings.xml | 4 +- docs/xml/lcl/comboex.xml | 2 +- docs/xml/lcl/dialogs.xml | 2 +- docs/xml/lcl/lazcanvas.xml | 28 +- docs/xml/lcl/ldocktree.xml | 23 +- docs/xml/lcl/lresources.xml | 396 ++++++++++++------ docs/xml/lcl/popupnotifier.xml | 154 ++++--- docs/xml/lcl/replacedlgunit.xml | 4 +- docs/xml/lcl/stdactns.xml | 669 ++++++++++++++++++++---------- 9 files changed, 877 insertions(+), 405 deletions(-) diff --git a/docs/xml/lazutils/textstrings.xml b/docs/xml/lazutils/textstrings.xml index 47504d0c50..186311cbd7 100644 --- a/docs/xml/lazutils/textstrings.xml +++ b/docs/xml/lazutils/textstrings.xml @@ -577,7 +577,7 @@ Starts an update process for the component.

- BeginUpdate is a method used to start an update process for the component. It increments an internal update counter used to consolidate OnChanging and OnChange event notifcations. The counter value is used in the Changing and Changed methods, and controls when the event notifications are enabled and performed. + BeginUpdate is a method used to start an update process for the component. It increments an internal update counter used to consolidate OnChanging and OnChange event notifications. The counter value is used in the Changing and Changed methods, and controls when the event notifications are enabled and performed.

Use EndUpdate to decrement the internal update counter. @@ -600,7 +600,7 @@ EndUpdate is a method used to finish an active update process for the component.

- For each call to BeginUpdate, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate OnChanging and OnChange event notifcations. + For each call to BeginUpdate, there needs to be a corresponding call to EndUpdate. The methods are used as a pair to consolidate OnChanging and OnChange event notifications.

EndUpdate decrements the internal update counter incremented by calling BeginUpdate. When the update counter is a postive non-zero value, the Changed method is not called and the OnChange event handler is not signalled. diff --git a/docs/xml/lcl/comboex.xml b/docs/xml/lcl/comboex.xml index e4dc3e9b30..b03343d81f 100644 --- a/docs/xml/lcl/comboex.xml +++ b/docs/xml/lcl/comboex.xml @@ -697,7 +697,7 @@ - Performs a notifcation when an item in the collection has been changed. + Performs a notification when an item in the collection has been changed.

Update is an overridden method in TListControlItems used to send a notification to observers when the value in AItem has been changed. Update calls the inherited method in TCollection. diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index 9e6bb47999..9c65e2206d 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -3569,7 +3569,7 @@ ADialog.FooterText := '(c) Copyright 1960-2021, Acme Corporation LLC.' + #10 +

- RadioButtons is a TTaskDialogButtons proprety with the collection of defined radio buttons for the Task dialog. + RadioButtons is a TTaskDialogButtons property with the collection of defined radio buttons for the Task dialog.

Radio buttons are displayed in the main content area for the Task dialog, below the values in Text and ExpandedText. Use of radio buttons is optional. They are displayed when items have been added to the collection. The TTaskDialogRadioButtonItem items in the collection are passed as an argument when the Execute method is called. diff --git a/docs/xml/lcl/lazcanvas.xml b/docs/xml/lcl/lazcanvas.xml index 623b1a02d4..eb93159d8d 100644 --- a/docs/xml/lcl/lazcanvas.xml +++ b/docs/xml/lcl/lazcanvas.xml @@ -92,16 +92,16 @@ - + Horizontal coordinate. - + Vertical coordinate. - + Width for the output. - + Height for the output. @@ -456,6 +456,24 @@ + + Member with extra FreeType font data from the canvas or device context. + Used in custom-drawn LCL controls. + + + + + Member with the TLazCanvasImageFormat instance used to speed up drawing. + + + + + + Member with the GDI Handle for an image. + Used in custom-drawn LCL controls. + + + Constructor for the class instance. @@ -577,7 +595,7 @@ - + Performs an AlphaBlend operation assuming a white background.

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. diff --git a/docs/xml/lcl/ldocktree.xml b/docs/xml/lcl/ldocktree.xml index d1e19ec42a..2c9401b948 100644 --- a/docs/xml/lcl/ldocktree.xml +++ b/docs/xml/lcl/ldocktree.xml @@ -317,8 +317,12 @@ - - + Gets the control with the specified dock zone and anchor side. + +

+ Returns the DockSite if no controls are found using the specified zone and anchor side. +

+ @@ -495,18 +499,11 @@ + - - - - - - - - - - - + + + diff --git a/docs/xml/lcl/lresources.xml b/docs/xml/lcl/lresources.xml index f490cb271a..b89206d2bc 100644 --- a/docs/xml/lcl/lresources.xml +++ b/docs/xml/lcl/lresources.xml @@ -8,7 +8,7 @@ --> - 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.

@@ -32,9 +32,13 @@ + + + + @@ -52,21 +56,21 @@ - + + Signature for a the version of the TFiler instance used to read or write value using a Lazarus Resource Stream (LRS file). + - The Lazarus resource descriptor class. - + Describes a Lazarus resource stored in TLResourceList. - - The resource name. + Name for the Lazarus resource. @@ -78,50 +82,52 @@ - The resource value. + The value for the resource. - The container class for all Lazarus resources. - + Container class used for Lazarus resource descriptions. - - Main list with all resource pointers. + Member with the list for resource descriptions. - List needed for mergesort. + List used to MergeSort resources in the list. - 0 .. FSortedCount-1 resources are sorted. + The number of resource descriptions in the sorted list. - Returns the index of the named resource, -1 if not found. - - The list is sorted, if required. + Returns the index of the named resource, or -1 if not found. + +

+ The list is sorted, if required. +

- + + Ordinal position for the named resource in the list, or -1 when not found. + - + Name of the resource to locate in the list of descriptions. @@ -140,7 +146,7 @@ - MergeSort sorting part. + Implements a MergeSort for the resource descriptions in the list. @@ -180,33 +186,51 @@ - + + Constructor for the class instance. + +

+ Allocates resources needed for the internal lists used in the class instance, and sets the default values for internal members. +

+ + + - + + Destructor for the class instance. + +

+ Frees the values in and resources allocated to the internal lists for the class instance. +

+ + + - Adds a resource. - ValueType is stored in uppercase. + Adds a resource description to the list with the specified values. + +

+ ValueType is stored in uppercase. +

- + Name for the resource. - + Name for the Type used in the value. - A sinlge value string. + A single AnsiString value string for the type. - The value split into an string array. + An array with the String values for the type. - Returns the resource of the given name (and type). - + Returns the resource in the list with the given name and type. @@ -222,17 +246,17 @@ - The number of listed resources. + Gets the number of resource descriptions in the list. - + The number of resource descriptions in the list. - Indexed access to the resource list. + Provides Indexed access to the resource descriptions in the list. @@ -309,7 +333,15 @@ - + + Destructor for the class instance. + +

+ Calls the UnlockResource and FreeResource routines when resource descriptors are used for the platform. Calls the inherited method prior to exit. +

+ + + Raises an error on an attempt to write to the stream. @@ -336,38 +368,66 @@ - Abstract base class for translators. + Abstract base class for translators used in the LCL. +

+ TAbstractTranslator is a class which specifies the base class string and property translators used in the Lazarus Component Library (LCL). It defines an abstract virtual method used to translate string properties when they are read from a Lazarus Resource Stream (LRS). +

+

+ Do not create instances of TAbstractTranslator; use one of the descendent class like TUpdateTranslator, TDefaultTranslator, or TPOTranslator. +

- - + + TUpdateTranslator + TDefaultTranslator + TPOTranslator + - The base class for an TReader.OnReadStringProperty handler. + Specifies a method used to translate a String property. +

+ TranslateStringProperty is an abstract virtual method which defines the method used to translate a String 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. +

+

+ The address for the method is assigned as the OnReadStringProperty event handler in TReader class instances. +

- - + + + TReader + TFiler + - + Object for the event notification. - + Persistent object with the property value translated in the method. - + RTTI information for the property translated in the method. - + + Variable parameter where the translated value for the property is returned. + - The default translator instance to use in . + + Variable with the default translator used in CreateLRSReader. - - + +

+ The value for the variable is assigned when SetDefaultLang is called. +

+ + + + SetDefaultLang + @@ -396,14 +456,15 @@ - + Name for the item on the LRS Reader Object stack. - - + Identifies the type for the stack item. + + @@ -1554,13 +1615,33 @@ - + + Constructor for the class instance. + +

+ Allocates the internal list used to store values in the Data property. +

+ + + - + + Destructor for the class instance. + +

+ Frees resources allocated for the Data property, and calls the inherited method prior to exit. +

+ + + - - + Removes items stored in the Data property. + +

+ Sets the value in the Count property to 0, which causes the items stored in Data to be freed. +

+ @@ -1626,7 +1707,9 @@ - + + Adds a new item to the Data property using the specified positions and pointer to the item data. + @@ -1934,12 +2017,31 @@ - + + Constructor for the class instance. + +

+ Create is the constructor for the class instance. +

+

+ 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. +

+ + + - + Stream with the values parser in the class. - + + Destructor for the class instance. + +

+ Destroy is the overridden destructor for the class instance. It moves the stream to the position returned from SourcePos (the position for the last processed value in the internal buffer). Destroy free the memory allocated for the internal buffer in the class instance. +

+ + + Asserts that Token is of the expected type. @@ -2115,77 +2217,90 @@ - + - A queue to stream components, used for multithreading or network. - + A queue to stream components, used for multithreading or network.

- The function ConvertComponentAsString converts a component to binary format - with a leading size information (using WriteLRSInt64MB). -

- When streaming components over network, they will arrive in chunks. -

- TCustomLazComponentQueue tells you, if a whole component has arrived. + ConvertComponentAsString converts a component to binary format with a leading size information (using WriteLRSInt64MB). +

+

+ When streaming components over network, they will arrive in chunks. TCustomLazComponentQueue tells you, if a whole component has arrived.

- - - - + Member with the dynamic storage for the queue.. - + Reads the component size and the length for the size value. - + False if there is not enough storage in the queue for the component size. - + Size of the component. - + Number of bytes needed for the component size value. - + + Constructor for the class instance. + +

+ Allocates resources needed for the internal queue storage. +

+ + + - + Owner of the class instance. - + + Destructor for the class instance. + +

+ Frees resources allocated to the internal queue storage. +

+ + + + - + Clears all values in the internal queue storage. - + Pushes values in Buffer onto the internal storage queue. - + Number of bytes added to the queue in the method. - + Untyped buffer with values pushed onto the internal queue storage. - + Number of bytes in Buffer. - + + Copies the specified number of bytes from the stream and pushes the values onto the queue. + @@ -2200,7 +2315,9 @@ - + + Determines whether the queue contains the entire contents of the component at the top of the queue. + @@ -2209,7 +2326,7 @@ - + Reads a component from the queue and sets it owner. @@ -2224,8 +2341,8 @@ - Converts a component to binary format - with a leading size information (using WriteLRSInt64MB). + + Converts a component to binary format with a leading size information (using WriteLRSInt64MB). @@ -2238,57 +2355,71 @@ - + + Event handler signalled to get the class type for the specified class name in a TReader instance. + - + - + Publishes property from the ancestor class. + + - + Published Name for the component queue. - + + Published event handler used to get the class type for a give class name. + - + - Item of TPropertiesToSkip. - + + Contains information about a property omitted from LCL component streaming. + + +

+ TPropertyToSkip 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. +

+ - + Class type for the persistent object with the omitted property. - + Name for the omitted property. - + A note about the omitted property. - + Help keyword for the omitted property. - + - + + Implements a list used to store properties which are skipped during LCL streaming. + @@ -2318,7 +2449,9 @@ - + + Handles a notification action when the specified Pointer is added to or removed from the list. + @@ -2330,7 +2463,9 @@ - + + Determines if the specified property type and name exists and is handled in the list. + @@ -2354,51 +2489,63 @@ - + + Gets the ordinal position in the list where the property type and name is stored. + - + Ordinal position in the list, or -1 when not found. - + Property instance to locate in the list. - + Name for the property type to locate in the list. - + Class type for the property to located in the list. - + + Adds the specified property type and name to the list when not already present. + - + + Ordinal position in the list where the skipped property was found or stored. + - + Class type for the skipped property. - + Name for the skipped property. - + Note to associate with the skipped property. - + Help keyword for the skipped property. - - + + Provides indexed access to skipped properties in the list by their ordinal position. + + +

+ 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. +

+ - + Ordinal position for the indexed property value. @@ -2418,25 +2565,25 @@ - The list of all loaded standard resources. + The list with all of the loaded standard resources. - + Unit global variable with all of the registered skipped properties. - + Class type for Lazarus Object Reader instances. - + Class type for Lazarus Object Writer instances. @@ -2688,9 +2835,10 @@ - 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. + +

+ 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. +

diff --git a/docs/xml/lcl/popupnotifier.xml b/docs/xml/lcl/popupnotifier.xml index 006e72d602..43feaa8a75 100644 --- a/docs/xml/lcl/popupnotifier.xml +++ b/docs/xml/lcl/popupnotifier.xml @@ -9,12 +9,15 @@ Please note that ExtCtrls has a dependency on the popupnotifier unit; circular dependencies between popupnotifier and other units should be avoided. +

+ This file is part of the Lazarus Component Library (LCL). +

- Button states for the popup notifier buttons. + Button states for the pop-up notifier buttons.

@@ -194,31 +197,33 @@

- TNotifierForm 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. + TNotifierForm 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 on the pop-up notification form.TNotifierForm provides methods which paint, hide, and handle resizing for the form.

- - + + + + - Title for the form. + Label with the Title for the form. - Text for the form. + Label with the Text for the form. - Icon for the form. + Image with the Icon for the form. - Button for the form. + Custom Button for the form. @@ -234,7 +239,6 @@ HideForm is assigned as the OnClick event handler in TLabel and TNotifierXButton members created for the form.

- @@ -276,7 +280,7 @@ - + Constructor for the class instance.

Create 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 @@ + + Draws the form background and icon image. + +

+ 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. +

+

+ Paint re-implements the method, and does not call the inherited method. +

+ + + + + + + + + + - Implements a popup notification component. + Implements a pop-up notification component.

- TPopupNotifier 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. + TPopupNotifier 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.

@@ -336,7 +359,7 @@

- GetColor 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. + GetColor 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.

Use Color to read or write the value for the property. @@ -357,7 +380,7 @@

- SetColor 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. + SetColor 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.

Use Color to read or write the value for the property. @@ -378,7 +401,7 @@

- GetIcon is a TPicture function which gets the icon for the popup notification form. GetIcon is the read access specifier for the Icon property. + GetIcon is a TPicture function which gets the icon for the pop-up notification form. GetIcon is the read access specifier for the Icon property.

Use Icon to read or write the value for the property. @@ -397,7 +420,7 @@ Sets the icon for the notification form.

- SetIcon 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. + SetIcon 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.

Use Icon to read or write the value in the property. @@ -418,7 +441,7 @@

- GetText 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. + GetText 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.

Use Text to read or write the value for the property. @@ -439,7 +462,7 @@

- SetText 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. + SetText 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.

Use Text to read or write the value for the property. @@ -458,7 +481,7 @@ Gets the title for the notification form.

- GetTitle 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. + GetTitle 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.

Use Title to read or write the value in the property. @@ -479,7 +502,7 @@

- SetTitle 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. + SetTitle 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.

Use Title to read or write the value for the property. @@ -500,7 +523,7 @@

- GetVisible 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. + GetVisible 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.

Use Visible to read or write the value for the property. @@ -521,13 +544,13 @@

- SetVisible 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. + SetVisible 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.

Use Visible to read or write the value for the property.

- 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.

@@ -545,7 +568,7 @@

- GetOnClose 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. + GetOnClose 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.

Use OnClose to read or write the value for the property. @@ -562,11 +585,11 @@ - Sets the OnClose event handler for the popup notification form. + Sets the OnClose event handler for the pop-up notification form.

- SetOnClose 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. + SetOnClose 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.

Use OnClose to read or write the value in the property. @@ -583,11 +606,11 @@ - Form which displays the popup notification. + Form which displays the pop-up notification.

- vNotifierForm 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. + vNotifierForm is a public TNotifierForm 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.

@@ -618,7 +641,7 @@

- Destroy 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. + Destroy is the destructor for the component instance. Destroy calls the Hide method for the pop-up notification form, and frees the the vNotifierForm member. Destroy calls the inherited destructor prior to exiting from the method.

@@ -627,11 +650,11 @@ - Hides the popup notification form. + Hides the pop-up notification form.

- Hide is a procedure which hides the popup notification form for the component. Hide calls the Hide method in VNotifierForm. + Hide is a procedure which hides the pop-up notification form for the component. Hide calls the Hide method in VNotifierForm.

@@ -640,11 +663,11 @@ - Displays the popup notification. + Displays the pop-up notification.

- Show is a procedure which displays the popup notification form for the component. Show calls the Show method in vNotifierForm. + Show is a procedure which displays the pop-up notification form for the component. Show calls the Show method in vNotifierForm.

@@ -653,11 +676,11 @@ - Displays the popup notification form at the specified position. + Displays the pop-up notification form at the specified position.

- ShowAtPos 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. + ShowAtPos 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 TPopupMenu. ShowAtPos calls the Show method in vNotifierForm to display the pop-up notification form.

@@ -676,11 +699,11 @@ - Color for the popup notification form. + Color for the pop-up notification form.

- Color 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. + Color is a TColor 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.

@@ -689,11 +712,11 @@ - Icon for the popup notification form. + Icon for the pop-up notification form.

- Icon 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. + Icon is a TPicture 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.

@@ -702,37 +725,58 @@ - Text for the popup notification form. + Text for the pop-up notification form.

- Text 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. + Text 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.

+ + Font used for the Text displayed on the form. + +

+ TextFont is a TFont property with the font face used for the Text displayed on the form. Changing the value for the property causes the font to be assigned to the TLabel instance used to display the value in Text. +

+ + + + - Title for the popup notification form. + Title for the pop-up notification form.

- Title 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. + Title 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.

+ + Font used for the Title displayed on the form. + +

+ TitleFont is a TFont property with the font face used for the + Title displayed on the form. Changing the value for the property causes the font to be assigned to the TLabel instance used to display the value in Title. +

+ + + + - Value for the Visible property in the popup notification form. + Value for the Visible property in the pop-up notification form.

- Visible 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. + Visible is a Boolean 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.

@@ -741,11 +785,11 @@ - OnClose event handler for the popup notification form. + OnClose event handler for the pop-up notification form.

- OnClose 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. + OnClose 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.

@@ -769,7 +813,21 @@ - + + Registers components for use on the Lazarus IDE component palette. + +

+ Register adds the following components to the Lazarus IDE component palette: +

+

+ Common Controls Tab +

+
    +
  • TPopupNotifier
    • +
+ + + diff --git a/docs/xml/lcl/replacedlgunit.xml b/docs/xml/lcl/replacedlgunit.xml index 4c13ef9e4d..e2001e485b 100644 --- a/docs/xml/lcl/replacedlgunit.xml +++ b/docs/xml/lcl/replacedlgunit.xml @@ -7,7 +7,7 @@ ==================================================================== --> - + Contains the form which implements a Replace Dialog.

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 @@ - + Forward declaration for the class. diff --git a/docs/xml/lcl/stdactns.xml b/docs/xml/lcl/stdactns.xml index f27f508cd1..34bdce81cd 100644 --- a/docs/xml/lcl/stdactns.xml +++ b/docs/xml/lcl/stdactns.xml @@ -88,336 +88,574 @@ - - TEditAction - base class for actions associated with the - various Edit menu options. - - + The base class for standard editing actions applied to an edit control. + +

+ TEditAction is a TAction descendant which defines the base class for standard editing actions applied to an edit control. It provides a Control property with the TCustomEdit control where the action is applied. It provides an overridden HandlesTarget method to determine if the action can be applied to a specified control. +

+

+ Do not create instances of TEditAction. Use one of the descendent classes that implement UpdateTarget and ExecuteTarget methods, like: +

+
    +
  • TEditCut
    • +
  • TEditCopy
    • +
  • TEditPaste
    • +
  • TEditUndo
    • +
  • TEditSelectAll
    • +
  • TEditDelete
    • +
+ TAction + TCustomAction + TContainedAction + TBasicAction - - FControl - local variable holding the Edit control - associated with this action. - + Member with the edit control for the editing action. - - SetControl - specifies the Edit control associated with - this action. - + Sets the value for the Control property. - + + + - + New value for the Control property. - + - 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. - - + +

+ Calls the inherited method on entry. Ensures that the value in the Control member is set to Nil when the component is removed from the class instance. +

+ + + TComponent.Notification + - + Component for the notification. - + Operation performed for the component. - + Destructor for the class instance. - - Calls the inherited destructor. - - + + + TBasicAction.Destroy + - - - - + + + Indicates if the editing action can be used for the specified target control. + + +

+ HandlesTarget is a Boolean function which indicates if the editing action can be applied to the object in Target. The return value is True when: +

+
    +
  • Target has been assigned.
    • +
  • Control and Target are the same object instance, or...
    • +
  • Control is unassigned, and Target is a TCustomEdit descendant.
    • +
+ + + TBasicAction.HandlesTarget + - + True when the action can be applied to the target. - + Object instance with the target control for the action. - The Edit Control associated with this action. + The edit control associated with this action.

- Limits the target for the action to a specific control. + Control is a TCustomEdit 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.

- + + + TCustomEdit + TComponent.FreeNotification + TComponent.RemoveFreeNotification + - TEditCut- standard action associated with the - Edit Cut menu option. + Editing action used to cut the selected value in a control to the clipboard. - + +

+ TEditCut is a TEditAction descendant which performs a cut to clipboard editing action for a TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + TCustomEdit - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its CutToClipboard method is called to perform the editing action. +

+ + + TCustomEdit.CutToClipboard + TBasicAction.ExecuteTarget + - + Object where the editing action is applied. - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ Target is the object instance examined in the method. It is cast to the TCustomEdit type used in the Control property. The Enabled property is set to True when the control in Target has an active text selection (SelLength is not 0). +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + TBasicAction.UpdateTarget + - + Object instance with the values examined in the method. - TEditCopy - standard action associated with the - Edit Copy menu option. + Editing action used to copy the selected value in a control to the clipboard. - + +

+ TEditCopy is a TEditAction descendant which performs a copy to clipboard editing action for the selected value in a TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + TCustomEdit - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its CopyToClipboard method is called to perform the editing action. +

+ + + TCustomEdit.CopyToClipboard + TBasicAction.ExecuteTarget + - + Object where the editing action is applied. - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ Target is the object instance examined in the method. It is cast to the TCustomEdit type used in the Control property. The Enabled property is set to True when the control in Target has an active text selection (SelLength is not 0). +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + TBasicAction.UpdateTarget + - + Object instance with the values examined in the method. - TEditPaste - standard action associated with the - Edit Paste menu option. + Editing action used to paste values from the clipboard into the specified control. - - + +

+ TEditPaste is a TEditAction descendant which copies the contents of the clipboard editing action into the specified TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + + + TCustomEdit + - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ UpdateTarget sets the value in Enabled to True when values in the Clipboard includes the CF_TEXT content format. +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + Clipboard + TClipboard.HasFormat + TBasicAction.UpdateTarget + - + Object instance with values examined in the method. - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its PasteFromClipboard method is called to perform the editing action. +

+ + + TCustomEdit.PasteFromClipboard + TBasicAction.ExecuteTarget + - + Object instance where the editing action is applied. - TEditSelectAll - standard action associated with the - Edit Select All menu option. + Editing action used to select all of the content in the value for the specified control. - - + +

+ TEditSelectAll is a TEditAction descendant which selects all of the content in the value for the specified TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + + + TCustomEdit + - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its SelectAll method is called to perform the editing action. +

+ + + TCustomEdit.SelectAll + TBasicAction.ExecuteTarget + - + Object instance where the editing action is applied. - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ 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 (''). +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + TCustomEdit.Text + TBasicAction.UpdateTarget + - + Object instance with values examined in the method. - TEditUndo - standard action associated with the - Edit Undo menu option. + Editing action used to Undo the previous change to the value for the specified control. - - + +

+ TEditUndo is a TEditAction descendant which reverses the previous change to the value for the specified TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + + + TCustomEdit + - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its Undo method is called to perform the editing action. +

+ + + TCustomEdit.Undo + TBasicAction.ExecuteTarget + - + Object instance where the editing action is applied. - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ 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. +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + TCustomEdit.CanUndo + TBasicAction.UpdateTarget + - + Object instance with the values examined in the method. - TEditDelete - standard action associated with the - Edit Delete menu option. + Editing action used to remove the current selection in the specified control. - - + +

+ TEditDelete is a TEditAction descendant which removes the current selected text for the specified TCustomEdit control. It re-implements the UpdateTarget and ExecuteTarget methods to use the TCustomEdit type for the affected control. +

+ + + + TCustomEdit + - - - - + + Executes the action for the specified target control. + +

+ ExecuteTarget 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. +

+

+ Target is the object instance where the editing action is applied. It is cast to a TCustomEdit type, and its ClearSelection method is called to perform the editing action. +

+ + + TCustomEdit.ClearSelection + TBasicAction.ExecuteTarget + - + Object instance where the editing action is applied. - - - - + + Updates the enabled state for the action. + +

+ UpdateTarget is an overridden method used to update values in the action based on settings in the specified Target control. UpdateTarget re-implements the method introduced in the ancestor class. +

+

+ 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. +

+

+ UpdateTarget is called from the UpdateActions method in TCustomForm when actions and action lists are updated during an application idle state. +

+ + + TCustomAction.Enabled + TCustomEdit.SelLength + TBasicAction.UpdateTarget + - + Object instance with values examined in the method. - THelpAction - base class for actions associated with - the various Help menu options. + The base class for standard help actions. - + +

+ THelpAction is a TAction descendant which implements the base class for help actions. It is used as the ancestor for classes including: THelpContents, THelpTopicSearch, THelpOnHelp , and THelpContextAction. +

+ + + + + TAction - + Constructor for the class instance. - Calls the inherited constructor. +

+ Calls the inherited constructor. +

- + + TBasicAction.Create + Owner of the class instance. - - - - + + Determines whether the help action can be applied to the Target control. + +

+ Calls the inherited method. +

+ + + TBasicAction.HandlesTarget + - + True if the action can be applied to the target control. - + Object instance with the control examined in the method. - - - - + + + Updates the enabled state for the action using values in the target control. + + +

+ Calls the inherited method. +

+ + + TBasicAction.UpdateTarget + - + Object instance with values examined in the method. - THelpContents - standard action associated with the - Help Contents menu option. + Help action used to display a Table of Contents for the HelpContext. - - - - + + Executes the help action for the HelpContext. + +

+ Calls the inherited method. +

+ + + TBasicAction.ExecuteTarget + - + Object instance with the context for the help action. - THelpTopicSearch - standard action associated with the - Help Topic Search menu option. + Help action used to search for a help topic. - + + - - + + Executes the help action for the help context. - + Object instance with the help context. - THelpOnHelp - standard action associated with the - Help On Help menu item (i.e. how to get help). + Help action used to display the Help on Help topic, or "How to Get Help". - + Executes the help action. @@ -427,15 +665,14 @@ - THelpContextAction - standard action for providing - context-sensitive Help. + Help action used to get help for a specific help context. - - + + Executes the help action. @@ -443,8 +680,8 @@ - - + + Updates the enabled state for the help action. @@ -454,16 +691,19 @@ - TCommonDialogClass - class of TCommonDialog. + Class reference for the TCommonDialog type. - + +

+ Contains the class reference used to create new dialog instances in TCommonDialogAction. TCommonDialogClass is the type returned from the GetDialogClass method in TCommonDialogAction. +

+ - TCommonDialogAction - base class for providing actions - associated with Dialogs. + Dialog action used to create, configure, and display a dialog. @@ -525,26 +765,31 @@

- 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.

- + Constructor for the class instance. - - + +

+ Create is the overridden constructor for the class instance, and calls the inherited method on entry. Create calls CreateDialog to create and configure a new instance of the dialog class type used in the implementation. It sets the value in Enabled to True. +

+ + + + + TCustomAction.Enabled + TBasicAction.Create + - Owner for the class instance. + Owner of the class instance. - + @@ -556,7 +801,7 @@ - + @@ -882,7 +1127,7 @@ - + @@ -932,13 +1177,15 @@ - + - Handles notifcations when a control in the class instance is added + Handles notifications when a control in the class instance is added or removed. - + + TComponent.Notification + Component for the notification. @@ -982,42 +1229,36 @@ - + Constructor for the class instance.

- Calls the inherited constructor, and sets the value for the - internal Control to Nil. + Calls the inherited constructor, and sets the value for the internal Control to Nil.

- + + TBasicAction.Create + Owner for the class instance. - + Destructor for the class instance.

- 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.

- + + TBasicAction.Destroy + - - - - - - - - - - - + + + Performs the Search action. @@ -1028,23 +1269,19 @@ - + - - - + - + - - - + @@ -1180,23 +1417,37 @@ Owner of the class instance. - + + + + + - + + + + + - + + + + + - + - 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. - + + TComponent.Notification +