xtd 0.2.0
xtd::forms::busy_dialog Class Referencefinal

Definition

Represents a dialog box that displays busy dialog.

Header
#include <xtd/forms/busy_dialog>
Namespace
xtd::forms
Library
xtd.forms
Appearance
Windows macOS Gnome
Light  
dialog_busy_dialog_w.png
    html dialog_busy_dialog_m.png    html dialog_busy_dialog_g.png 
Dark  
dialog_busy_dialog_wd.png
    html dialog_busy_dialog_md.png    html dialog_busy_dialog_gd.png 
Examples
The following code example demonstrates the use of busy_dialog dialog.
#include <xtd/drawing/system_icons>
#include <xtd/forms/application>
#include <xtd/forms/busy_dialog>
#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 dialog example");
button1.auto_size(true);
button1.location({10, 10});
button1.parent(*this);
button1.text("Do something...");
button1.click += [&] {
auto dialog = busy_dialog {};
dialog.text("Application busy");
dialog.description("Please wait while do something...");
dialog.back_color(xtd::drawing::color::red);
dialog.fore_color(xtd::drawing::color::white);
dialog.opacity(0.75);
dialog.show(*this);
for (auto count = 0; count < 500; ++count) {
}
};
}
private:
};
auto main()->int {
}
Examples:
busy_dialog.cpp.

Constructors

 busy_dialog ()
 Initializes a new instance of the busy_dialog class. More...
 

Properties

xtd::drawing::color back_color () const noexcept
 Gets the background color for the dialog. More...
 
busy_dialogback_color (const xtd::drawing::color &color)
 Sets the background color for the dialog. More...
 
xtd::forms::dialog_appearance dialog_appearance () const noexcept
 Gets the dialog appearance color for the dialog. More...
 
busy_dialogdialog_appearance (xtd::forms::dialog_appearance dialog_appearance)
 Sets the dialog appearance color for the dialog. More...
 
const xtd::ustringdescription () const noexcept
 Gets the product description. More...
 
busy_dialogdescription (const xtd::ustring &description)
 Sets the product description. More...
 
xtd::drawing::color fore_color () const noexcept
 Gets the foreground color for the dialog. More...
 
busy_dialogfore_color (const xtd::drawing::color &color)
 Sets the foreground color for the dialog. More...
 
xtd::drawing::icon icon () const noexcept
 Gets the product icon. More...
 
busy_dialogicon (const xtd::drawing::icon &icon)
 Sets the product icon. More...
 
busy_dialogicon (const xtd::drawing::image &image)
 Sets the product icon. More...
 
busy_dialogicon (const xtd::drawing::bitmap &bitmap)
 Sets the product icon. More...
 
double opacity () const noexcept
 Gets the dialog opacity. More...
 
busy_dialogopacity (double opacity)
 Gets the dialog opacity. More...
 
const xtd::ustringtext () const noexcept
 Gets the dialog title. More...
 
busy_dialogtext (const xtd::ustring &text)
 Sets the dialog title. More...
 

Methods

void hide ()
 Hides busy dialog box. More...
 
void reset ()
 Resets all properties to empty string. More...
 
void show ()
 Runs busy dialog box. More...
 
void show (const iwin32_window &owner)
 Runs busy dialog box. More...
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const noexcept
 Creates a shallow copy of the current object. More...
 
virtual xtd::ustring to_string () const noexcept
 Returns a sxd::ustring that represents the current object. More...
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 
- Protected Member Functions inherited from xtd::forms::component
 component ()
 Initialises a new instance of the component class. More...
 
virtual bool can_raise_events () const noexcept
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const noexcept
 Gets a value that indicates whether the component is currently in design mode. More...
 

Constructor & Destructor Documentation

◆ busy_dialog()

xtd::forms::busy_dialog::busy_dialog ( )

Initializes a new instance of the busy_dialog class.

Member Function Documentation

◆ back_color() [1/2]

xtd::drawing::color xtd::forms::busy_dialog::back_color ( ) const
noexcept

Gets the background color for the dialog.

Returns
A xtd::drawing::color that represents the background color of the dialog.

◆ back_color() [2/2]

busy_dialog& xtd::forms::busy_dialog::back_color ( const xtd::drawing::color color)

Sets the background color for the dialog.

Parameters
colorA xtd::drawing::color that represents the background color of the dialog.
Returns
Current busy_dialog instance.

◆ description() [1/2]

const xtd::ustring& xtd::forms::busy_dialog::description ( ) const
noexcept

Gets the product description.

Returns
The product description.

◆ description() [2/2]

busy_dialog& xtd::forms::busy_dialog::description ( const xtd::ustring description)

Sets the product description.

Parameters
descriptionThe product description.
Returns
Current busy_dialog instance.

◆ dialog_appearance() [1/2]

xtd::forms::dialog_appearance xtd::forms::busy_dialog::dialog_appearance ( ) const
noexcept

Gets the dialog appearance color for the dialog.

Returns
A xtd::forms::dialog_appearance that represents the dialog appearance of the dialog.

◆ dialog_appearance() [2/2]

busy_dialog& xtd::forms::busy_dialog::dialog_appearance ( xtd::forms::dialog_appearance  dialog_appearance)

Sets the dialog appearance color for the dialog.

Parameters
dialog_appearanceA xtd::forms::dialog_appearance that represents the dialog appearance of the dialog.
Returns
Current busy_dialog instance.

◆ fore_color() [1/2]

xtd::drawing::color xtd::forms::busy_dialog::fore_color ( ) const
noexcept

Gets the foreground color for the dialog.

Returns
A xtd::drawing::color that represents the foreground color of the dialog.

◆ fore_color() [2/2]

busy_dialog& xtd::forms::busy_dialog::fore_color ( const xtd::drawing::color color)

Sets the foreground color for the dialog.

Parameters
colorA xtd::drawing::color that represents the foreground color of the dialog.
Returns
Current busy_dialog instance.

◆ hide()

void xtd::forms::busy_dialog::hide ( )

Hides busy dialog box.

◆ icon() [1/4]

xtd::drawing::icon xtd::forms::busy_dialog::icon ( ) const
noexcept

Gets the product icon.

Returns
The product icon.
Examples:
busy_dialog.cpp.

◆ icon() [2/4]

busy_dialog& xtd::forms::busy_dialog::icon ( const xtd::drawing::icon icon)

Sets the product icon.

Parameters
iconThe product icon.
Returns
Current busy_dialog instance.

◆ icon() [3/4]

busy_dialog& xtd::forms::busy_dialog::icon ( const xtd::drawing::image image)

Sets the product icon.

Parameters
imageThe product icon.
Returns
Current busy_dialog instance.

◆ icon() [4/4]

busy_dialog& xtd::forms::busy_dialog::icon ( const xtd::drawing::bitmap bitmap)

Sets the product icon.

Parameters
bitmapThe product icon.
Returns
Current busy_dialog instance.

◆ opacity() [1/2]

double xtd::forms::busy_dialog::opacity ( ) const
noexcept

Gets the dialog opacity.

Returns
The dialog opacity.
Remarks
0 full opacity; 1.0 no opacity. The lower the value, the more transparent.

◆ opacity() [2/2]

busy_dialog& xtd::forms::busy_dialog::opacity ( double  opacity)

Gets the dialog opacity.

Parameters
opacityThe dialog opacity.
Returns
Current busy_dialog instance.
Remarks
0 full opacity; 1.0 no opacity. The lower the value, the more transparent.

◆ reset()

void xtd::forms::busy_dialog::reset ( )

Resets all properties to empty string.

◆ show() [1/2]

void xtd::forms::busy_dialog::show ( )

Runs busy dialog box.

◆ show() [2/2]

void xtd::forms::busy_dialog::show ( const iwin32_window owner)

Runs busy dialog box.

◆ text() [1/2]

const xtd::ustring& xtd::forms::busy_dialog::text ( ) const
noexcept

Gets the dialog title.

Returns
The dialog title.

◆ text() [2/2]

busy_dialog& xtd::forms::busy_dialog::text ( const xtd::ustring text)

Sets the dialog title.

Parameters
textThe dialog title.
Returns
Current busy_dialog instance.

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