xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
xtd::forms::input_dialog Class Reference

Represents a common dialog box that displays input box. More...

#include <input_dialog.h>

Inheritance diagram for xtd::forms::input_dialog:
xtd::forms::common_dialog xtd::forms::component

Public Member Functions

 input_dialog ()=default
 Initializes a new instance of the input_dialog class. More...
 
xtd::forms::character_casing character_casing () const
 
input_dialogcharacter_casing (xtd::forms::character_casing character_casing)
 
xtd::forms::dialog_result dialog_result () const
 
xtd::forms::dialog_style dialog_style () const
 
input_dialogdialog_style (xtd::forms::dialog_style dialog_style)
 
input_dialogmessage (const std::string &message)
 Sets the text message. More...
 
std::string messsage () const
 Gets the text message. More...
 
bool multiline () const
 
input_dialogmultiline (bool multiline)
 
void reset () override
 Resets all properties to empty string. More...
 
xtd::forms::dialog_result show_dialog ()
 Runs a common dialog box with a default owner. More...
 
xtd::forms::dialog_result show_dialog (const iwin32_window &owner)
 Runs a common dialog box with the specified owner. More...
 
void show_sheet (const iwin32_window &owner)
 Runs a common dialog box with the specified owner. More...
 
xtd::forms::dialog_result show_sheet_dialog (const iwin32_window &owner)
 Runs a common dialog box with the specified owner. More...
 
std::any tag () const
 Gets an object that contains data about the control. More...
 
common_dialogtag (const std::any &tag)
 Sets an object that contains data about the control. More...
 
std::string text () const
 Gets the dialog caption text. More...
 
input_dialogtext (const std::string &text)
 Sets the dialog caption text. More...
 
bool use_system_password_char () const
 
void use_system_password_char (bool use_system_password_char)
 
std::string value () const
 Gets the value. More...
 
input_dialogvalue (const std::string &value)
 Sets thevalue. More...
 

Public Attributes

event< common_dialog, common_dialog_closed_event_handler< component & > > common_dialog_closed
 
event< common_dialog, help_event_handler< component & > > help_request
 Occurs when the user clicks the Help button on a common dialog box. More...
 

Protected Member Functions

virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 
virtual void on_common_dialog_closed (const common_dialog_closed_event_args &e)
 Raises the close event. More...
 
virtual void on_help_request (help_event_args &e)
 Raises the help_request event. More...
 
bool run_dialog (intptr_t owner) override
 When overridden in a derived class, specifies a common dialog box. More...
 
void run_sheet (intptr_t owner) override
 When overridden in a derived class, specifies a common dialog box. More...
 

Protected Attributes

xtd::forms::character_casing character_casing_ = xtd::forms::character_casing::normal
 
xtd::forms::dialog_style dialog_style_ = xtd::forms::dialog_style::standard
 
std::string message_
 
bool multiline_ = false
 
std::string text_
 
bool use_system_password_char_ = false
 
std::string value_
 

Detailed Description

Represents a common dialog box that displays input box.

Example
The following code example demonstrate the use of input_dialog dialog.

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