xtd::forms::busy_dialog Class Reference

Inheritance diagram for xtd::forms::busy_dialog:

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
Dark

Examples

The following code example demonstrates the use of busy_dialog dialog.

#include <xtd/xtd>
 
class form1 : public form {
public:
  form1() {
    text("Busy dialog example");
    
    button1.auto_size(true);
    button1.location({10, 10});
    button1.parent(self_);
    button1.text("Do something...");
    button1.click += delegate_ {
      auto dialog = busy_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.75);
      dialog.show(self_);
      for (auto count = 0; count < 500; ++count) {
        application::do_events();
        thread::sleep(10);
      }
    };
  }
  
private:
  button button1;
};
 
auto main() -> int {
  xtd::forms::application::run(form1 {});
}

Public Constructors
	busy_dialog ()
	Initializes a new instance of the busy_dialog class.

Public Properties
auto	back_color () const noexcept -> xtd::drawing::color
	Gets the background color for the dialog.
auto	back_color (const xtd::drawing::color &value) -> busy_dialog &
	Sets the background color for the dialog.
auto	dialog_appearance () const noexcept -> xtd::forms::dialog_appearance
	Gets the dialog appearance color for the dialog.
auto	dialog_appearance (xtd::forms::dialog_appearance value) -> busy_dialog &
	Sets the dialog appearance color for the dialog.
auto	description () const noexcept -> const xtd::string &
	Gets the product description.
auto	description (const xtd::string &value) -> busy_dialog &
	Sets the product description.
auto	fore_color () const noexcept -> xtd::drawing::color
	Gets the foreground color for the dialog.
auto	fore_color (const xtd::drawing::color &value) -> busy_dialog &
	Sets the foreground color for the dialog.
auto	icon () const noexcept -> xtd::drawing::icon
	Gets the product icon.
auto	icon (const xtd::drawing::icon &value) -> busy_dialog &
	Sets the product icon.
auto	icon (const xtd::drawing::image &value) -> busy_dialog &
	Sets the product icon.
auto	icon (const xtd::drawing::bitmap &value) -> busy_dialog &
	Sets the product icon.
auto	opacity () const noexcept -> double
	Gets the dialog opacity.
auto	opacity (double value) -> busy_dialog &
	Gets the dialog opacity.
auto	text () const noexcept -> const xtd::string &
	Gets the dialog title.
auto	text (const xtd::string &value) -> busy_dialog &
	Sets the dialog title.

Public Methods
auto	hide () -> void
	Hides busy dialog box.
auto	reset () -> void
	Resets all properties to empty string.
auto	show () -> void
	Runs busy dialog box.
auto	show (const xtd::forms::iwin32_window &owner) -> void
	Runs busy dialog box.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	equals (const object &obj) const noexcept -> bool
	Determines whether the specified object is equal to the current object.
virtual auto	get_hash_code () const noexcept -> xtd::usize
	Serves as a hash function for a particular type.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
virtual auto	to_string () const -> xtd::string
	Returns a xtd::string that represents the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are the same instance.
	component ()
	Initialises a new instance of the component class.
virtual auto	can_raise_events () const noexcept -> bool
	Gets a value indicating whether the component can raise an event.
auto	design_mode () const noexcept -> bool
	Gets a value that indicates whether the component is currently in design mode.

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]

auto xtd::forms::busy_dialog::back_color ( ) const -> xtd::drawing::color

nodiscardnoexcept

Gets the background color for the dialog.

Returns

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

back_color() [2/2]

auto xtd::forms::busy_dialog::back_color

(

const xtd::drawing::color &

value

)

-> busy_dialog &

Sets the background color for the dialog.

Parameters

value

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

Returns

Current busy_dialog instance.

dialog_appearance() [1/2]

auto xtd::forms::busy_dialog::dialog_appearance ( ) const -> xtd::forms::dialog_appearance

nodiscardnoexcept

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]

auto xtd::forms::busy_dialog::dialog_appearance

(

xtd::forms::dialog_appearance

value

)

-> busy_dialog &

Sets the dialog appearance color for the dialog.

Parameters

value

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

Returns

Current busy_dialog instance.

description() [1/2]

auto xtd::forms::busy_dialog::description ( ) const -> const xtd::string &

nodiscardnoexcept

Gets the product description.

Returns

The product description.

description() [2/2]

auto xtd::forms::busy_dialog::description

(

const xtd::string &

value

)

-> busy_dialog &

Sets the product description.

Parameters

value

The product description.

Returns

Current busy_dialog instance.

fore_color() [1/2]

auto xtd::forms::busy_dialog::fore_color ( ) const -> xtd::drawing::color

nodiscardnoexcept

Gets the foreground color for the dialog.

Returns

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

fore_color() [2/2]

auto xtd::forms::busy_dialog::fore_color

(

const xtd::drawing::color &

value

)

-> busy_dialog &

Sets the foreground color for the dialog.

Parameters

value

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

Returns

Current busy_dialog instance.

icon() [1/4]

auto xtd::forms::busy_dialog::icon ( ) const -> xtd::drawing::icon

nodiscardnoexcept

Gets the product icon.

Returns

The product icon.

icon() [2/4]

auto xtd::forms::busy_dialog::icon

(

const xtd::drawing::icon &

value

)

-> busy_dialog &

Sets the product icon.

Parameters

value

The product icon.

Returns

Current busy_dialog instance.

icon() [3/4]

auto xtd::forms::busy_dialog::icon

(

const xtd::drawing::image &

value

)

-> busy_dialog &

Sets the product icon.

Parameters

value

The product icon.

Returns

Current busy_dialog instance.

icon() [4/4]

auto xtd::forms::busy_dialog::icon

(

const xtd::drawing::bitmap &

value

)

-> busy_dialog &

Sets the product icon.

Parameters

value

The product icon.

Returns

Current busy_dialog instance.

opacity() [1/2]

auto xtd::forms::busy_dialog::opacity ( ) const -> double

nodiscardnoexcept

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]

auto xtd::forms::busy_dialog::opacity

(

double

value

)

-> busy_dialog &

Gets the dialog opacity.

Parameters

value

The dialog opacity.

Returns

Current busy_dialog instance.

Remarks

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

text() [1/2]

auto xtd::forms::busy_dialog::text ( ) const -> const xtd::string &

nodiscardnoexcept

Gets the dialog title.

Returns

The dialog title.

text() [2/2]

auto xtd::forms::busy_dialog::text

(

const xtd::string &

value

)

-> busy_dialog &

Sets the dialog title.

Parameters

value

The dialog title.

Returns

Current busy_dialog instance.

hide()

auto xtd::forms::busy_dialog::hide

(

)

-> void

Hides busy dialog box.

reset()

auto xtd::forms::busy_dialog::reset

(

)

-> void

Resets all properties to empty string.

show() [1/2]

auto xtd::forms::busy_dialog::show

(

)

-> void

Runs busy dialog box.

show() [2/2]

auto xtd::forms::busy_dialog::show

(

const xtd::forms::iwin32_window &

owner

)

-> void

Runs busy dialog box.

---

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

• xtd.forms/include/xtd/forms/busy_dialog.hpp