xtd.forms - Reference Guide  0.1.0
Modern c++17 library containing classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and Linux like Ubuntu operating system.
xtd::forms::folder_browser_dialog Class Reference
Inheritance diagram for xtd::forms::folder_browser_dialog:
xtd::forms::common_dialog xtd::forms::component

Public Member Functions

bool auto_upgrade_enable () const
 
folder_browser_dialogauto_upgrade_enable (bool value)
 
const ustringdescription () const
 
folder_browser_dialogdescription (const ustring &value)
 
void reset () override
 Resets all options to their default values, the last selected color to black, and the custom colors to their default values. More...
 
environment::special_folder root_folder () const
 
folder_browser_dialogroot_folder (environment::special_folder value)
 
const ustringselected_path () const
 
folder_browser_dialogselected_path (const ustring &value)
 
- Public Member Functions inherited from xtd::forms::common_dialog
 common_dialog ()=default
 Initializes a new instance of the common_dialog class. 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...
 
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...
 

Protected Member Functions

bool run_dialog (intptr_t owner) override
 When overridden in a derived class, specifies a common dialog box. More...
 
- Protected Member Functions inherited from xtd::forms::common_dialog
virtual void on_help_request (help_event_args &e)
 Raises the help_request event. More...
 
- Protected Member Functions inherited from xtd::forms::component
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...
 

Additional Inherited Members

- Public Attributes inherited from xtd::forms::common_dialog
event< common_dialog, help_event_handler< component & > > help_request
 Occurs when the user clicks the Help button on a common dialog box. More...
 

Member Function Documentation

§ reset()

void xtd::forms::folder_browser_dialog::reset ( )
overridevirtual

Resets all options to their default values, the last selected color to black, and the custom colors to their default values.

Implements xtd::forms::common_dialog.

§ run_dialog()

bool xtd::forms::folder_browser_dialog::run_dialog ( intptr_t  owner)
overrideprotectedvirtual

When overridden in a derived class, specifies a common dialog box.

Parameters
ownerA value that represents the window handle of the owner window for the common dialog box.
Returns
true if the dialog box was successfully run; otherwise, false.

Implements xtd::forms::common_dialog.


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