Docstring update

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

diff --git a/wxPython/src/_treectrl.i b/wxPython/src/_treectrl.i
index 253b6303ff92b3b1c9e45e1bc10b0ab83dd81a2a..841df1aa779cb735da5bd6ae3b88783c72c83d33 100644 (file)
--- a/wxPython/src/_treectrl.i
+++ b/wxPython/src/_treectrl.i
@@ -96,8 +96,8 @@ public:
     bool IsOk() const;
 
     %extend {
     bool IsOk() const;
 
     %extend {

-        bool __eq__(const wxTreeItemId* other) { return other ? (*self == *other) : False; }
-        bool __ne__(const wxTreeItemId* other) { return other ? (*self != *other) : True;  }
+        bool __eq__(const wxTreeItemId* other) { return other ? (*self == *other) : false; }
+        bool __ne__(const wxTreeItemId* other) { return other ? (*self != *other) : true;  }

     }
 
     void*  m_pItem;
     }
 
     void*  m_pItem;


@@ -117,16 +117,19 @@ public:
 // Python code should rarely be neccessary.  Just use the GetItemPyData and
 // SetItemPyData tree methods instead of the GetItemData and SetItemData
 // methods.
 // Python code should rarely be neccessary.  Just use the GetItemPyData and
 // SetItemPyData tree methods instead of the GetItemData and SetItemData
 // methods.

-%name(TreeItemData) class wxPyTreeItemData {
+%rename(TreeItemData) wxPyTreeItemData;
+class wxPyTreeItemData {

 public:
     wxPyTreeItemData(PyObject* obj = NULL);
 public:
     wxPyTreeItemData(PyObject* obj = NULL);

-
+    ~wxPyTreeItemData();
+    

     PyObject* GetData();
     void      SetData(PyObject* obj);
 
     const wxTreeItemId& GetId();
     void                SetId(const wxTreeItemId& id);
 
     PyObject* GetData();
     void      SetData(PyObject* obj);
 
     const wxTreeItemId& GetId();
     void                SetId(const wxTreeItemId& id);
 

+    %pythonAppend Destroy "args[0].thisown = 0"

     %extend { void Destroy() { delete self; } }
 };
 
     %extend { void Destroy() { delete self; } }
 };
 


@@ -143,7 +146,8 @@ public:
     wxTreeItemAttr(const wxColour& colText = wxNullColour,
                    const wxColour& colBack = wxNullColour,
                    const wxFont& font = wxNullFont);
     wxTreeItemAttr(const wxColour& colText = wxNullColour,
                    const wxColour& colBack = wxNullColour,
                    const wxFont& font = wxNullFont);

-
+    ~wxTreeItemAttr();
+    

     // setters
     void SetTextColour(const wxColour& colText);
     void SetBackgroundColour(const wxColour& colBack);
     // setters
     void SetTextColour(const wxColour& colText);
     void SetBackgroundColour(const wxColour& colBack);


@@ -158,6 +162,7 @@ public:
     wxColour GetBackgroundColour();
     wxFont GetFont();
 
     wxColour GetBackgroundColour();
     wxFont GetFont();
 

+    %pythonAppend Destroy "args[0].thisown = 0"

     %extend { void Destroy() { delete self; } }
 };
 
     %extend { void Destroy() { delete self; } }
 };
 


@@ -188,10 +193,9 @@ public:
 %constant wxEventType wxEVT_COMMAND_TREE_END_DRAG;
 %constant wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
 %constant wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;
 %constant wxEventType wxEVT_COMMAND_TREE_END_DRAG;
 %constant wxEventType wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK;
 %constant wxEventType wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP;

-
+%constant wxEventType wxEVT_COMMAND_TREE_ITEM_MENU;

 
 %pythoncode {
 
 %pythoncode {

-

 EVT_TREE_BEGIN_DRAG        = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG       , 1)
 EVT_TREE_BEGIN_RDRAG       = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG      , 1)
 EVT_TREE_BEGIN_LABEL_EDIT  = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1)
 EVT_TREE_BEGIN_DRAG        = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_DRAG       , 1)
 EVT_TREE_BEGIN_RDRAG       = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_RDRAG      , 1)
 EVT_TREE_BEGIN_LABEL_EDIT  = wx.PyEventBinder(wxEVT_COMMAND_TREE_BEGIN_LABEL_EDIT , 1)


@@ -212,6 +216,7 @@ EVT_TREE_ITEM_MIDDLE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MIDDLE_CLI
 EVT_TREE_END_DRAG          = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG         , 1)
 EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
 EVT_TREE_ITEM_GETTOOLTIP   = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP,   1)
 EVT_TREE_END_DRAG          = wx.PyEventBinder(wxEVT_COMMAND_TREE_END_DRAG         , 1)
 EVT_TREE_STATE_IMAGE_CLICK = wx.PyEventBinder(wxEVT_COMMAND_TREE_STATE_IMAGE_CLICK, 1)
 EVT_TREE_ITEM_GETTOOLTIP   = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_GETTOOLTIP,   1)

+EVT_TREE_ITEM_MENU        = wx.PyEventBinder(wxEVT_COMMAND_TREE_ITEM_MENU,         1)

 }
 
 
 }
 
 


@@ -254,6 +259,7 @@ public:
 
         // Set the tooltip for the item (for EVT_TREE_ITEM_GETTOOLTIP events)
     void SetToolTip(const wxString& toolTip);
 
         // Set the tooltip for the item (for EVT_TREE_ITEM_GETTOOLTIP events)
     void SetToolTip(const wxString& toolTip);

+    wxString GetToolTip();

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------


@@ -261,7 +267,7 @@ public:
 
 %{ // C++ version of Python aware wxTreeCtrl
 class wxPyTreeCtrl : public wxTreeCtrl {
 
 %{ // C++ version of Python aware wxTreeCtrl
 class wxPyTreeCtrl : public wxTreeCtrl {

-    DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl);
+    DECLARE_ABSTRACT_CLASS(wxPyTreeCtrl)

 public:
     wxPyTreeCtrl() : wxTreeCtrl() {}
     wxPyTreeCtrl(wxWindow *parent, wxWindowID id,
 public:
     wxPyTreeCtrl() : wxTreeCtrl() {}
     wxPyTreeCtrl(wxWindow *parent, wxWindowID id,


@@ -286,15 +292,15 @@ public:
                        const wxTreeItemId& item2) {
         int rval = 0;
         bool found;
                        const wxTreeItemId& item2) {
         int rval = 0;
         bool found;

-        wxPyBeginBlockThreads();
+        wxPyBlock_t blocked = wxPyBeginBlockThreads();

         if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {
         if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {

-            PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), False);
-            PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), False);
+            PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), false);
+            PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), false);

             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
             Py_DECREF(o1);
             Py_DECREF(o2);
         }
             rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
             Py_DECREF(o1);
             Py_DECREF(o2);
         }

-        wxPyEndBlockThreads();
+        wxPyEndBlockThreads(blocked);

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


@@ -309,10 +315,14 @@ IMPLEMENT_ABSTRACT_CLASS(wxPyTreeCtrl, wxTreeCtrl);
 
 
  
 
 
  

-%name(TreeCtrl)class wxPyTreeCtrl : public wxControl {
+MustHaveApp(wxPyTreeCtrl);
+
+%rename(TreeCtrl) wxPyTreeCtrl;
+class wxPyTreeCtrl : public wxControl {

 public:
     %pythonAppend wxPyTreeCtrl         "self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl)"
     %pythonAppend wxPyTreeCtrl()       ""
 public:
     %pythonAppend wxPyTreeCtrl         "self._setOORInfo(self);self._setCallbackInfo(self, TreeCtrl)"
     %pythonAppend wxPyTreeCtrl()       ""

+    %typemap(out) wxPyTreeCtrl*;    // turn off this typemap

    
     wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
                  const wxPoint& pos = wxDefaultPosition,
    
     wxPyTreeCtrl(wxWindow *parent, wxWindowID id = -1,
                  const wxPoint& pos = wxDefaultPosition,


@@ -320,7 +330,10 @@ public:
                  long style = wxTR_DEFAULT_STYLE,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxString& name = wxPyTreeCtrlNameStr);
                  long style = wxTR_DEFAULT_STYLE,
                  const wxValidator& validator = wxDefaultValidator,
                  const wxString& name = wxPyTreeCtrlNameStr);

-    %name(PreTreeCtrl)wxPyTreeCtrl();
+    %RenameCtor(PreTreeCtrl, wxPyTreeCtrl());
+
+    // Turn it back on again
+    %typemap(out) wxPyTreeCtrl* { $result = wxPyMake_wxObject($1, $owner); }

 
     bool Create(wxWindow *parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,
 
     bool Create(wxWindow *parent, wxWindowID id = -1,
                 const wxPoint& pos = wxDefaultPosition,


@@ -363,10 +376,10 @@ public:
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);
 
     void SetImageList(wxImageList *imageList);
     void SetStateImageList(wxImageList *imageList);
 

-    %apply SWIGTYPE *DISOWN { wxImageList *imageList };
+    %disownarg( wxImageList *imageList );

     void AssignImageList(wxImageList *imageList);
     void AssignStateImageList(wxImageList *imageList);
     void AssignImageList(wxImageList *imageList);
     void AssignStateImageList(wxImageList *imageList);

-    %clear wxImageList *imageList;
+    %cleardisown( wxImageList *imageList );

     
 
     // retrieve items label
     
 
     // retrieve items label


@@ -421,10 +434,12 @@ public:
 
     %extend {
         // associate a wxPyTreeItemData with the tree item
 
     %extend {
         // associate a wxPyTreeItemData with the tree item

+        %disownarg( wxPyTreeItemData* data );

         void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
             data->SetId(item); // set the id
             self->SetItemData(item, data);
         }
         void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
             data->SetId(item); // set the id
             self->SetItemData(item, data);
         }

+        %cleardisown( wxPyTreeItemData* data );

 
         // associate a Python object with the tree item
         void SetItemPyData(const wxTreeItemId& item, PyObject* obj) {
 
         // associate a Python object with the tree item
         void SetItemPyData(const wxTreeItemId& item, PyObject* obj) {


@@ -444,15 +459,13 @@ public:
     // allow the user to expand the items which don't have any children now
     // - but instead add them only when needed, thus minimizing memory
     // usage and loading time.
     // allow the user to expand the items which don't have any children now
     // - but instead add them only when needed, thus minimizing memory
     // usage and loading time.

-    void SetItemHasChildren(const wxTreeItemId& item, bool has = True);
+    void SetItemHasChildren(const wxTreeItemId& item, bool has = true);

 
     // the item will be shown in bold
 
     // the item will be shown in bold

-    void SetItemBold(const wxTreeItemId& item, bool bold = True);
+    void SetItemBold(const wxTreeItemId& item, bool bold = true);

 
 

-#ifdef __WXMSW__

     // the item will be shown with a drop highlight
     // the item will be shown with a drop highlight

-    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = True);
-#endif
+    void SetItemDropHighlight(const wxTreeItemId& item, bool highlight = true);

     
     // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);
     
     // set the items text colour
     void SetItemTextColour(const wxTreeItemId& item, const wxColour& col);


@@ -483,7 +496,7 @@ public:
     // if 'recursively' is False, only immediate children count, otherwise
     // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,
     // if 'recursively' is False, only immediate children count, otherwise
     // the returned number is the number of all items in this branch
     size_t GetChildrenCount(const wxTreeItemId& item,

-                            bool recursively = True) /*const*/;
+                            bool recursively = true) /*const*/;

 
 
 
 
 
 


@@ -501,17 +514,18 @@ public:
         // NB: this operation is expensive and can take a long time for a
         //     control with a lot of items (~ O(number of items)).
         PyObject* GetSelections() {
         // NB: this operation is expensive and can take a long time for a
         //     control with a lot of items (~ O(number of items)).
         PyObject* GetSelections() {

-            wxPyBeginBlockThreads();
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();

             PyObject*           rval = PyList_New(0);
             wxArrayTreeItemIds  array;
             size_t              num, x;
             num = self->GetSelections(array);
             for (x=0; x < num; x++) {
                 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));
             PyObject*           rval = PyList_New(0);
             wxArrayTreeItemIds  array;
             size_t              num, x;
             num = self->GetSelections(array);
             for (x=0; x < num; x++) {
                 wxTreeItemId *tii = new wxTreeItemId(array.Item(x));

-                PyObject* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), True);
+                PyObject* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), true);

                 PyList_Append(rval, item);
                 PyList_Append(rval, item);

+                Py_DECREF(item);

             }
             }

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return rval;
         }
     }
             return rval;
         }
     }


@@ -521,6 +535,8 @@ public:
     wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 
 
     wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
 
 

+    // NOTE: These are a copy of the same methods in gizmos.i, be sure to
+    // update both at the same time.  (Or find a good way to refactor!)

     %extend {
         // Get the first child of this item.  Returns a wxTreeItemId and an
         // opaque "cookie" value that should be passed to GetNextChild in
     %extend {
         // Get the first child of this item.  Returns a wxTreeItemId and an
         // opaque "cookie" value that should be passed to GetNextChild in


@@ -528,11 +544,11 @@ public:
         PyObject* GetFirstChild(const wxTreeItemId& item) {
             void* cookie = 0;
             wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));
         PyObject* GetFirstChild(const wxTreeItemId& item) {
             void* cookie = 0;
             wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));

-            wxPyBeginBlockThreads();
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyObject* tup = PyTuple_New(2);

-            PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
+            PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));

             PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
             PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
 
             return tup;
         }
 


@@ -543,11 +559,11 @@ public:
         // passed to GetNextChild in order to continue the search.
         PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
             wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));
         // passed to GetNextChild in order to continue the search.
         PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
             wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));

-            wxPyBeginBlockThreads();
+            wxPyBlock_t blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyObject* tup = PyTuple_New(2);

-            PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), True));
+            PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));

             PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
             PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }            
     }
             return tup;
         }            
     }


@@ -572,6 +588,7 @@ public:
     wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 
     
     wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
 
     

+    %disownarg( wxPyTreeItemData* data );

     
     // add the root node to the tree
     wxTreeItemId AddRoot(const wxString& text,
     
     // add the root node to the tree
     wxTreeItemId AddRoot(const wxString& text,


@@ -592,12 +609,12 @@ public:
                             wxPyTreeItemData *data = NULL);
 
     // insert a new item before the one with the given index
                             wxPyTreeItemData *data = NULL);
 
     // insert a new item before the one with the given index

-    %name(InsertItemBefore)
-    wxTreeItemId InsertItem(const wxTreeItemId& parent,
+    %Rename(InsertItemBefore, 
+    wxTreeItemId, InsertItem(const wxTreeItemId& parent,

                             size_t index,
                             const wxString& text,
                             int image = -1, int selectedImage = -1,
                             size_t index,
                             const wxString& text,
                             int image = -1, int selectedImage = -1,

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

 
         // insert a new item in as the last child of the parent
     wxTreeItemId AppendItem(const wxTreeItemId& parent,
 
         // insert a new item in as the last child of the parent
     wxTreeItemId AppendItem(const wxTreeItemId& parent,


@@ -606,7 +623,8 @@ public:
                             wxPyTreeItemData *data = NULL);
 
 
                             wxPyTreeItemData *data = NULL);
 
 

-
+    %cleardisown( wxPyTreeItemData* data );
+    

     // delete this item and associated data if any
     void Delete(const wxTreeItemId& item);
 
     // delete this item and associated data if any
     void Delete(const wxTreeItemId& item);
 


@@ -642,7 +660,7 @@ public:
     void UnselectAll();
 
     // select this item
     void UnselectAll();
 
     // select this item

-    void SelectItem(const wxTreeItemId& item, bool select = True);
+    void SelectItem(const wxTreeItemId& item, bool select = true);

 
     // toggle the item selection
     void ToggleItemSelection(const wxTreeItemId& item);
 
     // toggle the item selection
     void ToggleItemSelection(const wxTreeItemId& item);


@@ -669,7 +687,7 @@ public:
 
 #ifdef __WXMSW__
     // end editing and accept or discard the changes to item label
 
 #ifdef __WXMSW__
     // end editing and accept or discard the changes to item label

-    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = False);
+    void EndEditLabel(const wxTreeItemId& item, bool discardChanges = false);

 #endif
 
 
 #endif
 
 


@@ -685,21 +703,21 @@ public:
     DocDeclAStr(
         wxTreeItemId, HitTest(const wxPoint& point, int& OUTPUT),
         "HitTest(Point point) -> (item, where)",
     DocDeclAStr(
         wxTreeItemId, HitTest(const wxPoint& point, int& OUTPUT),
         "HitTest(Point point) -> (item, where)",

-        "Determine which item (if any) belongs the given point.  The\n"
-        "coordinates specified are relative to the client area of tree ctrl\n"
-        "and the where return value is set to a bitmask of wxTREE_HITTEST_xxx\n"
-        "constants.\n");
+        "Determine which item (if any) belongs the given point.  The coordinates
+specified are relative to the client area of tree ctrl and the where return
+value is set to a bitmask of wxTREE_HITTEST_xxx constants.
+", "");

     
 
     %extend {
         // get the bounding rectangle of the item (or of its label only)
     
 
     %extend {
         // get the bounding rectangle of the item (or of its label only)

-        PyObject* GetBoundingRect(const wxTreeItemId& item,  bool textOnly = False) {
+        PyObject* GetBoundingRect(const wxTreeItemId& item,  bool textOnly = false) {

              wxRect rect;
             if (self->GetBoundingRect(item, rect, textOnly)) {
              wxRect rect;
             if (self->GetBoundingRect(item, rect, textOnly)) {

-                wxPyBeginBlockThreads();
+                wxPyBlock_t blocked = wxPyBeginBlockThreads();

                 wxRect* r = new wxRect(rect);
                 wxRect* r = new wxRect(rect);

-                PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), True);
-                wxPyEndBlockThreads();
+                PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), true);
+                wxPyEndBlockThreads(blocked);

                 return val;
             }
             else
                 return val;
             }
             else


@@ -707,7 +725,14 @@ public:
         }
     }
 
         }
     }
 

+#ifdef __WXMSW__
+    // set/get the item state.image (state == -1 means cycle to the next one)
+    void SetState(const wxTreeItemId& node, int state);
+    int GetState(const wxTreeItemId& node);
+#endif

 
 

+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 };
 
 
 };