Inheritance diagram for xtd::forms::message_dialog:

Definition

Displays a message window, also known as a dialog box, which presents a message to the user. It is a modal window, blocking other actions in the application until the user closes it. A message_dialog can contain text, buttons, and symbols that inform and instruct the user.

Header: #include <xtd/forms/message_dialog>

Namespace: xtd::forms

Library: xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples: The following code example demonstrates the use of message_dialog dialog.
#include <xtd/forms/application>

#include <xtd/forms/button>

#include <xtd/forms/form>

#include <xtd/forms/label>

#include <xtd/forms/message_dialog>

using namespace xtd;

using namespace xtd::forms;

class form1 : public form {

public:

form1() {

controls().push_back_range({button_show_message, label_dialog_result});

location({400, 200});

start_position(form_start_position::manual);

text("Message dialog exemple");

button_show_message.location({10, 10});

button_show_message.text("Message...");

button_show_message.width(100);

button_show_message.click += [&] {

auto dialog = message_dialog {};

dialog.buttons(message_dialog_buttons::ok_cancel);

dialog.icon(message_dialog_icon::warning);

dialog.message("Hello, World!");

dialog.text("Message");

label_dialog_result.text(string::format("dialog_result = {}", dialog.show_sheet_dialog(*this)));

};

label_dialog_result.location({10, 55});

label_dialog_result.width(200);

}

private:

button button_show_message;

label label_dialog_result;

};

auto main() -> int {

application::run(form1 {});

}

xtd::forms::application::run
static void run()
Begins running a standard application message loop on the current thread, without a form.

xtd::forms::button
Represents a Windows button control.
Definition button.h:49

xtd::forms::form
Represents a window or dialog box that makes up an application's user interface.
Definition form.h:54

xtd::forms::label
Represents a standard Windows label.
Definition label.h:38

xtd::forms::message_dialog
Displays a message window, also known as a dialog box, which presents a message to the user....
Definition message_dialog.h:42

xtd::forms::message_dialog::buttons
xtd::forms::message_dialog_buttons buttons() const noexcept
Gets buttons to display in the message dialog.

xtd::forms::bounds_specified::location
@ location
Specifies that both the x and y coordinates of the control are defined.

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition xtd_about_box.h:12

xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition xtd_about_box.h:10

Examples: message_dialog.cpp, and message_dialog_show_sheet.cpp.

Public Events
event< message_dialog, help_event_handler >	help_request
	Occurs when the user clicks the Help button on a common dialog box.

event< message_dialog, dialog_closed_event_handler >	dialog_closed
	Occurs when the user close a message dialog box with dialog close button or other dialog buttons.

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

Public Properties
xtd::forms::message_dialog_buttons	buttons () const noexcept
	Gets buttons to display in the message dialog.

message_dialog &	buttons (xtd::forms::message_dialog_buttons buttons)
	Sets buttons to display in the message dialog.

xtd::forms::message_dialog_default_button	default_button () const noexcept
	Gets default button for the message dialog.

message_dialog &	default_button (xtd::forms::message_dialog_default_button default_button)
	Sets default button for the message dialog.

bool	display_help_button () const noexcept
	Gets a value indicate if help button is shown.

message_dialog &	display_help_button (bool display_help_button)
	Sets a value indicate if help button is shown.

xtd::forms::dialog_result	dialog_result () const noexcept
	Gets async dialog_result result after dialog box is closing.

xtd::forms::dialog_appearance	dialog_appearance () const noexcept
	Gets the dialog appearance.

message_dialog &	dialog_appearance (xtd::forms::dialog_appearance dialog_appearance)
	Sets the dialog appearance.

xtd::forms::message_dialog_icon	icon () const noexcept
	Gets icon to display in the message dialog.

message_dialog &	icon (xtd::forms::message_dialog_icon icon)
	Sets icon to display in the message dialog.

xtd::forms::message_dialog_options	options () const noexcept
	Gets options will be used for the message box.

message_dialog &	options (xtd::forms::message_dialog_options options)
	Sets options will be used for the message box.

xtd::string	message () const noexcept
	Gets the text message.

message_dialog &	message (const xtd::string &message)
	Sets the text message.

xtd::string	text () const noexcept
	Gets the dialog caption text.

message_dialog &	text (const xtd::string &text)
	Sets the dialog caption text.

Public Methods
void	reset ()
	Resets all properties to empty string.

xtd::forms::dialog_result	show_dialog ()
	Runs message dialog box.

xtd::forms::dialog_result	show_dialog (const iwin32_window &owner)
	Runs message dialog box.

void	show_sheet (const iwin32_window &owner)
	Runs message dialog box.

xtd::forms::dialog_result	show_sheet_dialog (const iwin32_window &owner)
	Runs message dialog box.

Additional Inherited Members
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.

virtual type_object	get_type () const noexcept
	Gets the type of the current instance.

template<typename object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.

virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.

Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.

template<typename object_a_t , typename object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class.

virtual bool	can_raise_events () const noexcept
	Gets a value indicating whether the component can raise an event.

bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode.

Constructor & Destructor Documentation

◆ message_dialog()

xtd::forms::message_dialog::message_dialog ( )

Initializes a new instance of the message_dialog class.

Member Function Documentation

◆ buttons() [1/2]

xtd::forms::message_dialog_buttons xtd::forms::message_dialog::buttons ( ) const

noexcept

Gets buttons to display in the message dialog.

Returns: One of the xtd::forms::message_dialog_buttons values that specifies which buttons to display in the message dialog.

Examples: message_dialog.cpp.

◆ buttons() [2/2]

message_dialog & xtd::forms::message_dialog::buttons ( xtd::forms::message_dialog_buttons buttons )

Sets buttons to display in the message dialog.

Parameters

buttons One of the xtd::forms::message_dialog_buttons values that specifies which buttons to display in the message dialog.

Returns: Current message dialog.

◆ default_button() [1/2]

xtd::forms::message_dialog_default_button xtd::forms::message_dialog::default_button ( ) const

noexcept

Gets default button for the message dialog.

Returns: One of the xtd::forms::message_dialog_default_button values that specifies the default button for the message dialog.

◆ default_button() [2/2]

message_dialog & xtd::forms::message_dialog::default_button ( xtd::forms::message_dialog_default_button default_button )

Sets default button for the message dialog.

Parameters

default_button One of the xtd::forms::message_dialog_default_button values that specifies the default button for the message dialog.

Returns: Current message dialog.

◆ display_help_button() [1/2]

bool xtd::forms::message_dialog::display_help_button ( ) const

noexcept

Gets a value indicate if help button is shown.

Returns: true to show the Help button; otherwise, false. The default is false.

◆ display_help_button() [2/2]

message_dialog & xtd::forms::message_dialog::display_help_button ( bool display_help_button )

Sets a value indicate if help button is shown.

Parameters

display_help_button true to show the Help button; otherwise, false. The default is false.

Returns: Current message dialog.

◆ dialog_result()

xtd::forms::dialog_result xtd::forms::message_dialog::dialog_result ( ) const

noexcept

Gets async dialog_result result after dialog box is closing.

Returns: ok if the user clicks OK in the dialog box; otherwise, cancel.

◆ dialog_appearance() [1/2]

xtd::forms::dialog_appearance xtd::forms::message_dialog::dialog_appearance ( ) const

noexcept

Gets the dialog appearance.

Returns: One of the xtd::forms::dialog_appearance values. The default value is xtd::forms::dialog_appearance::standard.

◆ dialog_appearance() [2/2]

message_dialog & xtd::forms::message_dialog::dialog_appearance ( xtd::forms::dialog_appearance dialog_appearance )

Sets the dialog appearance.

Parameters

dialog_appearance One of the xtd::forms::dialog_appearance values. The default value is xtd::forms::dialog_appearance::standard.

Returns: Current message dialog.

◆ icon() [1/2]

xtd::forms::message_dialog_icon xtd::forms::message_dialog::icon ( ) const

noexcept

Gets icon to display in the message dialog.

Returns: One of the xtd::forms::message_dialog_icon values that specifies which icon to display in the message dialog.

◆ icon() [2/2]

message_dialog & xtd::forms::message_dialog::icon ( xtd::forms::message_dialog_icon icon )

Sets icon to display in the message dialog.

Parameters

icon	One of the xtd::forms::message_dialog_icon values that specifies which icon to display in the message dialog.

Returns: Current message dialog.

◆ options() [1/2]

xtd::forms::message_dialog_options xtd::forms::message_dialog::options ( ) const

noexcept

Gets options will be used for the message box.

Returns: One of the xtd::forms::message_dialog_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.

◆ options() [2/2]

message_dialog & xtd::forms::message_dialog::options ( xtd::forms::message_dialog_options options )

Sets options will be used for the message box.

Parameters

options One of the xtd::forms::message_dialog_options values that specifies which display and association options will be used for the message box. You may pass in 0 if you wish to use the defaults.

Returns: Current message dialog.

◆ message() [1/2]

xtd::string xtd::forms::message_dialog::message ( ) const

noexcept

Gets the text message.

Returns: The text message.

◆ message() [2/2]

message_dialog & xtd::forms::message_dialog::message ( const xtd::string & message )

Sets the text message.

Parameters

message The text message.

Returns: Current message_dialog instance.

◆ text() [1/2]

xtd::string xtd::forms::message_dialog::text ( ) const

noexcept

Gets the dialog caption text.

Returns: The current dialog caption text.

◆ text() [2/2]

message_dialog & xtd::forms::message_dialog::text ( const xtd::string & text )

Sets the dialog caption text.

Parameters

text	The new dialog caption text.

Returns: Current message_dialog instance.

◆ reset()

void xtd::forms::message_dialog::reset ( )

Resets all properties to empty string.

◆ show_dialog() [1/2]

xtd::forms::dialog_result xtd::forms::message_dialog::show_dialog ( )

Runs message dialog box.

◆ show_dialog() [2/2]

xtd::forms::dialog_result xtd::forms::message_dialog::show_dialog ( const iwin32_window & owner )

Runs message dialog box.

◆ show_sheet()

void xtd::forms::message_dialog::show_sheet ( const iwin32_window & owner )

Runs message dialog box.

◆ show_sheet_dialog()

xtd::forms::dialog_result xtd::forms::message_dialog::show_sheet_dialog ( const iwin32_window & owner )

Runs message dialog box.

Member Data Documentation

◆ help_request

event<message_dialog, help_event_handler> xtd::forms::message_dialog::help_request

Occurs when the user clicks the Help button on a common dialog box.

Remarks: For more information about handling events, see Handling and Raising Events.

◆ dialog_closed

event<message_dialog, dialog_closed_event_handler> xtd::forms::message_dialog::dialog_closed

Occurs when the user close a message dialog box with dialog close button or other dialog buttons.

Remarks: For more information about handling events, see Handling and Raising Events.

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

xtd.forms/include/xtd/forms/message_dialog.h

Definition

Public Events

Public Constructors

Public Properties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ message_dialog()

Member Function Documentation

◆ buttons() [1/2]

◆ buttons() [2/2]

◆ default_button() [1/2]

◆ default_button() [2/2]

◆ display_help_button() [1/2]

◆ display_help_button() [2/2]

◆ dialog_result()

◆ dialog_appearance() [1/2]

◆ dialog_appearance() [2/2]

◆ icon() [1/2]

◆ icon() [2/2]

◆ options() [1/2]

◆ options() [2/2]

◆ message() [1/2]

◆ message() [2/2]

◆ text() [1/2]

◆ text() [2/2]

◆ reset()

◆ show_dialog() [1/2]

◆ show_dialog() [2/2]

◆ show_sheet()

◆ show_sheet_dialog()

Member Data Documentation

◆ help_request

◆ dialog_closed