xtd::forms::busy_dialog Class Reference

#include <busy_dialog.h>

Definition

Represents a dialog box that displays busy dialog.

Namespace

xtd::forms

Library

xtd.forms

Examples

The following code example demonstrate the use of busy_dialog dialog.

#include <thread>
#include <xtd/xtd>
 
using namespace xtd::forms;
 
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 += [&] {
      busy_dialog dialog;
      dialog.icon(xtd::drawing::system_icons::exclamation({64, 64}));
      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.25);
      dialog.show(*this);
      for (auto count = 0; count < 500; ++count) {
        application::do_events();
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
      }
    };
  }
  
private:
  button button1;
};
 
int main() {
  xtd::forms::application::run(form1());
}

Examples

busy_dialog.cpp.

Inherits xtd::forms::component.

Public Member Functions
	busy_dialog ()=default
	Initializes a new instance of the busy_dialog class.
xtd::drawing::color	back_color () const
	Gets the background color for the dialog.
busy_dialog &	back_color (const xtd::drawing::color &color)
	Sets the background color for the dialog.
const xtd::ustring &	description () const
	Gets the product description.
busy_dialog &	description (const xtd::ustring &description)
	Sets the product description.
xtd::forms::dialog_style	dialog_style () const
	Gets the dialog style color for the dialog.
busy_dialog &	dialog_style (xtd::forms::dialog_style dialog_style)
	Sets the dialog style color for the dialog.
xtd::drawing::color	fore_color () const
	Gets the foreground color for the dialog.
busy_dialog &	fore_color (const xtd::drawing::color &color)
	Sets the foreground color for the dialog.
void	hide ()
	Hides busy dialog box.
xtd::drawing::icon	icon () const
	Gets the product icon.
busy_dialog &	icon (const xtd::drawing::bitmap &bitmap)
	Sets the product icon.
busy_dialog &	icon (const xtd::drawing::icon &icon)
	Sets the product icon.
busy_dialog &	icon (const xtd::drawing::image &image)
	Sets the product icon.
double	opacity () const
	Gets the dialog opacity.
busy_dialog &	opacity (double opacity)
	Gets the dialog opacity.
void	reset ()
	Resets all properties to empty string.
void	show ()
	Runs busy dialog box.
void	show (const iwin32_window &owner)
	Runs busy dialog box.
const xtd::ustring &	text () const
	Gets the dialog title.
busy_dialog &	text (const xtd::ustring &text)
	Sets the dialog title.
Public Member Functions inherited from xtd::object
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual size_t	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
template<typename object_t >
std::unique_ptr< object_t >	memberwise_clone () const
	Gets the type of the current instance.
virtual xtd::ustring	to_string () const noexcept
	Returns a std::string that represents the current object.

Additional Inherited Members
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.
static bool	reference_equals (const object &object_a, const object &object_b) noexcept
	Determines whether the specified object instances are the same instance.
Protected Member Functions inherited from xtd::forms::component
	component ()=default
	Initialises a new instance of the component class.
virtual bool	can_raise_events () const
	Gets a value indicating whether the component can raise an event.
bool	design_mode () const
	Gets a value that indicates whether the component is currently in design mode.

Constructor & Destructor Documentation

busy_dialog()

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

default

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

inline

Gets the background color for the dialog.

Returns

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

Examples

busy_dialog.cpp.

back_color() [2/2]

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

inline

Sets the background color for the dialog.

Parameters

color

A 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

inline

Gets the product description.

Returns

The product description.

Examples

busy_dialog.cpp.

description() [2/2]

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

inline

Sets the product description.

Parameters

description

The product description.

Returns

Current busy_dialog instance.

dialog_style() [1/2]

xtd::forms::dialog_style xtd::forms::busy_dialog::dialog_style ( ) const

inline

Gets the dialog style color for the dialog.

Returns

A xtd::forms::dialog_style that represents the dialog style of the dialog.

dialog_style() [2/2]

busy_dialog & xtd::forms::busy_dialog::dialog_style ( xtd::forms::dialog_style  dialog_style )

inline

Sets the dialog style color for the dialog.

Parameters

dialog_style

A xtd::forms::dialog_style that represents the dialog style of the dialog.

Returns

Current busy_dialog instance.

fore_color() [1/2]

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

inline

Gets the foreground color for the dialog.

Returns

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

Examples

busy_dialog.cpp.

fore_color() [2/2]

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

inline

Sets the foreground color for the dialog.

Parameters

color

A 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

inline

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::bitmap &  bitmap )

inline

Sets the product icon.

Parameters

bitmap

The product icon.

Returns

Current busy_dialog instance.

icon() [3/4]

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

inline

Sets the product icon.

Parameters

icon	The product icon.

Returns

Current busy_dialog instance.

icon() [4/4]

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

inline

Sets the product icon.

Parameters

image

The product icon.

Returns

Current busy_dialog instance.

opacity() [1/2]

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

inline

Gets the dialog opacity.

Returns

The dialog opacity.

Remarks

0 full opacity; 1.0 full opacity.

Examples

busy_dialog.cpp.

opacity() [2/2]

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

inline

Gets the dialog opacity.

Parameters

opacity

The dialog opacity.

Returns

Current busy_dialog instance.

Remarks

0 full opacity; 1.0 full opacity.

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.

Examples

busy_dialog.cpp.

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

inline

Gets the dialog title.

Returns

The dialog title.

Examples

busy_dialog.cpp.

text() [2/2]

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

inline

Sets the dialog title.

Parameters

text	The dialog title.

Returns

Current busy_dialog instance.

---

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

• xtd.forms/include/xtd/forms/busy_dialog.h