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	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

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] {
progress_box::show(*this, "Downloading", "Please wait...", 0, 0, 100, progress_box_options::show_cancel_button | progress_box_options::show_skip_button);
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::ustring::format("{}/{}", index, progress_box::maximum()));
if (progress_box::skipped()) index++;
if (progress_box::cancelled()) break;
}
progress_box::hide();
};
}

private:
button download_button;
};
auto main()->int {
application::run(form1 {});
}

Properties
static bool	cancelled ()
	Check if the progress dialog is canceled. More...

static bool	skipped ()
	Check if the progress dialog is skipped. More...

static int32	minimum ()
	Gets the minimum value of the range of the progress dialog. More...

static int32	maximum ()
	Gets the maximum value of the range of the progress dialog. More...

Methods
static void	hide ()
	Hides a progress box in front. More...

static void	show (const xtd::ustring &title)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const progress_box_options options)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const progress_box_options options)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const progress_box_options options)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const progress_box_options options)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const progress_box_options options)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &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. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const std::vector< xtd::ustring > &informations)
	Displays a progress box. More...

static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const std::vector< xtd::ustring > &informations, const progress_box_options options)
	Displays a progress box. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const progress_box_options options)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const progress_box_options options)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const progress_box_options options)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const progress_box_options options)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &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. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &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. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &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. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const std::vector< xtd::ustring > &informations)
	Displays a progress dialog box in front of a specified window. More...

static void	show (const iwin32_window &owner, const xtd::ustring &title, const xtd::ustring &message, const int32 initial_value, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const std::vector< xtd::ustring > &informations, const progress_box_options options)
	Displays a progress dialog box in front of a specified window. More...

static void	update (const progress_box_options options)
	Updates progress box. More...

static void	update (const int32 value)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message, const int32 minimum)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message, const int32 minimum, const int32 maximum)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message, const int32 minimum, const int32 maximum, const bool marquee)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed)
	Updates progress box. More...

static void	update (const int32 value, const xtd::ustring &title, const xtd::ustring &message, const int32 minimum, const int32 maximum, const bool marquee, const size_t marquee_animation_speed, const std::vector< xtd::ustring > &informations)
	Updates progress box. More...

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

Examples:: progress_box.cpp.

◆ hide()

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

static

Hides a progress box in front.

Examples:: progress_box.cpp.

◆ 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.

Examples:: progress_box.cpp.

◆ 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.

Examples:: progress_box.cpp.

◆ show() [1/28]

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

static

Displays a progress box.

Parameters

title An xtd::ustring that specifies the title of the progress dialog.

Examples:: progress_box.cpp.

◆ show() [2/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
options	A 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::ustring &	title,
		const xtd::ustring &	message
	)

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.

◆ show() [4/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
options	A 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::ustring &	title,
		const xtd::ustring &	message,
		const int32	initial_value
	)

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.

◆ show() [6/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
options	A 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::ustring &	title,
		const xtd::ustring &	message,
		const int32	initial_value,
		const int32	minimum
	)

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.

◆ show() [8/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
options	A 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::ustring &	title,
		const xtd::ustring &	message,
		const int32	initial_value,
		const int32	minimum,
		const int32	maximum
	)

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.

◆ show() [10/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
options	A 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::ustring &	title,
		const xtd::ustring &	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

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A 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::ustring &	title,
		const xtd::ustring &	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

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
options	A 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::ustring &	title,
		const xtd::ustring &	message,
		const int32	initial_value,
		const int32	minimum,
		const int32	maximum,
		const bool	marquee,
		const size_t	marquee_animation_speed,
		const std::vector< xtd::ustring > &	informations
	)

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An std::vector of xtd::ustring that specifies the information texts of the progress dialog.

◆ show() [14/28]

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

static

Displays a progress box.

Parameters

title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An std::vector of xtd::ustring that specifies the information texts of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.