X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..49d37022125686b42877f0a5a971e13fb1381e87:/interface/dirdlg.h diff --git a/interface/dirdlg.h b/interface/dirdlg.h index ca177ae564..cb7b4eba1c 100644 --- a/interface/dirdlg.h +++ b/interface/dirdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dirdlg.h -// Purpose: documentation for wxDirDialog class +// Purpose: interface of wxDirDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog + @see @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog */ class wxDirDialog : public wxDialog { @@ -38,7 +37,7 @@ public: /** Constructor. Use ShowModal() to show the dialog. - + @param parent Parent window. @param message @@ -95,14 +94,19 @@ public: }; + // ============================================================================ // 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: @@ -110,9 +114,11 @@ public: 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 = "", @@ -120,3 +126,5 @@ wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr, const wxPoint& pos = wxDefaultPosition, wxWindow* parent = NULL); +//@} +