xtd - Reference Guide  0.2.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Static Public Member Functions | List of all members
xtd::forms::busy_box Class Referencefinal

#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) {
std::this_thread::sleep_for(std::chrono::milliseconds(10));
}
};
}
private:
};
int main() {
}

Static Public Member Functions

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 ( )
inlinestatic

Hides a busy box in front.

Examples:
busy_box.cpp.

◆ show() [1/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
ownerA 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA string that specifies the text to display.
captionA 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA color that represents the background color of the busy box.
fore_colorA 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 
)
inlinestatic

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

Parameters
ownerA iwin32_window that represents the owner window of the busy box.
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA color that represents the background color of the busy box.
fore_colorA color that represents the background color of the busy box.
opacityA 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 ( )
inlinestatic

Displays a busy box.

Examples:
busy_box.cpp.

◆ 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
textA 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
textA string that specifies the text to display.
captionA 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
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn 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
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA 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
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA color that represents the background color of the busy box.
fore_colorA 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
textA string that specifies the text to display.
captionA string that specifies the title bar caption to display.
iconAn icon value that specifies the icon to display.
back_colorA color that represents the background color of the busy box.
fore_colorA color that represents the background color of the busy box.
opacityA 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: