xtd 0.2.0
xtd::forms::message_box Class Referencefinal
Inheritance diagram for xtd::forms::message_box:
xtd::static_object

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_box can contain text, buttons, and symbols that inform and instruct the user.

Header
#include <xtd/forms/message_box>
Namespace
xtd::forms
Library
xtd.forms
Appearance
Windows macOS Gnome
Light
Dark
Examples
The following code example demonstrates the use of message_box dialog.
#include <xtd/forms/application>
#include <xtd/forms/button>
#include <xtd/forms/form>
#include <xtd/forms/label>
#include <xtd/forms/message_box>
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});
text("Message box exemple");
button_show_message.location({10, 10});
button_show_message.text("Message...");
button_show_message.width(100);
button_show_message.click += [&] {
auto result = message_box::show(*this, "Hello, World!", "Message", message_box_buttons::ok_cancel, message_box_icon::warning);
label_dialog_result.text(string::format("dialog_result = {}", result));
};
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 {});
}
static void run()
Begins running a standard application message loop on the current thread, without a form.
virtual control_collection & controls() noexcept
Gets the collection of controls contained within the control.
Represents a window or dialog box that makes up an application's user interface.
Definition form.hpp:54
virtual form_start_position start_position() const noexcept
Gets the starting position of the form at run time.
virtual void push_back_range(const arranged_element_collection &collection)
Adds elements to the end.
Definition arranged_element_collection.hpp:393
static dialog_result show()
Displays a message box.
xtd::forms::style_sheets::control label
The label data allows you to specify the box of a label control.
Definition label.hpp:25
xtd::forms::style_sheets::control button
The buttton data allows you to specify the box of a button control.
Definition button.hpp:25
@ warning
The message box contains a symbol consisting of an exclamation point in a triangle with a yellow back...
Definition message_dialog_icon.hpp:30
@ location
Specifies that both the x and y coordinates of the control are defined.
Definition bounds_specified.hpp:30
@ text
The xtd::forms::status_bar_panel displays text in the standard font.
Definition status_bar_panel_style.hpp:25
@ ok_cancel
The message box contains OK and Cancel buttons.
Definition message_dialog_buttons.hpp:26
@ manual
The position of the form is determined by the Location property.
Definition form_start_position.hpp:24
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition texts.hpp:217
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8

Public Static Methods

static dialog_result show (const iwin32_window &owner)
 Displays a message box in front of the specified window.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text)
 Displays a message box in front of the specified window with specified text.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption)
 Displays a message box in front of the specified window with specified text and caption.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption, message_box_buttons buttons)
 Displays a message box in front of the specified window with the specified text, caption, and buttons.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon)
 Displays a message box in front of the specified window with the specified text, caption, buttons, and icon.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button)
 Displays a message box in front of the specified window with the specified text, caption, buttons, icon, and default button.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options)
 Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, and options.
 
static dialog_result show (const iwin32_window &owner, const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options, bool display_help_button)
 Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, options, and Help button.
 
static dialog_result show ()
 Displays a message box.
 
static dialog_result show (const xtd::string &text)
 Displays a message box with specified text.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption)
 Displays a message box with specified text and caption.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption, message_box_buttons buttons)
 Displays a message box with the specified text, caption, and buttons.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon)
 Displays a message box with the specified text, caption, buttons, and icon.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button)
 Displays a message box with the specified text, caption, buttons, icon, and default button.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options)
 Displays a message box with the specified text, caption, buttons, icon, default button, and options.
 
static dialog_result show (const xtd::string &text, const xtd::string &caption, message_box_buttons buttons, message_box_icon icon, message_box_default_button default_button, message_box_options options, bool display_help_button)
 Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.
 

Member Function Documentation

◆ show() [1/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner)
static

Displays a message box in front of the specified window.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [2/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text )
static

Displays a message box in front of the specified window with specified text.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [3/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption )
static

Displays a message box in front of the specified window with specified text and caption.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [4/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons )
static

Displays a message box in front of the specified window with the specified text, caption, and buttons.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [5/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon )
static

Displays a message box in front of the specified window with the specified text, caption, buttons, and icon.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [6/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button )
static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, and default button.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [7/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button,
message_box_options options )
static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, and options.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
optionsOne of the message_box_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
One of the xtd::forms::dialog_result values.

◆ show() [8/16]

static dialog_result xtd::forms::message_box::show ( const iwin32_window & owner,
const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button,
message_box_options options,
bool display_help_button )
static

Displays a message box in front of the specified window with the specified text, caption, buttons, icon, default button, options, and Help button.

Parameters
ownerAn implementation of iwin32_window that will own the modal dialog box.
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
optionsOne of the message_box_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.
display_help_buttontrue to show the Help button; otherwise, false. The default is false.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [9/16]

static dialog_result xtd::forms::message_box::show ( )
static

Displays a message box.

Returns
One of the xtd::forms::dialog_result values.
Examples
hello_world_message_box3.cpp.

◆ show() [10/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text)
static

Displays a message box with specified text.

Parameters
textThe text to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [11/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption )
static

Displays a message box with specified text and caption.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [12/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons )
static

Displays a message box with the specified text, caption, and buttons.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [13/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon )
static

Displays a message box with the specified text, caption, buttons, and icon.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [14/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button )
static

Displays a message box with the specified text, caption, buttons, icon, and default button.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
Returns
One of the xtd::forms::dialog_result values.

◆ show() [15/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button,
message_box_options options )
static

Displays a message box with the specified text, caption, buttons, icon, default button, and options.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
optionsOne of the message_box_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
One of the xtd::forms::dialog_result values.

◆ show() [16/16]

static dialog_result xtd::forms::message_box::show ( const xtd::string & text,
const xtd::string & caption,
message_box_buttons buttons,
message_box_icon icon,
message_box_default_button default_button,
message_box_options options,
bool display_help_button )
static

Displays a message box with the specified text, caption, buttons, icon, default button, options, and Help button.

Parameters
textThe text to display in the message box.
captionThe text to display in the title bar of the message box.
buttonsOne of the message_box_buttons values that specifies which buttons to display in the message box.
iconOne of the message_box_icon values that specifies which icon to display in the message box.
default_buttonOne of the message_box_default_button values that specifies the default button for the message box.
optionsOne of the message_box_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.
display_help_buttontrue to show the Help button; otherwise, false. The default is false.
Returns
One of the xtd::forms::dialog_result values.

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