xtd 0.2.0
xtd::forms::progress_box Class Referencefinal
Inheritance diagram for xtd::forms::progress_box:
xtd::static_object

Definition

Represents a common dialog box that displays a progress dialog.

Header
#include <xtd/forms/progress_box>
Namespace
xtd::forms
Library
xtd.forms
Appearance
Windows macOS Gnome
Light
Dark
Examples
The following code example demonstrates the use of xtd::forms::progress_box dialog.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/progress_box>
#include <xtd/threading/thread>
using namespace xtd;
using namespace xtd::forms;
class form1 : public form {
public:
form1() {
text("Progress box example");
client_size({ 400, 200 });
download_button.parent(*this)
.text("Download")
.location({ 10, 10 })
.size({ 150, 35 })
.click += [this] {
for (auto index = progress_box::minimum(); index <= progress_box::maximum(); ++index) {
threading::thread::sleep(100_ms); // Do some work...
progress_box::update(index, "Downloading", xtd::string::format("{}/{}", index, progress_box::maximum()));
if (progress_box::skipped()) index++;
}
};
}
private:
button download_button;
};
auto main() -> int {
application::run(form1 {});
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
virtual const drawing::size & client_size() const noexcept
Gets the height and width of the client area of the control.
Represents a window or dialog box that makes up an application's user interface.
Definition form.hpp:54
static void hide()
Hides a progress box in front.
static int32 maximum()
Gets the maximum value of the range of the progress dialog.
static bool skipped()
Check if the progress dialog is skipped.
static void show(const xtd::string &title)
Displays a progress box.
static int32 minimum()
Gets the minimum value of the range of the progress dialog.
static bool cancelled()
Check if the progress dialog is canceled.
static void update(const progress_box_options options)
Updates progress box.
static void sleep(int32 milliseconds_timeout)
Suspends the current thread for a specified time.
xtd::forms::style_sheets::control button
The buttton data allows you to specify the box of a button control.
Definition button.hpp:25
@ size
Specifies that both the width and height property values of the control are defined.
Definition bounds_specified.hpp:36
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
Definition status_bar_panel_style.hpp:25
@ show_skip_button
Whether skip button is shown.
Definition progress_box_options.hpp:28
@ show_cancel_button
Whether cancel button is shown.
Definition progress_box_options.hpp:26
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:217
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

Public Static Properties

static bool cancelled ()
 Check if the progress dialog is canceled.
 
static bool skipped ()
 Check if the progress dialog is skipped.
 
static int32 minimum ()
 Gets the minimum value of the range of the progress dialog.
 
static int32 maximum ()
 Gets the maximum value of the range of the progress dialog.
 

Public Static Methods

static void hide ()
 Hides a progress box in front.
 
static void show (const xtd::string &title)
 Displays a progress box.
 
static void show (const xtd::string &title, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const progress_box_options options)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const xtd::array< xtd::string > &informations)
 Displays a progress box.
 
static void show (const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const xtd::array< xtd::string > &informations, const progress_box_options options)
 Displays a progress box.
 
static void show (const iwin32_window &owner, const xtd::string &title)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const xtd::array< xtd::string > &informations)
 Displays a progress dialog box in front of a specified window.
 
static void show (const iwin32_window &owner, const xtd::string &title, const xtd::string &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const xtd::array< xtd::string > &informations, const progress_box_options options)
 Displays a progress dialog box in front of a specified window.
 
static void update (const progress_box_options options)
 Updates progress box.
 
static void update (const int32 value)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message, const int32 minimum)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message, const int32 minimum, const int32 maximum)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message, const int32 minimum, const int32 maximum, const bool marquee)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed)
 Updates progress box.
 
static void update (const int32 value, const xtd::string &title, const xtd::string &message, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const xtd::array< xtd::string > &informations)
 Updates progress box.
 

Member Function Documentation

◆ cancelled()

static bool xtd::forms::progress_box::cancelled ( )
static

Check if the progress dialog is canceled.

Returns
true if the progress dialog is canceled

◆ skipped()

static bool xtd::forms::progress_box::skipped ( )
static

Check if the progress dialog is skipped.

Returns
true if the progress dialog is skipped

◆ minimum()

static int32 xtd::forms::progress_box::minimum ( )
static

Gets the minimum value of the range of the progress dialog.

Returns
The minimum value of the range. The default is 0.

◆ maximum()

static int32 xtd::forms::progress_box::maximum ( )
static

Gets the maximum value of the range of the progress dialog.

Returns
The maximum value of the range. The default is 100.

◆ hide()

static void xtd::forms::progress_box::hide ( )
static

Hides a progress box in front.

◆ show() [1/28]

static void xtd::forms::progress_box::show ( const xtd::string & title)
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.

◆ show() [2/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [3/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.

◆ show() [4/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [5/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.

◆ show() [6/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [7/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.

◆ show() [8/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [9/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.

◆ show() [10/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [11/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

◆ show() [12/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [13/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const xtd::array< xtd::string > & informations )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informationsAn xtd::array of xtd::string that specifies the information texts of the progress dialog.

◆ show() [14/28]

static void xtd::forms::progress_box::show ( const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const xtd::array< xtd::string > & informations,
const progress_box_options options )
static

Displays a progress box.

Parameters
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informationsAn xtd::array of xtd::string that specifies the information texts of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [15/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.

◆ show() [16/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [17/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.

◆ show() [18/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [19/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.

◆ show() [20/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [21/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.

◆ show() [22/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [23/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.

◆ show() [24/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [25/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

◆ show() [26/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ show() [27/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const xtd::array< xtd::string > & informations )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informationsAn xtd::array of xtd::string that specifies the information texts of the progress dialog.

◆ show() [28/28]

static void xtd::forms::progress_box::show ( const iwin32_window & owner,
const xtd::string & title,
const xtd::string & message,
const int32 initial_value,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const xtd::array< xtd::string > & informations,
const progress_box_options options )
static

Displays a progress dialog box in front of a specified window.

Parameters
ownerAn If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
initial_valueAn integer that indicates the initial value of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informationsAn xtd::array of xtd::string that specifies the information texts of the progress dialog.
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ update() [1/9]

static void xtd::forms::progress_box::update ( const progress_box_options options)
static

Updates progress box.

Parameters
optionsA bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

◆ update() [2/9]

static void xtd::forms::progress_box::update ( const int32 value)
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.

◆ update() [3/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.

◆ update() [4/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.

◆ update() [5/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message,
const int32 minimum )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.

◆ update() [6/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message,
const int32 minimum,
const int32 maximum )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.

◆ update() [7/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message,
const int32 minimum,
const int32 maximum,
const bool marquee )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

◆ update() [8/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.

◆ update() [9/9]

static void xtd::forms::progress_box::update ( const int32 value,
const xtd::string & title,
const xtd::string & message,
const int32 minimum,
const int32 maximum,
const bool marquee,
const size_t marquee_animation_speed,
const xtd::array< xtd::string > & informations )
static

Updates progress box.

Parameters
valueAn integer that indicates the value of the progress dialog.
titleAn xtd::string that specifies the title of the progress dialog.
messageAn xtd::string that specifies the message of the progress dialog.
minimumAn integer that indicates the minimum value of the progress dialog.
maximumAn integer that indicates the maximum value of the progress dialog.
marqueeA boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speedAn integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informationsAn xtd::array of xtd::string that specifies the information texts of the progress dialog.

The documentation for this class was generated from the following file: