xtd::forms::busy_box Class Reference

#include <busy_box.h>

Definition

Represents a dialog box that displays busy box.

Namespace

xtd::forms

Library

xtd.forms

Examples

The following code example demonstrate the use of busy_box dialog.

#include <thread>
#include <xtd/xtd>
 
using namespace xtd::forms;
 
class form1 : public form {
public:
  form1() {
    text("Busy box example");
    
    button1.auto_size(true);
    button1.location({10, 10});
    button1.parent(*this);
    button1.text("Do something...");
    button1.click += [] {
      busy_box::show("Please wait while do something...", "Application busy");
      for (auto count = 0; count < 500; ++count) {
        application::do_events();
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
      }
      busy_box::hide();
    };
  }
  
private:
  button button1;
};
 
int main() {
  xtd::forms::application::run(form1());
}

Inherits xtd::static_object.

Static Public Member Functions
static void	hide ()
	Hides a busy box in front.
static void	show ()
	Displays a busy box.
static void	show (const iwin32_window &owner)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const iwin32_window &owner, const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color, float opacity)
	Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text, const xtd::ustring &caption)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.
static void	show (const xtd::ustring &text, const xtd::ustring &caption, const xtd::drawing::icon &icon, const xtd::drawing::color &back_color, const xtd::drawing::color &fore_color, float opacity)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Member Function Documentation

hide()

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

inlinestatic

Hides a busy box in front.

show() [1/14]

static void xtd::forms::busy_box::show ( )

inlinestatic

Displays a busy box.

show() [2/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner

A iwin32_window that represents the owner window of the busy box.

show() [3/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.

show() [4/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text, const xtd::ustring &  caption  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.

show() [5/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.

show() [6/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.

show() [7/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color, const xtd::drawing::color &  fore_color  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.
fore_color	A color that represents the background color of the busy box.

show() [8/14]

static void xtd::forms::busy_box::show ( const iwin32_window &  owner, const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color, const xtd::drawing::color &  fore_color, float  opacity  )

inlinestatic

Displays a busy box in front of the specified window. The busy box displays a message, title bar caption, button, and icon.

Parameters

owner	A iwin32_window that represents the owner window of the busy box.
text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.
fore_color	A color that represents the background color of the busy box.
opacity	A float that represents the opacity of the busy box. (0: full opacity and 1.0 no full opacity)

show() [9/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.

show() [10/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text, const xtd::ustring &  caption  )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.

show() [11/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon  )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.

show() [12/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color  )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.

show() [13/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color, const xtd::drawing::color &  fore_color  )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.
fore_color	A color that represents the background color of the busy box.

show() [14/14]

static void xtd::forms::busy_box::show ( const xtd::ustring &  text, const xtd::ustring &  caption, const xtd::drawing::icon &  icon, const xtd::drawing::color &  back_color, const xtd::drawing::color &  fore_color, float  opacity  )

inlinestatic

Displays a busy box. The busy box displays a message, title bar caption, button, and icon.

Parameters

text	A string that specifies the text to display.
caption	A string that specifies the title bar caption to display.
icon	An icon value that specifies the icon to display.
back_color	A color that represents the background color of the busy box.
fore_color	A color that represents the background color of the busy box.
opacity	A float that represents the opacity of the busy box. (0: full opacity and 1.0 no opacity)

---

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

• xtd.forms/include/xtd/forms/busy_box.h