paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-08-12 07:55:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: LCL/dialogs. Adds or updates content in topics.

Browse Source 
* TProgressBarState
* PBST_NORMAL
* PBST_ERROR
* PBST_PAUSED
* TTaskDialogProgressBar
This commit is contained in:
dsiders 2023-08-24 18:05:31 +01:00
parent a26ce07b0c
commit db6d6937fe
1 changed files with 58 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

83
docs/xml/lcl/dialogs.xml
View File

@ -5758,9 +5758,10 @@ the class instance.
<short>Ordinal position in the collection for the property value.</short> <short>Ordinal position in the collection for the property value.</short>
</element> </element>
<!-- TODO: Needs content. -->
<element name="TProgressBarState"> <element name="TProgressBarState">
<short/> <short>
Alias to the TProgressBarState type in <file>comctrls.pp</file>.
</short>
<descr/> <descr/>
<version> <version>
Added in LCL version 4.0. Added in LCL version 4.0.
@ -5770,35 +5771,68 @@ Added in LCL version 4.0.
</seealso> </seealso>
</element> </element>
<!-- TODO: Needs content. -->
<element name="PBST_NORMAL"> <element name="PBST_NORMAL">
<short/> <short>
Numeric constant used in the Task Dialog API to represent pbsNormal from the
TProgressBarState enumeration.
</short>
<descr/> <descr/>
<seealso/> <seealso>
<link id="TProgressBarState"/>
</seealso>
</element> </element>
<!-- TODO: Needs content. -->
<element name="PBST_ERROR"> <element name="PBST_ERROR">
<short/> <short>
<descr/> Numeric constant used in the Task Dialog API to represent pbsError from the
<seealso/> TProgressBarState enumeration.
</element> </short>
<!-- TODO: Needs content. -->
<element name="PBST_PAUSED">
<short/>
<descr/>
<seealso/>
</element>
<!-- TODO: Needs content. -->
<element name="TTaskDialogProgressBar">
<short/>
<descr/> <descr/>
<version> <version>
Added in LCL version 4.0. Added in LCL version 4.0.
</version> </version>
<seealso/> <seealso>
<link id="TProgressBarState"/>
</seealso></element>
<element name="PBST_PAUSED">
<short>
Numeric constant used in the Task Dialog API to represent pbsPaused from the
TProgressBarState enumeration.
</short>
<descr/>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TProgressBarState"/>
</seealso></element>
<element name="TTaskDialogProgressBar">
<short>
Provides information about a progress bar displayed on a TTaskDialog instance.
</short>
<descr>
<p>
<var>TTaskDialogProgressBar</var> is a <var>TPersistent</var> descendant used
to represent information about a progress bar displayed on a task dialog. It
provides properties used to configure or update the progress bar, like: Min,
Max, Position, MarqueeSpeed, and State. It includes methods used to create the
progress bar on the task dialog, and to send its settings to the widgetset
class including its drawing state. It is not the actual progress bar control,
however.
</p>
<p>
TTaskDialogProgressBar is the type used to implement the ProgressBar property
in TTaskDialog.
</p>
</descr>
<version>
Added in LCL version 4.0.
</version>
<seealso>
<link id="TTaskDialog.ProgressBar"/>
</seealso>
</element> </element>
<!-- private --> <!-- private -->
@ -5877,7 +5911,7 @@ Added in LCL version 4.0.
</element> </element>
<!-- published --> <!-- published -->
<!-- TODO: Not used in the current version... yet. --> <!-- TODO: Needs update. -->
<element name="TTaskDialogProgressBar.MarqueeSpeed"> <element name="TTaskDialogProgressBar.MarqueeSpeed">
<short> <short>
Contains the number of milliseconds between updates for a progress bar using Contains the number of milliseconds between updates for a progress bar using
@ -5885,8 +5919,7 @@ the marquee style.
</short> </short>
<descr> <descr>
<p> <p>
MarqueeSpeed is a Cardinal property. Until there are implementation details, <var>MarqueeSpeed</var> is a <var>Cardinal</var> property.
the usage of the value is undetermined.
</p> </p>
<p> <p>
The default value for the property is 0. The default value for the property is 0.