115% line height on lists is more than enough, especially for the class hierarchy...

[wxWidgets.git] / interface / dirctrl.h

diff --git a/interface/dirctrl.h b/interface/dirctrl.h
index dfdcff4b0b990d9aa8b33c89a9b4836443469d34..018686b534415e381485bfa5bea4ab58ace89aac 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
@@ -9,13 +9,13 @@
 /**
     @class wxGenericDirCtrl
     @wxheader{dirctrl.h}
-    
+
     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.
-    
+
     @library{wxbase}
     @category{ctrl}
     @appearance{genericdirctrl.png}
@@ -26,47 +26,38 @@ public:
     //@{
     /**
         Main constructor.
-        
-        @param parent 
-        Parent window.
-        
-        @param id 
-        Window identifier.
-        
-        @param dir 
-        Initial folder.
-        
-        @param pos 
-        Position.
-        
-        @param size 
-        Size.
-        
-        @param style 
-        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"
-        
-        @param defaultFilter 
-        The zero-indexed default filter setting.
-        
-        @param name 
-        The window name.
+
+        @param parent
+            Parent window.
+        @param id
+            Window identifier.
+        @param dir
+            Initial folder.
+        @param pos
+            Position.
+        @param size
+            Size.
+        @param style
+            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"
+        @param defaultFilter
+            The zero-indexed default filter setting.
+        @param name
+            The window name.
     */
     wxGenericDirCtrl();
-        wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
-                         const wxString& dir = wxDirDialogDefaultFolderStr,
-                         const wxPoint& pos = wxDefaultPosition,
-                         const wxSize& size = wxDefaultSize,
-                         long style = wxDIRCTRL_3D_INTERNAL|wxBORDER_SUNKEN,
-                         const wxString& filter = wxEmptyString,
-                         int defaultFilter = 0,
-                         const wxString& name = wxTreeCtrlNameStr);
+    wxGenericDirCtrl(wxWindow* parent, const wxWindowID id = -1,
+                     const wxString& dir = wxDirDialogDefaultFolderStr,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxDIRCTRL_3D_INTERNAL|wxBORDER_SUNKEN,
+                     const wxString& filter = wxEmptyString,
+                     int defaultFilter = 0,
+                     const wxString& name = wxTreeCtrlNameStr);
     //@}
 
     /**
@@ -105,34 +96,33 @@ public:
     /**
         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 +132,7 @@ public:
     /**
         Returns a pointer to the tree control.
     */
-    wxTreeCtrl* GetTreeCtrl();
+    wxTreeCtrl* GetTreeCtrl() const;
 
     /**
         Initializes variables.
@@ -176,9 +166,10 @@ public:
     void SetPath(const wxString& path);
 
     /**
-        @param show 
-        If @true, hidden folders and files will be displayed by the
-        control. If @false, they will not be displayed.
+        @param show
+            If @true, hidden folders and files will be displayed by the
+            control. If @false, they will not be displayed.
     */
     void ShowHidden(bool show);
 };
+