Represents a common dialog box that displays progress dialog.
Windows | macOS | Gnome | |
---|---|---|---|
Light | ![]()
html dialog_progress_dialog_m.png html dialog_progress_dialog_g.png | ||
Dark | ![]()
html dialog_progress_dialog_md.png html dialog_progress_dialog_gd.png |
Constructors | |
progress_dialog () | |
Initializes a new instance of the progress_dialog class. More... | |
Properties | |
bool | cancelled () const |
Gets whether user has clicked on cancel button. More... | |
xtd::forms::dialog_appearance | dialog_appearance () const noexcept |
Gets the dialog appearance. More... | |
progress_dialog & | dialog_appearance (xtd::forms::dialog_appearance dialog_appearance) |
Sets the dialog appearance. More... | |
const std::vector< xtd::ustring > & | informations () const noexcept |
Gets the information texts. More... | |
progress_dialog & | informations (const std::vector< xtd::ustring > &informations) |
Sets the information texts. More... | |
bool | marquee () const noexcept |
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. More... | |
progress_dialog & | marquee (bool marquee) |
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion. More... | |
size_t | marquee_animation_speed () const noexcept |
Gets he time period, in milliseconds, that it takes the progress block to scroll across the progress bar. More... | |
progress_dialog & | marquee_animation_speed (size_t marquee_animation_speed) |
Sets the time period, in milliseconds, that it takes the progress block to scroll across the progress bar. More... | |
int32 | maximum () const noexcept |
Gets the maximum value of the range of the control. More... | |
progress_dialog & | maximum (int32 maximum) |
Sets the maximum value of the range of the control. More... | |
const xtd::ustring & | message () const noexcept |
Gets the message text. More... | |
progress_dialog & | message (const xtd::ustring &message) |
Sets the message text. More... | |
int32 | minimum () const noexcept |
Gets the minimum value of the range of the control. More... | |
progress_dialog & | minimum (int32 minimum) |
Sets the minimum value of the range of the control. More... | |
bool | show_cancel_button () const noexcept |
Gets a value that indicates whether cancel button is shown. More... | |
progress_dialog & | show_cancel_button (bool show_cancel_button) |
Sets a value that indicates whether cancel button is shown. More... | |
bool | show_elapsed_time () const noexcept |
Gets a value that indicates whether elapsed time is shown. More... | |
progress_dialog & | show_elapsed_time (bool show_elapsed_time) |
Sets a value that indicates whether elapsed time is shown. More... | |
bool | show_estimated_time () const noexcept |
Gets a value that indicates whether estimated time is shown. More... | |
progress_dialog & | show_estimated_time (bool show_estimated_time) |
Sets a value that indicates whether estimated time is shown. More... | |
bool | show_remaining_time () const noexcept |
Gets a value that indicates whether remaining time is shown. More... | |
progress_dialog & | show_remaining_time (bool show_remaining_time) |
Sets a value that indicates whether remaining time is shown. More... | |
bool | show_skip_button () const noexcept |
Gets a value that indicates whether skip button is shown. More... | |
progress_dialog & | show_skip_button (bool show_skip_button) |
Sets a value that indicates whether skip button is shown. More... | |
bool | skipped () const |
Gets whether user has clicked on skip button. More... | |
virtual int32 | step () const noexcept |
Gets the amount by which a call to the PerformStep() method increases the current position of the progress bar. More... | |
virtual progress_dialog & | step (int32 step) |
Sets the amount by which a call to the PerformStep() method increases the current position of the progress bar. More... | |
const xtd::ustring & | text () const noexcept |
Gets the dialog title. More... | |
progress_dialog & | text (const xtd::ustring &text) |
Sets the dialog title. More... | |
int32 | value () const noexcept |
Gets the current position of the progress bar. More... | |
progress_dialog & | value (int32 value) |
Sets the current position of the progress bar. More... | |
Methods | |
void | hide () |
Hides progress dialog box. More... | |
void | increment (int32 increment) |
Advances the current position of the progress bar by the specified amount. More... | |
void | perform_step () |
Advances the current position of the progress bar by the amount of the Step property. More... | |
void | reset () noexcept |
Resets all properties to empty string. More... | |
void | resume () |
Resume progress dialog box after Abort button clicked. More... | |
void | show () |
Runs progress dialog box. More... | |
void | show (const iwin32_window &owner) |
Runs progress dialog box. More... | |
void | show_sheet (const iwin32_window &owner) |
Runs progress dialog box as sheet. More... | |
void | show_dialog () |
Runs progress dialog box. More... | |
void | show_dialog (const iwin32_window &owner) |
Runs progress dialog box. More... | |
void | show_sheet_dialog (const iwin32_window &owner) |
Runs progress dialog box. More... | |
Additional Inherited Members | |
![]() | |
object ()=default | |
Create a new instance of the ultimate base class object. More... | |
bool | equals (const object &obj) const noexcept |
Determines whether the specified object is equal to the current object. More... | |
virtual size_t | get_hash_code () const noexcept |
Serves as a hash function for a particular type. More... | |
virtual type_object | get_type () const noexcept |
Gets the type of the current instance. More... | |
template<typename object_t > | |
std::unique_ptr< object_t > | memberwise_clone () const noexcept |
Creates a shallow copy of the current object. More... | |
virtual xtd::ustring | to_string () const noexcept |
Returns a sxd::ustring that represents the current object. More... | |
![]() | |
static bool | equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are considered equal. More... | |
static bool | reference_equals (const object &object_a, const object &object_b) noexcept |
Determines whether the specified object instances are the same instance. More... | |
![]() | |
component () | |
Initialises a new instance of the component class. More... | |
virtual bool | can_raise_events () const noexcept |
Gets a value indicating whether the component can raise an event. More... | |
bool | design_mode () const noexcept |
Gets a value that indicates whether the component is currently in design mode. More... | |
xtd::forms::progress_dialog::progress_dialog | ( | ) |
Initializes a new instance of the progress_dialog class.
bool xtd::forms::progress_dialog::cancelled | ( | ) | const |
Gets whether user has clicked on cancel button.
|
noexcept |
Gets the dialog appearance.
progress_dialog& xtd::forms::progress_dialog::dialog_appearance | ( | xtd::forms::dialog_appearance | dialog_appearance | ) |
Sets the dialog appearance.
dialog_appearance | One of the xtd::forms::dialog_appearance values. The default value is xtd::forms::dialog_appearance::standard. |
void xtd::forms::progress_dialog::hide | ( | ) |
Hides progress dialog box.
void xtd::forms::progress_dialog::increment | ( | int32 | increment | ) |
Advances the current position of the progress bar by the specified amount.
increment | The amount by which to increment the progress bar's current position. |
|
noexcept |
Gets the information texts.
progress_dialog& xtd::forms::progress_dialog::informations | ( | const std::vector< xtd::ustring > & | informations | ) |
Sets the information texts.
informations | The information texts. |
|
noexcept |
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion.
progress_dialog& xtd::forms::progress_dialog::marquee | ( | bool | marquee | ) |
Gets a value that Indicates progress by continuously scrolling a block across a progress_bar in a marquee fashion.
marquee | tree is marquee; otherwise false. The default is false. |
|
noexcept |
Gets he time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
progress_dialog& xtd::forms::progress_dialog::marquee_animation_speed | ( | size_t | marquee_animation_speed | ) |
Sets the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
marquee_animation_speed | The time period, in milliseconds, that it takes the progress block to scroll across the progress bar. |
|
noexcept |
Gets the maximum value of the range of the control.
progress_dialog& xtd::forms::progress_dialog::maximum | ( | int32 | maximum | ) |
Sets the maximum value of the range of the control.
maximum | The maximum value of the range. The default is 100. |
|
noexcept |
Gets the message text.
progress_dialog& xtd::forms::progress_dialog::message | ( | const xtd::ustring & | message | ) |
Sets the message text.
description | The message text. |
|
noexcept |
Gets the minimum value of the range of the control.
progress_dialog& xtd::forms::progress_dialog::minimum | ( | int32 | minimum | ) |
Sets the minimum value of the range of the control.
minimum | The minimum value of the range. The default is 0. |
void xtd::forms::progress_dialog::perform_step | ( | ) |
Advances the current position of the progress bar by the amount of the Step property.
|
noexcept |
Resets all properties to empty string.
void xtd::forms::progress_dialog::resume | ( | ) |
Resume progress dialog box after Abort button clicked.
void xtd::forms::progress_dialog::show | ( | ) |
Runs progress dialog box.
void xtd::forms::progress_dialog::show | ( | const iwin32_window & | owner | ) |
Runs progress dialog box.
|
noexcept |
Gets a value that indicates whether cancel button is shown.
progress_dialog& xtd::forms::progress_dialog::show_cancel_button | ( | bool | show_cancel_button | ) |
Sets a value that indicates whether cancel button is shown.
show_cancel_button | true if cancel button is shown; otherwise false. By default false. |
void xtd::forms::progress_dialog::show_dialog | ( | ) |
Runs progress dialog box.
void xtd::forms::progress_dialog::show_dialog | ( | const iwin32_window & | owner | ) |
Runs progress dialog box.
|
noexcept |
Gets a value that indicates whether elapsed time is shown.
progress_dialog& xtd::forms::progress_dialog::show_elapsed_time | ( | bool | show_elapsed_time | ) |
Sets a value that indicates whether elapsed time is shown.
show_elapsed_time | true if elapsed time is shown; otherwise false. By default false. |
|
noexcept |
Gets a value that indicates whether estimated time is shown.
progress_dialog& xtd::forms::progress_dialog::show_estimated_time | ( | bool | show_estimated_time | ) |
Sets a value that indicates whether estimated time is shown.
show_estimated_time | true if estimated time is shown; otherwise false. By default false. |
|
noexcept |
Gets a value that indicates whether remaining time is shown.
progress_dialog& xtd::forms::progress_dialog::show_remaining_time | ( | bool | show_remaining_time | ) |
Sets a value that indicates whether remaining time is shown.
show_remaining_time | true if remaining time is shown; otherwise false. By default false. |
void xtd::forms::progress_dialog::show_sheet | ( | const iwin32_window & | owner | ) |
Runs progress dialog box as sheet.
void xtd::forms::progress_dialog::show_sheet_dialog | ( | const iwin32_window & | owner | ) |
Runs progress dialog box.
|
noexcept |
Gets a value that indicates whether skip button is shown.
progress_dialog& xtd::forms::progress_dialog::show_skip_button | ( | bool | show_skip_button | ) |
Sets a value that indicates whether skip button is shown.
show_skip_button | true if skip button is shown; otherwise false. By default false. |
bool xtd::forms::progress_dialog::skipped | ( | ) | const |
Gets whether user has clicked on skip button.
|
virtualnoexcept |
Gets the amount by which a call to the PerformStep() method increases the current position of the progress bar.
|
virtual |
Sets the amount by which a call to the PerformStep() method increases the current position of the progress bar.
step | The amount by which to increment the progress bar with each call to the perform_step() method. The default is 10. |
|
noexcept |
progress_dialog& xtd::forms::progress_dialog::text | ( | const xtd::ustring & | text | ) |
Sets the dialog title.
copyright | The dialog title. |
|
noexcept |
Gets the current position of the progress bar.
progress_dialog& xtd::forms::progress_dialog::value | ( | int32 | value | ) |
Sets the current position of the progress bar.
value | The position within the range of the progress bar. The default is 0. |