Updated note about wxSTC using wxPopupWindow

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

diff --git a/wxPython/src/controls2.i b/wxPython/src/controls2.i
index 2e6b36ab84b16ebf4b1d1e1eea0c5d865004b60c..37671c76bc7f04704aa69035dc47f2a9d707c7cb 100644 (file)
--- a/wxPython/src/controls2.i
+++ b/wxPython/src/controls2.i
@@ -20,6 +20,7 @@
 #include <wx/listctrl.h>
 #include <wx/treectrl.h>
 #include <wx/imaglist.h>
 #include <wx/listctrl.h>
 #include <wx/treectrl.h>
 #include <wx/imaglist.h>

+#include <wx/dirctrl.h>

 %}
 
 //----------------------------------------------------------------------
 %}
 
 //----------------------------------------------------------------------


@@ -39,6 +40,23 @@
 
 
 //----------------------------------------------------------------------
 
 
 //----------------------------------------------------------------------

+%{
+    // Put some wx default wxChar* values into wxStrings.
+    const wxChar* wxListCtrlNameStr = _T("wxListCtrl");
+    DECLARE_DEF_STRING(ListCtrlNameStr);
+
+    const wxChar* wx_TreeCtrlNameStr = _T("wxTreeCtrl");
+    DECLARE_DEF_STRING(_TreeCtrlNameStr);
+    DECLARE_DEF_STRING(DirDialogDefaultFolderStr);
+
+    static const wxString wxPyEmptyString(wxT(""));
+%}
+
+
+%{
+    static const long longzero = 0;
+%}
+

 //----------------------------------------------------------------------
 
 enum {
 //----------------------------------------------------------------------
 
 enum {


@@ -331,14 +349,17 @@ class wxListEvent: public wxNotifyEvent {
 public:
     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 
 public:
     wxListEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
 

+%readonly

     int           m_code;
     long          m_oldItemIndex;
     long          m_itemIndex;
     int           m_col;
     wxPoint       m_pointDrag;
     wxListItem    m_item;
     int           m_code;
     long          m_oldItemIndex;
     long          m_itemIndex;
     int           m_col;
     wxPoint       m_pointDrag;
     wxListItem    m_item;

+%readwrite

 
 

-    int GetCode();
+    int GetKeyCode();
+    %pragma(python) addtoclass = "GetCode = GetKeyCode"

     long GetIndex();
     int GetColumn();
     wxPoint GetPoint();
     long GetIndex();
     int GetColumn();
     wxPoint GetPoint();


@@ -364,7 +385,7 @@ public:
                  const wxSize& size,
                  long style,
                  const wxValidator& validator,
                  const wxSize& size,
                  long style,
                  const wxValidator& validator,

-                 char* name) :
+                 const wxString& name) :

         wxListCtrl(parent, id, pos, size, style, validator, name) {}
 
     bool Create(wxWindow* parent, wxWindowID id,
         wxListCtrl(parent, id, pos, size, style, validator, name) {}
 
     bool Create(wxWindow* parent, wxWindowID id,


@@ -372,7 +393,7 @@ public:
                 const wxSize& size,
                 long style,
                 const wxValidator& validator,
                 const wxSize& size,
                 long style,
                 const wxValidator& validator,

-                char* name) {
+                const wxString& name) {

         return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
     }
 
         return wxListCtrl::Create(parent, id, pos, size, style, validator, name);
     }
 


@@ -399,7 +420,7 @@ public:
                  const wxSize& size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxSize& size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,

-                 char* name = "listCtrl");
+                 const wxString& name = wxPyListCtrlNameStr);

     %name(wxPreListCtrl)wxPyListCtrl();
 
     bool Create(wxWindow* parent, wxWindowID id = -1,
     %name(wxPreListCtrl)wxPyListCtrl();
 
     bool Create(wxWindow* parent, wxWindowID id = -1,


@@ -407,7 +428,7 @@ public:
                  const wxSize& size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxSize& size = wxDefaultSize,
                  long style = wxLC_ICON,
                  const wxValidator& validator = wxDefaultValidator,

-                 char* name = "listCtrl");
+                 const wxString& name = wxPyListCtrlNameStr);

 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxListCtrl)"


@@ -420,7 +441,23 @@ public:
     bool SetBackgroundColour(const wxColour& col);
 
     // Gets information about this column
     bool SetBackgroundColour(const wxColour& col);
 
     // Gets information about this column

-    bool GetColumn(int col, wxListItem& item) const;
+    // bool GetColumn(int col, wxListItem& item) const;
+    %addmethods {
+        %new wxListItem* GetColumn(int col) {
+            wxListItem item;
+            item.SetMask(0xFFFF);
+            if (self->GetColumn(col, item))
+                return new wxListItem(item);
+            else
+                return NULL;
+        }
+    } // The OOR typemaps don't know what to do with the %new, so fix it up.
+    %pragma(python) addtoclass = "
+    def GetColumn(self, *_args, **_kwargs):
+        val = apply(controls2c.wxListCtrl_GetColumn,(self,) + _args, _kwargs)
+        if val is not None: val.thisown = 1
+        return val
+    "

 
     // Sets information about this column
     bool SetColumn(int col, wxListItem& item) ;
 
     // Sets information about this column
     bool SetColumn(int col, wxListItem& item) ;


@@ -457,7 +494,7 @@ public:
     %pragma(python) addtoclass = "
     def GetItem(self, *_args, **_kwargs):
         val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)
     %pragma(python) addtoclass = "
     def GetItem(self, *_args, **_kwargs):
         val = apply(controls2c.wxListCtrl_GetItem,(self,) + _args, _kwargs)

-        val.thisown = 1
+        if val is not None: val.thisown = 1

         return val
     "
 
         return val
     "
 


@@ -639,21 +676,11 @@ public:
     // to scroll. If in report view mode, y specifies the number of lines to scroll.
     bool ScrollList(int dx, int dy);
 
     // to scroll. If in report view mode, y specifies the number of lines to scroll.
     bool ScrollList(int dx, int dy);
 

-    // bool SortItems(wxListCtrlCompare fn, long data);
-    %addmethods {
-        // Sort items.
-        // func is a function which takes 2 long arguments: item1, item2.
-        // item1 is the long data associated with a first item (NOT the index).
-        // item2 is the long data associated with a second item (NOT the index).
-        // The return value is a negative number if the first item should precede the second
-        // item, a positive number of the second item should precede the first,
-        // or zero if the two items are equivalent.
-        bool SortItems(PyObject* func) {
-            if (!PyCallable_Check(func))
-                return FALSE;
-            return self->SortItems(wxPyListCtrl_SortItems, (long)func);
-        }
-    }
+    void SetItemTextColour( long item, const wxColour& col);
+    wxColour GetItemTextColour( long item ) const;
+    void SetItemBackgroundColour( long item, const wxColour &col);
+    wxColour GetItemBackgroundColour( long item ) const;
+

 
     %pragma(python) addtoclass = "
     # Some helpers...
 
     %pragma(python) addtoclass = "
     # Some helpers...


@@ -685,7 +712,45 @@ public:
 
     def ClearColumnImage(self, col):
         self.SetColumnImage(col, -1)
 
     def ClearColumnImage(self, col):
         self.SetColumnImage(col, -1)

+
+    def Append(self, entry):
+        '''Append an item to the list control.  The entry parameter should be a
+           sequence with an item for each column'''
+        if len(entry):
+            pos = self.GetItemCount()
+            self.InsertStringItem(pos, str(entry[0]))
+            for i in range(1, len(entry)):
+                self.SetStringItem(pos, i, str(entry[i]))
+            return pos

     "
     "

+
+
+    // bool SortItems(wxListCtrlCompare fn, long data);
+    %addmethods {
+        // Sort items.
+        // func is a function which takes 2 long arguments: item1, item2.
+        // item1 is the long data associated with a first item (NOT the index).
+        // item2 is the long data associated with a second item (NOT the index).
+        // The return value is a negative number if the first item should precede the second
+        // item, a positive number of the second item should precede the first,
+        // or zero if the two items are equivalent.
+        bool SortItems(PyObject* func) {
+            if (!PyCallable_Check(func))
+                return FALSE;
+            return self->SortItems(wxPyListCtrl_SortItems, (long)func);
+        }
+    }
+
+
+    %addmethods {
+        wxWindow* GetMainWindow() {
+        #ifdef __WXMSW__
+            return self;
+        #else
+            return (wxWindow*)self->m_mainWin;
+        #endif
+        }
+    }

 };
 
 
 };
 
 


@@ -721,7 +786,7 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_REPORT,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_REPORT,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString &name = "listctrl" );
+                const wxString& name = wxPyListCtrlNameStr);

     %name(wxPreListView)wxListView();
 
     bool Create( wxWindow *parent,
     %name(wxPreListView)wxListView();
 
     bool Create( wxWindow *parent,


@@ -730,7 +795,7 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_REPORT,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxSize& size = wxDefaultSize,
                 long style = wxLC_REPORT,
                 const wxValidator& validator = wxDefaultValidator,

-                const wxString &name = "listctrl" );
+                const wxString& name = wxPyListCtrlNameStr);

 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"
 
     %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
     %pragma(python) addtomethod = "wxPreListView:val._setOORInfo(val)"


@@ -765,10 +830,12 @@ enum {
     wxTR_TWIST_BUTTONS,
     wxTR_NO_LINES,
     wxTR_MAC_BUTTONS,
     wxTR_TWIST_BUTTONS,
     wxTR_NO_LINES,
     wxTR_MAC_BUTTONS,

+    wxTR_AQUA_BUTTONS,

 
     wxTR_SINGLE,
     wxTR_MULTIPLE,
     wxTR_EXTENDED,
 
     wxTR_SINGLE,
     wxTR_MULTIPLE,
     wxTR_EXTENDED,

+    wxTR_FULL_ROW_HIGHLIGHT,

 
     wxTR_EDIT_LABELS,
     wxTR_LINES_AT_ROOT,
 
     wxTR_EDIT_LABELS,
     wxTR_LINES_AT_ROOT,


@@ -987,7 +1054,8 @@ public:
     wxTreeItemId GetOldItem();
     wxPoint GetPoint();
     const wxKeyEvent& GetKeyEvent();
     wxTreeItemId GetOldItem();
     wxPoint GetPoint();
     const wxKeyEvent& GetKeyEvent();

-    int GetCode();
+    int GetKeyCode();
+    %pragma(python) addtoclass = "GetCode = GetKeyCode"

     const wxString& GetLabel();
 };
 
     const wxString& GetLabel();
 };
 


@@ -1003,7 +1071,7 @@ public:
                  const wxSize& size,
                  long style,
                  const wxValidator& validator,
                  const wxSize& size,
                  long style,
                  const wxValidator& validator,

-                 char* name) :
+                 const wxString& name) :

         wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
 
     bool Create(wxWindow *parent, wxWindowID id,
         wxTreeCtrl(parent, id, pos, size, style, validator, name) {}
 
     bool Create(wxWindow *parent, wxWindowID id,


@@ -1011,7 +1079,7 @@ public:
                 const wxSize& size,
                 long style,
                 const wxValidator& validator,
                 const wxSize& size,
                 long style,
                 const wxValidator& validator,

-                char* name) {
+                const wxString& name) {

         return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
     }
 
         return wxTreeCtrl::Create(parent, id, pos, size, style, validator, name);
     }
 


@@ -1021,11 +1089,13 @@ public:
         int rval = 0;
         bool found;
         wxPyBeginBlockThreads();
         int rval = 0;
         bool found;
         wxPyBeginBlockThreads();

-        if ((found = m_myInst.findCallback("OnCompareItems")))
-            rval = m_myInst.callCallback(Py_BuildValue(
-                "(OO)",
-                wxPyConstructObject((void*)&item1, "wxTreeItemId"),
-                wxPyConstructObject((void*)&item2, "wxTreeItemId")));
+        if ((found = m_myInst.findCallback("OnCompareItems"))) {
+            PyObject *o1 = wxPyConstructObject((void*)&item1, "wxTreeItemId");
+            PyObject *o2 = wxPyConstructObject((void*)&item2, "wxTreeItemId");
+            rval = m_myInst.callCallback(Py_BuildValue("(OO)",o1,o2));
+            Py_DECREF(o1);
+            Py_DECREF(o2);
+        }

         wxPyEndBlockThreads();
         if (! found)
             rval = wxTreeCtrl::OnCompareItems(item1, item2);
         wxPyEndBlockThreads();
         if (! found)
             rval = wxTreeCtrl::OnCompareItems(item1, item2);


@@ -1050,7 +1120,7 @@ public:
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,

-               char* name = "wxTreeCtrl");
+               const wxString& name = wxPy_TreeCtrlNameStr);

     %name(wxPreTreeCtrl)wxPyTreeCtrl();
 
     bool Create(wxWindow *parent, wxWindowID id = -1,
     %name(wxPreTreeCtrl)wxPyTreeCtrl();
 
     bool Create(wxWindow *parent, wxWindowID id = -1,


@@ -1058,7 +1128,7 @@ public:
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,
                const wxSize& size = wxDefaultSize,
                long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
                const wxValidator& validator = wxDefaultValidator,

-               char* name = "wxTreeCtrl");
+               const wxString& name = wxPy_TreeCtrlNameStr);

 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"
 
     void _setCallbackInfo(PyObject* self, PyObject* _class);
     %pragma(python) addtomethod = "__init__:self._setCallbackInfo(self, wxTreeCtrl)"


@@ -1164,7 +1234,7 @@ public:
 
     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
 
 
     size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
 

-    wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT);
+    wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT = longzero);

     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
     wxTreeItemId GetNextSibling(const wxTreeItemId& item);
     wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
     wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
     wxTreeItemId GetNextSibling(const wxTreeItemId& item);
     wxTreeItemId GetPrevSibling(const wxTreeItemId& item);


@@ -1192,7 +1262,7 @@ public:
                                 size_t before,
                                 const wxString& text,
                                 int image = -1, int selectedImage = -1,
                                 size_t before,
                                 const wxString& text,
                                 int image = -1, int selectedImage = -1,

-                                wxTreeItemData *data = NULL);
+                                wxPyTreeItemData *data = NULL);

     wxTreeItemId AppendItem(const wxTreeItemId& parent,
                             const wxString& text,
                             int image = -1, int selectedImage = -1,
     wxTreeItemId AppendItem(const wxTreeItemId& parent,
                             const wxString& text,
                             int image = -1, int selectedImage = -1,


@@ -1279,6 +1349,125 @@ public:
 
 //----------------------------------------------------------------------
 
 
 //----------------------------------------------------------------------
 

+
+enum {
+    wxDIRCTRL_DIR_ONLY,
+    wxDIRCTRL_SELECT_FIRST,
+    wxDIRCTRL_SHOW_FILTERS,
+    wxDIRCTRL_3D_INTERNAL,
+    wxDIRCTRL_EDIT_LABELS,
+
+    wxID_TREECTRL,
+    wxID_FILTERLISTCTRL,
+};
+
+
+class wxDirItemData : public wxObject // wxTreeItemData
+{
+public:
+  wxDirItemData(const wxString& path, const wxString& name, bool isDir);
+//  ~wxDirItemDataEx();
+  void SetNewDirName( wxString path );
+  wxString m_path, m_name;
+  bool m_isHidden;
+  bool m_isExpanded;
+  bool m_isDir;
+};
+
+
+class wxGenericDirCtrl: public wxControl
+{
+public:
+    wxGenericDirCtrl(wxWindow *parent, const wxWindowID id = -1,
+                     const wxString& dir = wxPyDirDialogDefaultFolderStr,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
+                     const wxString& filter = wxPyEmptyString,
+                     int defaultFilter = 0,
+                     const wxString& name = wxPy_TreeCtrlNameStr);
+    %name(wxPreGenericDirCtrl)wxGenericDirCtrl();
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreGenericDirCtrl:val._setOORInfo(val)"
+
+    bool Create(wxWindow *parent, const wxWindowID id = -1,
+                const wxString& dir = wxPyDirDialogDefaultFolderStr,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDIRCTRL_3D_INTERNAL|wxSUNKEN_BORDER,
+                const wxString& filter = wxPyEmptyString,
+                int defaultFilter = 0,
+                const wxString& name = wxPy_TreeCtrlNameStr);
+
+
+    // Try to expand as much of the given path as possible.
+    bool ExpandPath(const wxString& path);
+
+    // Accessors
+
+    inline wxString GetDefaultPath() const;
+    void SetDefaultPath(const wxString& path);
+
+    // Get dir or filename
+    wxString GetPath() const ;
+
+    // Get selected filename path only (else empty string).
+    // I.e. don't count a directory as a selection
+    wxString GetFilePath() const ;
+    void SetPath(const wxString& path) ;
+
+    void ShowHidden( bool show );
+    bool GetShowHidden();
+
+    wxString GetFilter() const;
+    void SetFilter(const wxString& filter);
+
+    int GetFilterIndex() const;
+    void SetFilterIndex(int n) ;
+
+    wxTreeItemId GetRootId();
+
+    wxTreeCtrl* GetTreeCtrl() const;
+    wxDirFilterListCtrl* GetFilterListCtrl() const;
+
+//  //// Helpers
+//      void SetupSections();
+//      // Parse the filter into an array of filters and an array of descriptions
+//      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
+//      wxTreeItemId FindChild(wxTreeItemId parentId, const wxString& path, bool& done);
+};
+
+
+class wxDirFilterListCtrl: public wxChoice
+{
+public:
+    wxDirFilterListCtrl(wxGenericDirCtrl* parent, const wxWindowID id = -1,
+                        const wxPoint& pos = wxDefaultPosition,
+                        const wxSize& size = wxDefaultSize,
+                        long style = 0);
+    %name(wxPreDirFilterListCtrl)wxDirFilterListCtrl();
+
+    %pragma(python) addtomethod = "__init__:self._setOORInfo(self)"
+    %pragma(python) addtomethod = "wxPreDirFilterListCtrl:val._setOORInfo(val)"
+
+    bool Create(wxGenericDirCtrl* parent, const wxWindowID id = -1,
+              const wxPoint& pos = wxDefaultPosition,
+              const wxSize& size = wxDefaultSize,
+              long style = 0);
+
+//// Operations
+    void FillFilterList(const wxString& filter, int defaultFilter);
+};
+
+
+//----------------------------------------------------------------------
+//----------------------------------------------------------------------
+

 %init %{
     // Map renamed classes back to their common name for OOR
     wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");
 %init %{
     // Map renamed classes back to their common name for OOR
     wxPyPtrTypeMap_Add("wxTreeItemData", "wxPyTreeItemData");