fix various Doxygen errors (#9568)

[wxWidgets.git] / interface / dirctrl.h

diff --git a/interface/dirctrl.h b/interface/dirctrl.h
index 80ef780c2ad4ca1b5b48d731e388ba548aff25b4..b83c4248df8d8426fca17ac25ab6b9160c389798 100644 (file)
--- a/interface/dirctrl.h
+++ b/interface/dirctrl.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        dirctrl.h
-// Purpose:     documentation for wxGenericDirCtrl class
+// Purpose:     interface of wxGenericDirCtrl
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -10,55 +10,60 @@
     @class wxGenericDirCtrl
     @wxheader{dirctrl.h}
 
-    This control can  be used to place a directory listing (with optional files) on
-    an arbitrary window.
+    This control can  be used to place a directory listing (with optional
+    files) on an arbitrary window.
 
     The control contains a wxTreeCtrl window representing the directory
     hierarchy, and optionally, a wxChoice window containing a list of filters.
 
+    @beginStyleTable
+    @style{wxDIRCTRL_DIR_ONLY}
+           Only show directories, and not files.
+    @style{wxDIRCTRL_3D_INTERNAL}
+           Use 3D borders for internal controls.
+    @style{wxDIRCTRL_SELECT_FIRST}
+           When setting the default path, select the first file in the
+           directory.
+    @style{wxDIRCTRL_EDIT_LABELS}
+           Allow the folder and file labels to be editable.
+    @endStyleTable
+
     @library{wxbase}
     @category{ctrl}
-    @appearance{genericdirctrl.png}
+    <!-- @appearance{genericdirctrl.png} -->
 */
 class wxGenericDirCtrl : public wxControl
 {
 public:
-    //@{
+    /**
+        Default constructor.
+    */
+    wxGenericDirCtrl();
     /**
         Main constructor.
-        
+
         @param parent
-        Parent window.
-        
+            Parent window.
         @param id
-        Window identifier.
-        
+            Window identifier.
         @param dir
-        Initial folder.
-        
+            Initial folder.
         @param pos
-        Position.
-        
+            Position.
         @param size
-        Size.
-        
+            Size.
         @param style
-        Window style. Please see wxGenericDirCtrl for a list of possible styles.
-        
+            Window style. Please see wxGenericDirCtrl for a list of possible
+            styles.
         @param filter
-        A filter string, using the same syntax as that for wxFileDialog. This may be
-        empty if filters
-        are not being used.
-        
-        Example: "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
-        
+            A filter string, using the same syntax as that for wxFileDialog.
+            This may be empty if filters are not being used. Example:
+            @c "All files (*.*)|*.*|JPEG files (*.jpg)|*.jpg"
         @param defaultFilter
-        The zero-indexed default filter setting.
-        
+            The zero-indexed default filter setting.
         @param name
-        The window name.
+            The window name.
     */
-    wxGenericDirCtrl();
     wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
                      const wxString& dir = wxDirDialogDefaultFolderStr,
                      const wxPoint& pos = wxDefaultPosition,
@@ -67,7 +72,6 @@ public:
                      const wxString& filter = wxEmptyString,
                      int defaultFilter = 0,
                      const wxString& name = wxTreeCtrlNameStr);
-    //@}
 
     /**
         Destructor.
@@ -75,7 +79,7 @@ public:
     ~wxGenericDirCtrl();
 
     /**
-        Collapse the given path.
+        Collapse the given @a path.
     */
     bool CollapsePath(const wxString& path);
 
@@ -85,7 +89,8 @@ public:
     void CollapseTree();
 
     /**
-        Create function for two-step construction. See wxGenericDirCtrl() for details.
+        Create function for two-step construction. See wxGenericDirCtrl() for
+        details.
     */
     bool Create(wxWindow* parent, const wxWindowID id = -1,
                 const wxString& dir = wxDirDialogDefaultFolderStr,
@@ -97,42 +102,42 @@ public:
                 const wxString& name = wxTreeCtrlNameStr);
 
     /**
-        Tries to expand as much of the given path as possible, so that the filename or
-        directory is visible in the tree control.
+        Tries to expand as much of the given @a path as possible, so that the
+        filename or directory is visible in the tree control.
     */
     bool ExpandPath(const wxString& path);
 
     /**
         Gets the default path.
     */
-    wxString GetDefaultPath();
+    wxString GetDefaultPath() const;
 
     /**
         Gets selected filename path only (else empty string).
-        
+
         This function doesn't count a directory as a selection.
     */
-    wxString GetFilePath();
+    wxString GetFilePath() const;
 
     /**
         Returns the filter string.
     */
-    wxString GetFilter();
+    wxString GetFilter() const;
 
     /**
         Returns the current filter index (zero-based).
     */
-    int GetFilterIndex();
+    int GetFilterIndex() const;
 
     /**
         Returns a pointer to the filter list control (if present).
     */
-    wxDirFilterListCtrl* GetFilterListCtrl();
+    wxDirFilterListCtrl* GetFilterListCtrl() const;
 
     /**
         Gets the currently-selected directory or filename.
     */
-    wxString GetPath();
+    wxString GetPath() const;
 
     /**
         Returns the root id for the tree control.
@@ -142,7 +147,7 @@ public:
     /**
         Returns a pointer to the tree control.
     */
-    wxTreeCtrl* GetTreeCtrl();
+    wxTreeCtrl* GetTreeCtrl() const;
 
     /**
         Initializes variables.
@@ -150,8 +155,8 @@ public:
     void Init();
 
     /**
-        Collapse and expand the tree, thus re-creating it from scratch.
-        May be used to update the displayed directory content.
+        Collapse and expand the tree, thus re-creating it from scratch. May be
+        used to update the displayed directory content.
     */
     void ReCreateTree();
 
@@ -177,8 +182,9 @@ public:
 
     /**
         @param show
-        If @true, hidden folders and files will be displayed by the
-        control. If @false, they will not be displayed.
+            If @true, hidden folders and files will be displayed by the
+            control. If @false, they will not be displayed.
     */
     void ShowHidden(bool show);
 };
+