diff --git a/docs/xml/lcl/dialogs.xml b/docs/xml/lcl/dialogs.xml index 7704609391..38ba64698c 100644 --- a/docs/xml/lcl/dialogs.xml +++ b/docs/xml/lcl/dialogs.xml @@ -75,6 +75,7 @@ The following components are added to the Lazarus IDE component palette: + @@ -5757,6 +5758,291 @@ the class instance. Ordinal position in the collection for the property value. + + + + + +Added in LCL version 4.0. + + + + + + + + + + + +Added in LCL version 4.0. + + + + + + + + + + + + + + + + + + + + + + + + + + + +Constructor for the class instance. + + +

+Create is the constructor for the class instance. It extends the +constructor to specify the task dialog where the progress bar information is +used in the ADialog argument. It sets the default values for +properties in the class instance, including: Min (0), Max (100), and +MarqueeSpeed (0 milliseconds). +

+
+ +Added in LCL version 4.0. + + +
+ + +Task dialog where the progress bar is hosted. + + + + + +Sends the initial values for the progress bar to the task dialog where it is +hosted. + + +

+Initialize is a method used to apply the values in the progress bar +by notifying the task dialo and ultimately its widget. This includes setting +the progress bar display style, its minimum and maximum range values, the +current position, and the drawing state. +

+

+Initialize is called from the DoOnDialogConstructed method in the task dialog +when the Handle for the task dialog has been assigned. No actions are performed +in the method if the Handle in the task dialog has not been assigned, or when a +progress bar has not been enabled using the flags for the task dialog. +

+
+ +Added in LCL version 4.0. + + + + + + +
+ + + + + +Contains the number of milliseconds between updates for a progress bar using +the marquee style. + + +

+MarqueeSpeed is a Cardinal property. Until there are implementation details, +the usage of the value is undetermined. +

+

+The default value for the property is 0. +

+

+Changing the value for the property causes a TDM_SET_PROGRESS_BAR_RANGE message +top be sent using the Handle for the task dialog. It allows the widgetset class +to be notified when the marquee progress bar style is enabled, or when its +update interval has been changed. +

+
+ +Added in LCL version 4.0. + + + + + + +
+ + + +Upper limit for the Position on the progress bar. + + +

+Max is an Integer property which contains the upper limit +for the position on the progress bar; the value in Position must be in the +range Min..Max inclusive. The default value for the property is 100. +

+

+The value in Min is normalized when a new value is assigned to Max; if Min is +larger than Max, Min is set to the new value for the Max property. +

+

+Changing the property value causes a TDM_SET_PROGRESS_BAR_RANGE message to be +sent using the Handle for the task dialog. This allows the widgetset class to +be notified when the range for the progress bar has been updated. +

+

+Use Min to set the lower limit for the value in Position. +

+

+Use Position to set the current position for the progress bar. +

+

+Position, Min, and Max are not used when the task dialog is configured to use +the marquee drawing style for its progress bar. +

+
+ +Added in LCL version 4.0. + + + + + + + + +
+ + + +Lower limit for the Position on the progress bar. + + +

+Min is an Integer property which contains the lower limit +for the position on the progress bar; the value in Position must be in the +range Min..Max inclusive. The default value for the property is 0. +

+

+The value in Min is normalized when a new value is assigned; if Min is +larger than Max, Min is set to the value in the Max property. +

+

+Changing the property value causes a TDM_SET_PROGRESS_BAR_RANGE message to be +sent using the Handle for the task dialog. This allows the widgetset class to +be notified when the range for the progress bar has been updated. +

+

+Use Max to set the upper limit for the value in Position. +

+

+Use Position to set the current position for the progress bar. +

+

+Position, Min, and Max are not used when the task dialog is configured to use +the marquee drawing style for its progress bar. +

+
+ +Added in LCL version 4.0. + + + + + + + + +
+ + + +Contains the current position for the progress bar. + + +

+Position is an Integer property which indicates the +current position on the progress bar. Position and Max are used to calculate +the completion percentage for the progress bar. The default value for the +property is 0 (zero). +

+

+The value in Position must be in the range Min..Max inclusive. If Position is +set to a value which exceeds the allowed range, its in normalized to the MNin +or Max value as needed. +

+

+Changing the value in the property causes a TDM_SET_PROGRESS_BAR_POS message to +be sent using the Handle for the task dialog. This allows the widgetset class +to be notified when the progress bar needs to be redrawn. +

+

+Use Min to set the lower limit for the value in Position. +

+

+Use Max to set the upper limit for the value in Position. +

+

+Position, Min, and Max are not used when the task dialog is configured to use +the marquee drawing style for its progress bar. +

+
+ +Added in LCL version 4.0. + + + +Does Delphi raise an exception if Position is out of range? + + + + + + + + + +
+ + + + +Contains the current drawing state for the progress bar. + + +

+State is a TProgressBarState property which indicates the +drawing style used to render the progress bar. The default value for the +property is pbsNormal and causes the default drawing style for the platform to +be used. +

+ +
+ +Added in LCL version 4.0. + + +
+ Defines a configurable, modal task dialog at run-time. @@ -5873,6 +6159,7 @@ and includes additional features not found in previous versions. + @@ -6077,7 +6364,10 @@ Signals the OnDialogConstructed event handler (when assigned). Added in LCL version 4.0. - + + + + @@ -6324,6 +6614,7 @@ properties like:
  • QueryChoices
  • CustomMainIcon
  • CustomFooterIcon
  • +
  • ProgressBar
  • Create sets the default values for the following properties: @@ -6352,6 +6643,7 @@ Create sets the default values for the following properties: + @@ -6364,8 +6656,8 @@ Create sets the default values for the following properties:

    Destroy is the overridden destructor for the class instance. It frees resources allocated for the Buttons, RadioButtons, QueryChoices, -CustomFooterIcon and CustomMainIcon properties. It calls the inherited method -prior to exit. +CustomFooterIcon, CustomMainIcon, and ProgressBar properties. It calls the +inherited method prior to exit.

    @@ -6374,6 +6666,7 @@ prior to exit. +
    @@ -6979,6 +7272,34 @@ dialog was displayed, or mrNone if the dialog was cancelled.
    + + +Contains information used to configure and update a progress bar enabled on the +task dialog. + + +

    +ProgressBar is a TTaskDialogProgressBar property which +contains range, position, and state information for a progress bar enabled on +the task dialog. Changes to property values in ProgressBar cause the widgetset +class to be updated and redrawn. The Handle for the dialog is used to send task +dialog messages to the widget with the new values for the members. +

    +

    +Use the Flags property to enable a progress bar on the task dialog. +tfShowProgressBar enables a conventional progress bar which displays completion +percentage. tfShowMarqueeProgressBar enables the scrolling marquee-style +progress bar. +

    +
    + +Added in LCL version 4.0. + + + + +
    + Predefined values for the query control on the task dialog. @@ -7863,6 +8184,7 @@ and includes additional features not found in previous versions. +