Add NUM_CUSTOM

[wxWidgets.git] / interface / wx / dirdlg.h

diff --git a/interface/wx/dirdlg.h b/interface/wx/dirdlg.h
index 4d21deac8577d18008a59a56462bdd2f1e7d95a4..b32b4c27b80dea8689f574ecfa0223e12d93bb9e 100644 (file)
--- a/interface/wx/dirdlg.h
+++ b/interface/wx/dirdlg.h
@@ -3,12 +3,28 @@
 // Purpose:     interface of wxDirDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxDirDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#define wxDD_DEFAULT_STYLE      (wxDEFAULT_DIALOG_STYLE|wxRESIZE_BORDER)
+
+/**
+    Initial folder for generic directory dialog.
+*/
+const char wxDirDialogDefaultFolderStr[] = "/";
+
+/**
+    Default message for directory selector dialog.
+*/
+const char wxDirSelectorPromptStr[] = "Select a directory";
+
+/**
+    Default name for directory selector dialog.
+*/
+const char wxDirDialogNameStr[] = "wxDirCtrl";
+

 /**
     @class wxDirDialog
 /**
     @class wxDirDialog

-    @wxheader{dirdlg.h}

 
     This class represents the directory chooser dialog.
 
 
     This class represents the directory chooser dialog.
 


@@ -26,8 +42,20 @@
            user.
     @endStyleTable
 
            user.
     @endStyleTable
 

-    @note On Windows the new directory button is only available with recent
-          versions of the common dialogs.
+    Notice that @c wxRESIZE_BORDER has special side effect under recent (i.e.
+    later than Win9x) Windows where two different directory selection dialogs
+    are available and this style also implicitly selects the new version as the
+    old one always has fixed size. As the new version is almost always
+    preferable, it is recommended that @c wxRESIZE_BORDER style be always used.
+    This is the case if the dialog is created with the default style value but
+    if you need to use any additional styles you should still specify @c
+    wxDD_DEFAULT_STYLE unless you explicitly need to use the old dialog version
+    under Windows. E.g. do
+    @code
+        wxDirDialog dlg(NULL, "Choose input directory", "",
+                        wxDD_DEFAULT_STYLE | wxDD_DIR_MUST_EXIST);
+    @endcode
+    instead of just using @c wxDD_DIR_MUST_EXIST style alone.

 
     @library{wxcore}
     @category{cmndlg}
 
     @library{wxcore}
     @category{cmndlg}


@@ -56,37 +84,37 @@ public:
             The dialog name, not used.
     */
     wxDirDialog(wxWindow* parent,
             The dialog name, not used.
     */
     wxDirDialog(wxWindow* parent,

-                const wxString& message = "Choose a directory",
-                const wxString& defaultPath = "",
+                const wxString& message = wxDirSelectorPromptStr,
+                const wxString& defaultPath = wxEmptyString,

                 long style = wxDD_DEFAULT_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDD_DEFAULT_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                const wxString& name = "wxDirCtrl");
+                const wxString& name = wxDirDialogNameStr);

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxDirDialog();
+    virtual ~wxDirDialog();

 
     /**
         Returns the message that will be displayed on the dialog.
     */
 
     /**
         Returns the message that will be displayed on the dialog.
     */

-    wxString GetMessage() const;
+    virtual wxString GetMessage() const;

 
     /**
         Returns the default or user-selected path.
     */
 
     /**
         Returns the default or user-selected path.
     */

-    wxString GetPath() const;
+    virtual wxString GetPath() const;

 
     /**
         Sets the message that will be displayed on the dialog.
     */
 
     /**
         Sets the message that will be displayed on the dialog.
     */

-    void SetMessage(const wxString& message);
+    virtual void SetMessage(const wxString& message);

 
     /**
         Sets the default path.
     */
 
     /**
         Sets the default path.
     */

-    void SetPath(const wxString& path);
+    virtual void SetPath(const wxString& path);

 
     /**
         Shows the dialog, returning wxID_OK if the user pressed OK, and
 
     /**
         Shows the dialog, returning wxID_OK if the user pressed OK, and


@@ -101,7 +129,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */

 //@{
 
 /**
 //@{
 
 /**


@@ -123,7 +151,7 @@ public:
     @header{wx/dirdlg.h}
 */
 wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr,
     @header{wx/dirdlg.h}
 */
 wxString wxDirSelector(const wxString& message = wxDirSelectorPromptStr,

-                       const wxString& default_path = "",
+                       const wxString& default_path = wxEmptyString,

                        long style = 0,
                        const wxPoint& pos = wxDefaultPosition,
                        wxWindow* parent = NULL);
                        long style = 0,
                        const wxPoint& pos = wxDefaultPosition,
                        wxWindow* parent = NULL);