xtd::forms::progress_box Class Reference

#include <progress_box.h>

Definition

Represents a common dialog box that displays a progress dialog.

Namespace

xtd::forms

Library

xtd.forms

Examples

The following code example demonstrates the use of xtd::forms::progress_box dialog.

#include <xtd/xtd>
#include <thread>

using namespace std::literals;
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 (int32_t i = progress_box::minimum(); i <= progress_box::maximum(); ++i) {
        std::this_thread::sleep_for(100ms); // Do some work...
        progress_box::update(i, "Downloading", xtd::ustring::format("{}/{}", i, progress_box::maximum()));
        if (progress_box::skipped()) i++;
        if (progress_box::cancelled()) break;
      }
      progress_box::hide();
    };
  }
  
private:
  button download_button;
};

int main() {
  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_t	minimum ()
	Gets the minimum value of the range of the progress dialog. More...
static int32_t	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_t initial_value)
	Displays a progress box. More...
static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32_t 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_t initial_value, const int32_t minimum)
	Displays a progress box. More...
static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32_t initial_value, const int32_t minimum, const progress_box_options options)
	Displays a progress box. More...
static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32_t initial_value, const int32_t minimum, const int32_t maximum)
	Displays a progress box. More...
static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32_t initial_value, const int32_t minimum, const int32_t maximum, const progress_box_options options)
	Displays a progress box. More...
static void	show (const xtd::ustring &title, const xtd::ustring &message, const int32_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t 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_t 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_t initial_value, const int32_t 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_t initial_value, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t initial_value, const int32_t minimum, const int32_t 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_t value)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message, const int32_t minimum)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message, const int32_t minimum, const int32_t maximum)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message, const int32_t minimum, const int32_t maximum, const bool marquee)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message, const int32_t minimum, const int32_t maximum, const bool marquee, const size_t marquee_animation_speed)
	Updates progress box. More...
static void	update (const int32_t value, const xtd::ustring &title, const xtd::ustring &message, const int32_t minimum, const int32_t 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 ( )

inlinestatic

Check if the progress dialog is canceled.

Returns

true if the progress dialog is canceled

hide()

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

inlinestatic

Hides a progress box in front.

maximum()

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

inlinestatic

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

Returns

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

minimum()

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

inlinestatic

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

Returns

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

show() [1/28]

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

inlinestatic

Displays a progress box.

Parameters

title

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

show() [2/28]

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

inlinestatic

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  )

inlinestatic

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  )

inlinestatic

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_t  initial_value  )

inlinestatic

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_t  initial_value, const progress_box_options  options  )

inlinestatic

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_t  initial_value, const int32_t  minimum  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const progress_box_options  options  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum, const progress_box_options  options  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum, const bool  marquee, const size_t  marquee_animation_speed  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum, const bool  marquee, const size_t  marquee_animation_speed, const progress_box_options  options  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum, const bool  marquee, const size_t  marquee_animation_speed, const std::vector< xtd::ustring > &  informations  )

inlinestatic

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_t  initial_value, const int32_t  minimum, const int32_t  maximum, const bool  marquee, const size_t  marquee_animation_speed, const std::vector< xtd::ustring > &  informations, const progress_box_options  options  )

inlinestatic

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.

show() [15/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::ustring that specifies the title of the progress dialog.

show() [16/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [17/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [18/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [19/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [20/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [21/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [22/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [23/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [24/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [25/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [26/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [27/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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() [28/28]

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

inlinestatic

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

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
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.

skipped()

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

inlinestatic

Check if the progress dialog is skipped.

Returns

true if the progress dialog is skipped

update() [1/9]

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

inlinestatic

Updates progress box.

Parameters

options

A 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_t  value )

inlinestatic

Updates progress box.

Parameters

value

An integer that indicates the value of the progress dialog.

update() [3/9]

static void xtd::forms::progress_box::update ( const int32_t  value, const xtd::ustring &  title  )

inlinestatic

Updates progress box.

Parameters

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

update() [4/9]

static void xtd::forms::progress_box::update ( const int32_t  value, const xtd::ustring &  title, const xtd::ustring &  message  )

inlinestatic

Updates progress box.

Parameters

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

update() [5/9]

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

inlinestatic

Updates progress box.

Parameters

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

update() [6/9]

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

inlinestatic

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message 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.

update() [7/9]

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

inlinestatic

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message 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.

update() [8/9]

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

inlinestatic

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message 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.

update() [9/9]

static void xtd::forms::progress_box::update ( const int32_t  value, const xtd::ustring &  title, const xtd::ustring &  message, const int32_t  minimum, const int32_t  maximum, const bool  marquee, const size_t  marquee_animation_speed, const std::vector< xtd::ustring > &  informations  )

inlinestatic

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::ustring that specifies the title of the progress dialog.
message	An xtd::ustring that specifies the message 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.

---

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

• xtd.forms/include/xtd/forms/progress_box.h