diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index b546c7f619..21b0621fef 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -7227,19 +7227,35 @@ processing loop. - Event handler signalled when the constructor for the dialog form instance has completed. +

+OnDialogConstructed is a TNotifyEvent property with the +event handler signalled when the constructor for the task dialog has completed. +It is signalled (when assigned) from the DoOnDialogConstructed method. +

+

+For native implementations using the Task Dialog API (supported Windows +versions), it occurs when the TDN_DIALOG_CONSTRUCTED notification is handled in +the callback routine for the class instance. For emulated task dialog forms, it +occurs when the overridden AfterConstruction method is called. +

+

+Applications can implement a handler routine to perform actions needed when the +dialog form has been allocated but not yet displayed or executed for the +class instance. +

 Added in LCL version 4.0. -TLCLTaskDialog + +TLCLTaskDialog.CreateNew @@ -7252,32 +7268,53 @@ Event handler signalled when a form instance has been created for the dialog. OnDialogCreated is a TNotifyEvent property with the event handler signalled after a new dialog form instance has been created for the class. It is signalled (when assigned) in the DoOnDialogCreated method, and -occurs when an emulated (non-native) dialog form is created in the widgetset -class instance. It is the the last action performed in the TLCLDialog.Createnew -constructor, and allows the caller to be notified when the LCL form instance is -valid and available to the TTaskDialog owner. +occurs when the dialog form is created for the class instance. +

+

+For native implementations using the Task Dialog API (supported Windows +versions), it occurs when the TDN_CREATED notification is handled in the +callback routine for the class instance. For emulated task dialog forms, it +occurs when the TLCLDialog.CreateNew method is called. It is the last action +performed in the method, and allows the caller to be notified when the LCL form +instance is valid and available to the TTaskDialog owner.

Added in LCL version 4.0. - - - TLCLTaskDialog.CreateNew - - - + +Event handler signalled when the task dialog form has been freed for the class +instance. + + +

+OnDialogDestroyed is a TNotifyEvent property with the +event handler signalled when the dialog form for the class instance has been +freed. It is signalled (when assigned) from the DoOnDialogDestroyed method. +

+

+For native implementations using the Task Dialog API (supported Windows +versions), it occurs when the TDN_DESTROYED notification is handled in the +callback routine for the class instance. For emulated task dialog forms, it +occurs when the TLCLDialog.Destroy method is called. It is the first action +performed in the method, and occurs before the inherited destructor is called +for the LCL form instance. +

+ Added in LCL version 4.0. - + + +TLCLTaskDialog.Destroy + @@ -7372,7 +7409,6 @@ bar position on the widget. - Event handler signalled when a radio button on the dialog has been clicked. @@ -7380,16 +7416,26 @@ Event handler signalled when a radio button on the dialog has been clicked.

OnRadioButtonClicked is a TNotifyEvent property with the -event handler signalled when a radio button on the task dialog has been clicked. +event handler signalled when a radio button on the task dialog has been clicked. It is signalled (when assigned) from the DoOnRadioButtonClicked method, and occurs after the value in RadioButton has been updated to reflect the button identifier clicked on the dialog form. +

+ +

+For native implementations using the Task Dialog API (supported Windows +versions), it occurs when the TDN_RADIO_BUTTON_CLICKED notification is handled +in the callback routine for the class instance. For emulated task dialog forms, +it occurs when the corresponding event handler implementation for the LCL form +instance is called.

Added in LCL version 4.0. - + + +TLCLTaskDialog.OnRadioButtonClick + - Event handler signalled when a hyperlink in one of the text areas has been @@ -7399,8 +7445,22 @@ clicked.

OnHyperlinkClicked is a TNotifyEvent property with the event handler signalled when a hyperlink in one of the text areas on the task -dialog has been clicked. +dialog has been clicked. The URL property contains the target for the hyperlink in the event notification.

+

+Hyperlinks may appear in the Text, ExpandedText, and FooterText properties. +They use the common HTML Anchor notation like: +

+ +<a href="https://www.lazarus-ide.org/">Lazarus website</a> + +

+Include tfEnableHyperlinks in the Flags property to enable display and handling +for hyperlinks in the text areas on the dialog. +

+ +Hyperlinks are automatically disabled when tfQuery or tfSimpleQuery are included in Flags. The textual content for hyperlinks is still displayed - but without formatting and event handler notifications. + @@ -7423,16 +7483,35 @@ Added in LCL version 4.0. - Event handler signalled to display help for the task dialog. - + +

+OnHelp is a TNotifyEvent property with the event handler +signalled to display help for the task dialog. It is signalled (when assigned) +from the DoOnHelp method. +

+

+For native implementations using the Task Dialog API (supported Windows +versions), it occurs when the TDN_HELP notification is handled in +the callback routine for the class instance. For emulated task dialog forms, it +occurs when the F1 key is processed in the KeyDown handler for the LCL form +instance. +

+

+Applications can implement and assign a routine to the handler to perform the +actions needed to display context or keyword help for the dialog. +

+ Added in LCL version 4.0. - + + +TLCLTaskDialog.KeyDown +