docstring patch has been submitted to SF

[wxWidgets.git] / wxPython / src / _dirctrl.i

diff --git a/wxPython/src/_dirctrl.i b/wxPython/src/_dirctrl.i
index 707c2a83ec930562fbda0c7d0fc965d47fa819cf..8d207caf6573bfc88736e4831c30093644fc616a 100644 (file)
--- a/wxPython/src/_dirctrl.i
+++ b/wxPython/src/_dirctrl.i
@@ -15,9 +15,7 @@
 
 //---------------------------------------------------------------------------
 
-%{
-    DECLARE_DEF_STRING(DirDialogDefaultFolderStr);
-%}
+MAKE_CONST_WXSTRING(DirDialogDefaultFolderStr);
 
 //---------------------------------------------------------------------------
 %newgroup
@@ -69,7 +67,7 @@ public:
                      long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
                      const wxString& filter = wxPyEmptyString,
                      int defaultFilter = 0,
-                     const wxString& name = wxPy_TreeCtrlNameStr);
+                     const wxString& name = wxPyTreeCtrlNameStr);
     %name(PreGenericDirCtrl)wxGenericDirCtrl();
 
 
@@ -80,7 +78,7 @@ public:
                 long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
                 const wxString& filter = wxPyEmptyString,
                 int defaultFilter = 0,
-                const wxString& name = wxPy_TreeCtrlNameStr);
+                const wxString& name = wxPyTreeCtrlNameStr);
 
 
     
@@ -110,18 +108,20 @@ public:
 
     virtual wxTreeItemId GetRootId();
 
-    virtual wxTreeCtrl* GetTreeCtrl() const;
+    virtual wxPyTreeCtrl* GetTreeCtrl() const;
     virtual wxDirFilterListCtrl* GetFilterListCtrl() const;
 
     
     // Parse the filter into an array of filters and an array of descriptions
 //     virtual int ParseFilter(const wxString& filterStr, wxArrayString& filters, wxArrayString& descriptions);
     
-    // Find the child that matches the first part of 'path'.
-    // E.g. if a child path is "/usr" and 'path' is "/usr/include"
-    // then the child for /usr is returned.
-    // If the path string has been used (we're at the leaf), done is set to TRUE
-    virtual wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& OUTPUT);
+    DocDeclAStr(
+        virtual wxTreeItemId, FindChild(wxTreeItemId parentId, const wxString& path, bool& OUTPUT),
+        "FindChild(wxTreeItemId parentId, wxString path) -> (item, done)",
+        "Find the child that matches the first part of 'path'.  E.g. if a child path is\n"
+        "\"/usr\" and 'path' is \"/usr/include\" then the child for /usr is returned.\n"
+        "If the path string has been used (we're at the leaf), done is set to True\n");
+        
     
     // Resize the components of the control
     virtual void DoResize();