This class represents the directory chooser dialog.
@beginStyleTable
- @style{wxDD_DEFAULT_STYLE}:
+ @style{wxDD_DEFAULT_STYLE}
Equivalent to a combination of wxDEFAULT_DIALOG_STYLE and
wxRESIZE_BORDER (the last one is not used under wxWinCE).
- @style{wxDD_DIR_MUST_EXIST}:
+ @style{wxDD_DIR_MUST_EXIST}
The dialog will allow the user to choose only an existing folder.
When this style is not given, a "Create new directory" button is
added to the dialog (on Windows) or some other way is provided to
the user to type the name of a new folder.
- @style{wxDD_CHANGE_DIR}:
+ @style{wxDD_CHANGE_DIR}
Change the current working directory to the directory chosen by the
user.
@endStyleTable
/**
Constructor. Use ShowModal() to show
the dialog.
-
+
@param parent
Parent window.
@param message
// Global functions/macros
// ============================================================================
+/** @ingroup group_funcmacro_dialog */
+//@{
+
/**
- Pops up a directory selector dialog. The arguments have the same meaning as
- those of wxDirDialog::wxDirDialog(). The message is displayed at the top,
- and the default_path, if specified, is set as the initial selection.
+ Pops up a directory selector dialog. The arguments have the same meaning
+ as those of wxDirDialog::wxDirDialog(). The message is displayed at the
+ top, and the default_path, if specified, is set as the initial selection.
+
The application must check for an empty return value (if the user pressed
Cancel). For example:
const wxString& dir = wxDirSelector("Choose a folder");
if ( !dir.empty() )
{
- ...
+ ...
}
@endcode
+
+ @header{wx/dirdlg.h}
*/
wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr,
const wxString& default_path = "",
const wxPoint& pos = wxDefaultPosition,
wxWindow* parent = NULL);
+//@}
+