diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index 1d5a42bda6..3e4165fbc0 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -4943,14 +4943,12 @@ Modified in LCL 4.0 to include additional flag values in the enumeration. - -Allows HTML-like hyperlinks in the dialog (in Text, Footer, and ExpandedText) -using the '<a href="target">Target</a>' notation. +Allows HTML-like hyperlinks in the dialog (in Text, FooterText, and +ExpandedText) using the '<a href="target">Target</a>' +notation. For platforms that use an emulated (non-native) task dialog form, +the markup text and not a hyperlink is displayed. @@ -4967,23 +4965,23 @@ dialog. Disables hyperlinks and expanded text areas. -Allow canceling the dialog using the Esc key or Alt+F4 (i.e. OS default +Allow cancelling the dialog using the Esc key or Alt+F4 (i.e. OS default hotkey). - -Custom buttons will be shown as big buttons in the middle of the dialog. Use -#10 to add additional text information to buttons shown as hint text. Disables -hyperlinks. +Custom buttons will be shown as larger buttons with an icon in the text +content area on the dialog. On native task dialog forms, the CommandLinkHint +for buttons is included on a separate line (using a slightly smaller font) on +the buttons. On emulated task dialog forms, the text in the CommandLinkHint +for the buton is omitted. - -Hides glyphs for custom buttons in the "command links" mode. Disables -hyperlinks. +Like tfUseCommandLinks, but hides glyphs for custom buttons in the "command +links" mode. @@ -4992,21 +4990,29 @@ Show ExpandedText in the footer, instead of immediately after the main text. -Displays the dialog with ExpandedText in the expanded state. + +Displays the dialog with the content in ExpandedText in the expanded state. + -Displays the verification check-box verification shows in the checked state. +Displays the verification check-box using the checked state on entry. -Shows a progress bar. + +Shows a progress bar on the dialog form. + -Shows a progress bar using the marquee style. + +Shows a progress bar on the dialog form using the marquee style. + -Execute the timer callback event every 200 milliseconds. + +Execute the timer callback event every 200 milliseconds. Enables the timer event on the dialog form. + @@ -5018,20 +5024,25 @@ poScreenCenter. Use Right-to-Left layout for texts. -Does not pre-select a default radio buttons. + +Does not pre-select a default radio button. + -Allow the dialog to be minimized. + +Allows the dialog form to be minimized. + -Prevents bring the dialog to the foreground when the dialog is activated. +Prevents bringing the dialog to the foreground when the dialog is activated. -Indicates the width for the dialog is determined by the text in the content -areas. The flag is ignored if the dialog width is not set to 0 (zero). +Indicates the width for the dialog is determined by the caption, title, or +lines of text in the the content areas areas. The flag is ignored if the +dialog width is not set to 0 (zero). @@ -5045,25 +5056,29 @@ areas use clForm as the background color instead of clWindow. -Causes a query input control to be displayed on the task dialog using a -combo-box to select from predefined values. +Causes a query input control to be displayed on the task dialog using an +editable (non-fixed) combo-box control. Causes a query input control to be displayed on the task dialog using a simple -TEdit control instance with optional password character obfuscation. +TEdit control instance with optional password character-style obfuscation. +tfQuery takes precedence if both values are included in the flags for a task +dialog. Causes a query input control to be displayed on the task dialog using a -combo-box to select from non-editable predefined values. +combo-box to select from non-editable predefined values. tfQuery must also be +included to enable a query control on the dialog form. -Causes the query input control to be focused when the task dialog is executed. +Causes the query input control to be focused when the task dialog is executed. +Requires tfQuery or tfSimpleQuery in the flags for a task dialog. @@ -5154,10 +5169,27 @@ TCustomTaskDialog. True if the dialog can close. - - - + +Specifies an event handler signalled when the timer callback is enabled in a +task dialog. + + +

+TTaskDlgTimerEvent is an object procedure type which defines an +event handler signalled when the timer internal in a task dialog has elapsed. +Applications can implement and assign a routine using the signature for the +type to the OnTimer event handler in TTaskDialog. +

+

+The routine is signalled from the DoOnTimer method in TCustomTaskDialog and is +called periodically from the widgetset class when the callback timer is +enabled in the task dialog. Arguments passed to the routine indicate the +dialog form for the event notification, the number of ticks (milliseconds) +since the timer was started, and an updatable value to indicate that the time +should be reset. +

+ Added in LCL version 4.0. @@ -5166,13 +5198,20 @@ Added in LCL version 4.0. - + +Task dialog for the event notification. + - + +Number of ticks (milliseconds) since the timer was started. + - + +Set to True to reset the timer. Set to False to continue +execution of the timer callback. + @@ -5712,8 +5751,8 @@ 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 cross-platform implementation similar to the -Windows TaskDialog API. +TaskDialog, and provides a multi-platform implementation of the Windows +TaskDialog API.

TCustomTaskDialog provides properties which can be used to configure the