From 01b0bbdb55388607f9d461b960c93a5f286532a7 Mon Sep 17 00:00:00 2001 From: dsiders Date: Fri, 4 Aug 2023 17:14:28 +0100 Subject: [PATCH] Docs: LCL/dialogs. Updates content in TCustomTaskDialog topics. --- docs/xml/lcl/dialogs.xml | 208 +++++++++++++++++++++++++++++++-------- 1 file changed, 165 insertions(+), 43 deletions(-) diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index f778dc4e07..a895a77677 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -5191,7 +5191,7 @@ should be reset.

-Added in LCL version 4.0. +Added in LCL version 4.0. @@ -5750,26 +5750,83 @@ Defines a configurable, modal task dialog at run-time.

TCustomTaskDialog is a TLCLComponent descendant which -defines a configurable, modal task dialog. It is the base class for -TaskDialog, and provides a multi-platform implementation of the Windows -TaskDialog API. +defines a configurable, modal task dialog. It can be used to display and edit +information on a dialog form with more features than those available on a +standard message box. TCustomTaskDialog includes values like: +

+
    +
  • +A Title for the dialog. +
    • +
  • +A Caption for the dialog. +
    • +
  • +A main Icon for the dialog. +
    • +
  • +Text to describe the task dialog. +
    • +
  • +A footer to display additional information on the dialog. +
    • +
  • +An expandable / collapsible text area which can be displayed in the main +content area or the footer for the dialog. +
    • +
  • +Standard buttons used to return a modal result value. +
    • +
  • +Custom command buttons for task-specific actions. +
    • +
  • +Radio buttons to select dialog options. +
    • +
  • +A progress bar using either the standard or marquee display styles. +
    • +
  • +A query field to capture user input as text or by selecting a value from a list +of values in a combo-box control. +
    • +
  • +A verification message and check box. +
    • +
  • +Support for hyperlinks in text areas. +
    • +
+

+TCustomTaskDialog is the base class for TaskDialog, and provides a +multi-platform implementation of the Windows TaskDialog API. It provides +properties which can be used to configure the task dialog at design-time or at +run-time. At run-time, the Execute method handles converting +properties and calling routines and methods in the widgetset which implement +the task dialog for a given platform.

-TCustomTaskDialog provides properties which can be used to configure the -task dialog at design-time or at run-time. At run-time, the Execute -method handles converting properties and calling routines and methods in the -widgetset which implements the dialog for a given platform. -

- -

-For the Windows platform... +Platform Support

-For other platforms, or Windows versions which do not support the TaskDialog API, the widgetset classes dynamically create... +The TaskDialog API, upon which TCustomTaskDialog and TTaskDialog are based, is +available only on Windows Vista or later versions. On these platforms, the form +displayed at run-time is the native form for the platform. On older Windows +versions, and other platforms, the TaskDialog API is not available or +supported. For these platforms, a standard LCL form is created and populated at +run-time to emulate the appearance and behaviors for the Windows +implementation. This occurs in the widgetget set class and uses the components +found in the taskdlgemulation.pp unit. It can be forced by +including a value in the Flags property for the class instance.

+ +Modified in LCL version 4.0. The implementation for the most part is rewritten, +and includes additional features not found in previous versions. + +TLCLTaskDialog TLCLComponent @@ -5818,10 +5875,15 @@ For other platforms, or Windows versions which do not support the TaskDialog API - - - + +Registers the task dialog class in the widgetset when needed. + + +

+Calls the factory routine in the widgetset implementation if it has not already been registered. +

+ Added in LCL version 4.0. @@ -5923,22 +5985,53 @@ execution. - - - + +Sets the active radio button and signals the OnRadioButtonClicked event handler +(when assigned). + + +

+No actions are performed in the method if OnRadioButtonClicked has +not been assigned. +

+

+Calls SetRadioButtonFromRadioIndex to set RadioButton to the control at the +position specified in the ButtonID argument. RadioButton is set to +Nil if ButtonID is not a valid position in RadioButtons. +

+

+DoOnRadioButtonClicked is called from the OnRadioButtonClicked method in the +TLCLTaskDialog class when an emulated task dialog is used for the platform. +

+ Added in LCL version 4.0. - + + + + + +TLCLTaskDialog.OnRadioButtonClicked + + + +OnRadioButtonClicked is a property in TCustomTaskDialog and a method in +TLCLTaskDIalog. Confusing... + + - + +Index value for the radio button locates and signalled in the method. + - - + +Signals the OnDialogConstructed event handler (when assigned). + Added in LCL version 4.0. @@ -5946,9 +6039,10 @@ Added in LCL version 4.0. - - + +Signals the OnDialogCreated event handler (when assigned). + Added in LCL version 4.0. @@ -5956,9 +6050,10 @@ Added in LCL version 4.0. - - + +Signals the OnDialogDestroyed event handler (when assigned). + Added in LCL version 4.0. @@ -5966,9 +6061,11 @@ Added in LCL version 4.0. - - + +Updates the value in the Expanded property and signals the OnExpanded event +handler (when assigned). + Added in LCL version 4.0. @@ -5976,12 +6073,16 @@ Added in LCL version 4.0. - + +New value for the Expanded property. + - - + +Signals the OnTimer event handler (when assigned) using the specified parameter +values. + Added in LCL version 4.0. @@ -5989,38 +6090,59 @@ Added in LCL version 4.0. - + +Elapsed number of milliseconds since the timer was started. + - + +Set to True to reset (cancel) the timer for the task dialog. +False allows the timer to continue executing. + - - + +Updates Flags to reflect the checked state for the verification control and +signals the OnVerificationClicked event handler (when assigned). + Added in LCL version 4.0. - + + + + + + - + +State for the verification check box control on the dialog. + - - + +Updates the value in URL and signals the OnHyperlinkClicked event handler (when +assigned). + Added in LCL version 4.0. - + + + + - + +New value for the URL property. + @@ -6816,7 +6938,7 @@ Added in LCL version 4.0. Event handler signalled when a hyperlink in one of the text areas has been -clicked. +clicked.