xtd::forms::busy_box Class Reference

Definition

Represents a dialog box that displays busy box.

Header

#include <xtd/forms/busy_box> 

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light	html dialog_busy_dialog_m.png    html dialog_busy_dialog_g.png
Dark	html dialog_busy_dialog_md.png    html dialog_busy_dialog_gd.png

Examples

The following code example demonstrates the use of busy_box dialog.

#include <xtd/forms/application>
#include <xtd/forms/busy_box>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/threading/thread>

using namespace xtd::forms;
using namespace xtd::threading;

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();
        thread::sleep(10);
      }
      busy_box::hide();
    };
  }
  
private:
  button button1;
};

auto main()->int {
  xtd::forms::application::run(form1 {});
}

Methods
static void	hide ()
	Hides a busy box in front. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
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. More...
static void	show ()
	Displays a busy box. More...
static void	show (const xtd::ustring &text)
	Displays a busy box. The busy box displays a message, title bar caption, button, and icon. More...
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. More...
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. More...
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. More...
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. More...
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. More...

Member Function Documentation

hide()

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

static

Hides a busy box in front.

Examples:

busy_box.cpp.

show() [1/14]

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

static

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() [2/14]

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

static

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() [3/14]

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

static

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() [4/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  )

static

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() [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, const xtd::drawing::color &  back_color  )

static

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() [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, const xtd::drawing::color &  fore_color  )

static

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() [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, float  opacity  )

static

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() [8/14]

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

static

Displays a busy box.

Examples:

busy_box.cpp.

show() [9/14]

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

static

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  )

static

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  )

static

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  )

static

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  )

static

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  )

static

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 lower the value, the more transparent.

---

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

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