Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the C++ code for wx.gizmos.TreeListCtrl from the wxCode

Browse Source 
project.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@41181 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robin Dunn
2006-09-12 21:05:20 +00:00
parent a4314b7e48
commit 33328cd882
7 changed files with 3180 additions and 3490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

689
wxPython/contrib/gizmos/_treelist.i Normal file
View File

@@ -0,0 +1,689 @@
/////////////////////////////////////////////////////////////////////////////
// Name: _treelist.i
// Purpose: wxTreeListCtrl and helpers
//
// Author: Robin Dunn
//
// Created: 12-Sept-2006
// RCS-ID: $Id$
// Copyright: (c) 2006 by Total Control Software
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
// Not a %module
//---------------------------------------------------------------------------
%{
#include "wx/treelistctrl.h"
#include "wx/wxPython/pytree.h"
%}
//---------------------------------------------------------------------------
%newgroup
MAKE_CONST_WXSTRING2(TreeListCtrlNameStr, wxT("treelistctrl"));
//----------------------------------------------------------------------------
// wxTreeListCtrl - the multicolumn tree control
//----------------------------------------------------------------------------
enum {
DEFAULT_COL_WIDTH = 100
};
// modes for navigation
enum {
wxTL_MODE_NAV_FULLTREE,
wxTL_MODE_NAV_EXPANDED,
wxTL_MODE_NAV_VISIBLE,
wxTL_MODE_NAV_LEVEL
};
// modes for FindItem
enum {
wxTL_MODE_FIND_EXACT,
wxTL_MODE_FIND_PARTIAL,
wxTL_MODE_FIND_NOCASE
};
// additional flag for HitTest
enum {
wxTREE_HITTEST_ONITEMCOLUMN
};
%pythoncode { wx.TREE_HITTEST_ONITEMCOLUMN = TREE_HITTEST_ONITEMCOLUMN }
// additional style flags
enum {
wxTR_COLUMN_LINES, // put border around items
wxTR_VIRTUAL // The application provides items text on demand.
};
%pythoncode {
wx.TR_COLUMN_LINES = TR_COLUMN_LINES
wxTR_VIRTUAL = TR_VIRTUAL
}
%pythoncode {
%#// Compatibility aliases for old names/values
TL_ALIGN_LEFT = wx.ALIGN_LEFT
TL_ALIGN_RIGHT = wx.ALIGN_RIGHT
TL_ALIGN_CENTER = wx.ALIGN_CENTER
TL_SEARCH_VISIBLE = TL_MODE_NAV_VISIBLE
TL_SEARCH_LEVEL = TL_MODE_NAV_LEVEL
TL_SEARCH_FULL = TL_MODE_FIND_EXACT
TL_SEARCH_PARTIAL = TL_MODE_FIND_PARTIAL
TL_SEARCH_NOCASE = TL_MODE_FIND_NOCASE
TR_DONT_ADJUST_MAC = 0
wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC
}
class wxTreeListColumnInfo: public wxObject {
public:
wxTreeListColumnInfo(const wxString& text = wxPyEmptyString,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
bool shown = true,
bool edit = false);
~wxTreeListColumnInfo();
int GetAlignment() const;
wxString GetText() const;
int GetImage() const;
int GetSelectedImage() const;
size_t GetWidth() const;
bool IsEditable() const { return m_edit; }
bool IsShown() const { return m_shown; }
// TODO: These all actually return wxTreeListColumnInfo&, any problem with doing it for Python too?
void SetAlignment(int alignment);
void SetText(const wxString& text);
void SetImage(int image);
void SetSelectedImage(int image);
void SetWidth(size_t with);
void SetEditable (bool edit);
void SetShown(bool shown);
};
%{ // C++ version of Python aware control
class wxPyTreeListCtrl : public wxTreeListCtrl {
DECLARE_ABSTRACT_CLASS(wxPyTreeListCtrl);
public:
wxPyTreeListCtrl() : wxTreeListCtrl() {}
wxPyTreeListCtrl(wxWindow *parent, wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxValidator &validator,
const wxString& name) :
wxTreeListCtrl(parent, id, pos, size, style, validator, name) {}
virtual int OnCompareItems(const wxTreeItemId& item1,
const wxTreeItemId& item2) {
int rval = 0;
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {
PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), 0);
PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), 0);
rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
Py_DECREF(o1);
Py_DECREF(o2);
}
wxPyEndBlockThreads(blocked);
if (! found)
rval = wxTreeListCtrl::OnCompareItems(item1, item2);
return rval;
}
virtual wxString OnGetItemText( wxTreeItemData* item, long column ) const {
wxString rval;
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnGetItemText"))) {
PyObject* ro;
PyObject* itemo = wxPyConstructObject((void*)&item, wxT("wxTreeItemId"), 0);
ro = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("(Oi)", itemo, column));
Py_DECREF(itemo);
if (ro) {
rval = Py2wxString(ro);
Py_DECREF(ro);
}
}
wxPyEndBlockThreads(blocked);
if (! found)
rval = wxTreeListCtrl::OnGetItemText(item, column);
return rval;
}
PYPRIVATE;
};
IMPLEMENT_ABSTRACT_CLASS(wxPyTreeListCtrl, wxTreeListCtrl)
%}
MustHaveApp(wxPyTreeListCtrl);
%rename(TreeListCtrl) wxPyTreeListCtrl;
class wxPyTreeListCtrl : public wxControl
{
public:
%pythonAppend wxPyTreeListCtrl "self._setOORInfo(self);self._setCallbackInfo(self, TreeListCtrl)"
%pythonAppend wxPyTreeListCtrl() ""
wxPyTreeListCtrl(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxPyTreeListCtrlNameStr );
%RenameCtor(PreTreeListCtrl, wxPyTreeListCtrl());
bool Create(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxPyTreeListCtrlNameStr );
void _setCallbackInfo(PyObject* self, PyObject* _class);
// get the total number of items in the control
size_t GetCount() const;
// indent is the number of pixels the children are indented relative to
// the parents position. SetIndent() also redraws the control
// immediately.
unsigned int GetIndent() const;
void SetIndent(unsigned int indent);
// line spacing is the space above and below the text on each line
unsigned int GetLineSpacing() const;
void SetLineSpacing(unsigned int spacing);
// image list: these functions allow to associate an image list with
// the control and retrieve it. Note that when assigned with
// SetImageList, the control does _not_ delete
// the associated image list when it's deleted in order to allow image
// lists to be shared between different controls. If you use
// AssignImageList, the control _does_ delete the image list.
//
// The normal image list is for the icons which correspond to the
// normal tree item state (whether it is selected or not).
// Additionally, the application might choose to show a state icon
// which corresponds to an app-defined item state (for example,
// checked/unchecked) which are taken from the state image list.
wxImageList *GetImageList() const;
wxImageList *GetStateImageList() const;
wxImageList *GetButtonsImageList() const;
void SetImageList(wxImageList *imageList);
void SetStateImageList(wxImageList *imageList);
void SetButtonsImageList(wxImageList *imageList);
%disownarg( wxImageList *imageList );
void AssignImageList(wxImageList *imageList);
void AssignStateImageList(wxImageList *imageList);
void AssignButtonsImageList(wxImageList *imageList);
%cleardisown( wxImageList *imageList );
// adds a column
void AddColumn (const wxString& text,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
bool shown = true,
bool edit = false);
%Rename(AddColumnInfo, void, AddColumn(const wxTreeListColumnInfo& col));
// inserts a column before the given one
void InsertColumn (int before,
const wxString& text,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
bool shown = true,
bool edit = false);
%Rename(InsertColumnInfo, void, InsertColumn(size_t before, const wxTreeListColumnInfo& col));
// deletes the given column - does not delete the corresponding column
// of each item
void RemoveColumn(size_t column);
// returns the number of columns in the ctrl
size_t GetColumnCount() const;
// tells which column is the "main" one, i.e. the "threaded" one
void SetMainColumn(size_t column);
size_t GetMainColumn() const;
void SetColumn (int column, const wxTreeListColumnInfo& colInfo);
wxTreeListColumnInfo& GetColumn (int column);
void SetColumnText (int column, const wxString& text);
wxString GetColumnText (int column) const;
void SetColumnWidth (int column, int width);
int GetColumnWidth (int column) const;
void SetColumnAlignment (int column, int flag);
int GetColumnAlignment (int column) const;
void SetColumnImage (int column, int image);
int GetColumnImage (int column) const;
void SetColumnShown (int column, bool shown = true);
bool IsColumnShown (int column) const;
%pythoncode { ShowColumn = SetColumnShown }
void SetColumnEditable (int column, bool edit = true);
bool IsColumnEditable (int column) const;
%extend {
// retrieves item's label of the given column (main column by default)
wxString GetItemText(const wxTreeItemId& item, int column = -1) {
if (column < 0) column = self->GetMainColumn();
return self->GetItemText(item, column);
}
// get one of the images associated with the item (normal by default)
int GetItemImage(const wxTreeItemId& item, int column = -1,
wxTreeItemIcon which = wxTreeItemIcon_Normal) {
if (column < 0) column = self->GetMainColumn();
return self->GetItemImage(item, column, which);
}
// set item's label (main column by default)
void SetItemText(const wxTreeItemId& item, const wxString& text, int column = -1) {
if (column < 0) column = self->GetMainColumn();
self->SetItemText(item, column, text);
}
// set one of the images associated with the item (normal by default)
// the which parameter is ignored for all columns but the main one
void SetItemImage(const wxTreeItemId& item, int image, int column = -1,
wxTreeItemIcon which = wxTreeItemIcon_Normal) {
if (column < 0) column = self->GetMainColumn();
self->SetItemImage(item, column, image, which);
}
// [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
// if needed.
wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData();
data->SetId(item); // set the id
self->SetItemData(item, data);
}
return data;
}
%disownarg( wxPyTreeItemData* data );
void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
data->SetId(item); // set the id
self->SetItemData(item, data);
}
%cleardisown(wxPyTreeItemData* data );
// [Get|Set]ItemPyData are short-cuts. Also made somewhat crash-proof by
// automatically creating data classes.
PyObject* GetItemPyData(const wxTreeItemId& item) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData();
data->SetId(item); // set the id
self->SetItemData(item, data);
}
return data->GetData();
}
void SetItemPyData(const wxTreeItemId& item, PyObject* obj) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData(obj);
data->SetId(item); // set the id
self->SetItemData(item, data);
} else
data->SetData(obj);
}
}
%pythoncode { GetPyData = GetItemPyData }
%pythoncode { SetPyData = SetItemPyData }
bool GetItemBold(const wxTreeItemId& item) const;
wxColour GetItemTextColour(const wxTreeItemId& item) const;
wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
wxFont GetItemFont(const wxTreeItemId& item) const;
// force appearance of [+] button near the item. This is useful to
// 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);
// the item will be shown in bold
void SetItemBold(const wxTreeItemId& item, bool bold = true);
// set the item's text colour
void SetItemTextColour(const wxTreeItemId& item, const wxColour& colour);
// set the item's background colour
void SetItemBackgroundColour(const wxTreeItemId& item,
const wxColour& colour);
// set the item's font (should be of the same height for all items)
void SetItemFont(const wxTreeItemId& item, const wxFont& font);
// is the item visible (it might be outside the view or not expanded)?
bool IsVisible(const wxTreeItemId& item) const;
// does the item has any children?
bool HasChildren(const wxTreeItemId& item) const;
%pythoncode { ItemHasChildren = HasChildren }
// is the item expanded (only makes sense if HasChildren())?
bool IsExpanded(const wxTreeItemId& item) const;
// is this item currently selected (the same as has focus)?
bool IsSelected(const wxTreeItemId& item) const;
// is item text in bold font?
bool IsBold(const wxTreeItemId& item) const;
// 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);
// wxTreeItemId.IsOk() will return False if there is no such item
// get the root tree item
wxTreeItemId GetRootItem() const;
// get the item currently selected (may return NULL if no selection)
wxTreeItemId GetSelection() const;
// get the items currently selected, return the number of such item
//size_t GetSelections(wxArrayTreeItemIds&) const;
%extend {
PyObject* GetSelections() {
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* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), true);
PyList_Append(rval, item);
Py_DECREF(item);
}
wxPyEndBlockThreads(blocked);
return rval;
}
}
// get the parent of this item (may return NULL if root)
wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
// for this enumeration function you must pass in a "cookie" parameter
// which is opaque for the application but is necessary for the library
// to make these functions reentrant (i.e. allow more than one
// enumeration on one and the same object simultaneously). Of course,
// the "cookie" passed to GetFirstChild() and GetNextChild() should be
// the same!
// NOTE: These are a copy of the same methods in _treectrl.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
// order to continue the search.
PyObject* GetFirstChild(const wxTreeItemId& item) {
void* cookie = 0;
wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
// Get the next child of this item. The cookie parameter is the 2nd
// value returned from GetFirstChild or the previous GetNextChild.
// Returns a wxTreeItemId and an opaque "cookie" value that should be
// passed to GetNextChild in order to continue the search.
PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
PyObject* GetLastChild(const wxTreeItemId& item) {
void* cookie = 0;
wxTreeItemId* ritem = new wxTreeItemId(self->GetLastChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
PyObject* GetPrevChild(const wxTreeItemId& item, void* cookie) {
wxTreeItemId* ritem = new wxTreeItemId(self->GetPrevChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
}
// get the next sibling of this item
wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
// get the previous sibling
wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
// get item in the full tree (currently only for internal use)
wxTreeItemId GetNext(const wxTreeItemId& item) const;
wxTreeItemId GetPrev(const wxTreeItemId& item) const;
// get expanded item, see IsExpanded()
wxTreeItemId GetFirstExpandedItem() const;
wxTreeItemId GetNextExpanded(const wxTreeItemId& item) const;
wxTreeItemId GetPrevExpanded(const wxTreeItemId& item) const;
// get visible item, see IsVisible()
wxTreeItemId GetFirstVisibleItem(bool fullRow = false) const;
wxTreeItemId GetNextVisible(const wxTreeItemId& item, bool fullRow = false) const;
wxTreeItemId GetPrevVisible(const wxTreeItemId& item, bool fullRow = false) const;
%disownarg( wxPyTreeItemData* data );
// add the root node to the tree
wxTreeItemId AddRoot(const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item in as the first child of the parent
wxTreeItemId PrependItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item after a given one
wxTreeItemId InsertItem(const wxTreeItemId& parent,
const wxTreeItemId& idPrevious,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item before the one with the given index
%Rename(InsertItemBefore,
wxTreeItemId, InsertItem(const wxTreeItemId& parent,
size_t index,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL));
// insert a new item in as the last child of the parent
wxTreeItemId AppendItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
%cleardisown(wxPyTreeItemData* data );
// delete this item and associated data if any
void Delete(const wxTreeItemId& item);
// delete all children (but don't delete the item itself)
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteChildren(const wxTreeItemId& item);
// delete all items from the tree
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteRoot();
%pythoncode { DeleteAllItems = DeleteRoot }
// expand this item
void Expand(const wxTreeItemId& item);
// expand this item and all subitems recursively
void ExpandAll(const wxTreeItemId& item);
// collapse the item without removing its children
void Collapse(const wxTreeItemId& item);
// collapse the item and remove all children
void CollapseAndReset(const wxTreeItemId& item);
// toggles the current state
void Toggle(const wxTreeItemId& item);
// remove the selection from currently selected item (if any)
void Unselect();
void UnselectAll();
// select this item
void SelectItem(const wxTreeItemId& item,
const wxTreeItemId& last = (wxTreeItemId*)NULL,
bool unselect_others=true);
void SelectAll();
// make sure this item is visible (expanding the parent item and/or
// scrolling to this item if necessary)
void EnsureVisible(const wxTreeItemId& item);
// scroll to this item (but don't expand its parent)
void ScrollTo(const wxTreeItemId& item);
// Returns wxTreeItemId, flags, and column
wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT, int& OUTPUT);
%extend {
// get the bounding rectangle of the item (or of its label only)
PyObject* GetBoundingRect(const wxTreeItemId& item, bool textOnly = false) {
wxRect rect;
if (self->GetBoundingRect(item, rect, textOnly)) {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxRect* r = new wxRect(rect);
PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), 1);
wxPyEndBlockThreads(blocked);
return val;
}
else {
RETURN_NONE();
}
}
}
%extend {
// Start editing the item label: this (temporarily) replaces the item
// with a one line edit control. The item will be selected if it hadn't
// been before.
void EditLabel(const wxTreeItemId& item, int column = -1) {
if (column < 0) column = self->GetMainColumn();
self->EditLabel(item, column);
}
}
%pythoncode { Edit = EditLabel }
// sort the children of this item using OnCompareItems
void SortChildren(const wxTreeItemId& item);
// searching
wxTreeItemId FindItem (const wxTreeItemId& item, const wxString& str, int flags = 0);
// drop over item
void SetDragItem (const wxTreeItemId& item = (wxTreeItemId*)NULL);
wxWindow* GetHeaderWindow() const;
wxScrolledWindow* GetMainWindow() const;
};
//----------------------------------------------------------------------
%init %{
wxPyPtrTypeMap_Add("wxTreeListCtrl", "wxPyTreeListCtrl");
%}
//----------------------------------------------------------------------

557
wxPython/contrib/gizmos/gizmos.i
View File

@@ -32,9 +32,6 @@
#include <wx/treectrl.h>
#include <wx/imaglist.h>
#include "wx/treelistctrl.h"
#include "wx/wxPython/pytree.h"
%}
//---------------------------------------------------------------------------
@@ -47,7 +44,6 @@
MAKE_CONST_WXSTRING2(DynamicSashNameStr, wxT("dynamicSashWindow"));
MAKE_CONST_WXSTRING2(EditableListBoxNameStr, wxT("editableListBox"));
MAKE_CONST_WXSTRING2(TreeListCtrlNameStr, wxT("treelistctrl"));
MAKE_CONST_WXSTRING(StaticPictureNameStr);
MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
@@ -417,553 +413,9 @@ public:
//----------------------------------------------------------------------------
// wxTreeListCtrl - the multicolumn tree control
//----------------------------------------------------------------------------
//----------------------------------------------------------------------
enum wxTreeListColumnAlign {
wxTL_ALIGN_LEFT,
wxTL_ALIGN_RIGHT,
wxTL_ALIGN_CENTER
};
enum {
wxTREE_HITTEST_ONITEMCOLUMN
};
enum {
// flags for FindItem
wxTL_SEARCH_VISIBLE,
wxTL_SEARCH_LEVEL,
wxTL_SEARCH_FULL,
wxTL_SEARCH_PARTIAL,
wxTL_SEARCH_NOCASE
};
enum {
// extra tree styles
wxTR_DONT_ADJUST_MAC
};
%pythoncode { wx.TR_DONT_ADJUST_MAC = TR_DONT_ADJUST_MAC }
class wxTreeListColumnInfo: public wxObject {
public:
wxTreeListColumnInfo(const wxString& text = wxPyEmptyString,
int image = -1,
size_t width = 100,
bool shown = true,
wxTreeListColumnAlign alignment = wxTL_ALIGN_LEFT);
~wxTreeListColumnInfo();
bool GetShown() const;
wxTreeListColumnAlign GetAlignment() const;
wxString GetText() const;
int GetImage() const;
int GetSelectedImage() const;
size_t GetWidth() const;
// TODO: These all actually return wxTreeListColumnInfo&, any problem with doing it for Python too?
void SetShown(bool shown);
void SetAlignment(wxTreeListColumnAlign alignment);
void SetText(const wxString& text);
void SetImage(int image);
void SetSelectedImage(int image);
void SetWidth(size_t with);
};
%{ // C++ version of Python aware control
class wxPyTreeListCtrl : public wxTreeListCtrl {
DECLARE_ABSTRACT_CLASS(wxPyTreeListCtrl);
public:
wxPyTreeListCtrl() : wxTreeListCtrl() {}
wxPyTreeListCtrl(wxWindow *parent, wxWindowID id,
const wxPoint& pos,
const wxSize& size,
long style,
const wxValidator &validator,
const wxString& name) :
wxTreeListCtrl(parent, id, pos, size, style, validator, name) {}
int OnCompareItems(const wxTreeItemId& item1,
const wxTreeItemId& item2) {
int rval = 0;
bool found;
wxPyBlock_t blocked = wxPyBeginBlockThreads();
if ((found = wxPyCBH_findCallback(m_myInst, "OnCompareItems"))) {
PyObject *o1 = wxPyConstructObject((void*)&item1, wxT("wxTreeItemId"), 0);
PyObject *o2 = wxPyConstructObject((void*)&item2, wxT("wxTreeItemId"), 0);
rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)",o1,o2));
Py_DECREF(o1);
Py_DECREF(o2);
}
wxPyEndBlockThreads(blocked);
if (! found)
rval = wxTreeListCtrl::OnCompareItems(item1, item2);
return rval;
}
PYPRIVATE;
};
IMPLEMENT_ABSTRACT_CLASS(wxPyTreeListCtrl, wxTreeListCtrl)
%}
MustHaveApp(wxPyTreeListCtrl);
%rename(TreeListCtrl) wxPyTreeListCtrl;
class wxPyTreeListCtrl : public wxControl
{
public:
%pythonAppend wxPyTreeListCtrl "self._setOORInfo(self);self._setCallbackInfo(self, TreeListCtrl)"
%pythonAppend wxPyTreeListCtrl() ""
wxPyTreeListCtrl(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxPyTreeListCtrlNameStr );
%RenameCtor(PreTreeListCtrl, wxPyTreeListCtrl());
bool Create(wxWindow *parent, wxWindowID id = -1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = wxTR_DEFAULT_STYLE,
const wxValidator &validator = wxDefaultValidator,
const wxString& name = wxPyTreeListCtrlNameStr );
void _setCallbackInfo(PyObject* self, PyObject* _class);
// get the total number of items in the control
size_t GetCount() const;
// indent is the number of pixels the children are indented relative to
// the parents position. SetIndent() also redraws the control
// immediately.
unsigned int GetIndent() const;
void SetIndent(unsigned int indent);
// line spacing is the space above and below the text on each line
unsigned int GetLineSpacing() const;
void SetLineSpacing(unsigned int spacing);
// image list: these functions allow to associate an image list with
// the control and retrieve it. Note that when assigned with
// SetImageList, the control does _not_ delete
// the associated image list when it's deleted in order to allow image
// lists to be shared between different controls. If you use
// AssignImageList, the control _does_ delete the image list.
//
// The normal image list is for the icons which correspond to the
// normal tree item state (whether it is selected or not).
// Additionally, the application might choose to show a state icon
// which corresponds to an app-defined item state (for example,
// checked/unchecked) which are taken from the state image list.
wxImageList *GetImageList() const;
wxImageList *GetStateImageList() const;
wxImageList *GetButtonsImageList() const;
void SetImageList(wxImageList *imageList);
void SetStateImageList(wxImageList *imageList);
void SetButtonsImageList(wxImageList *imageList);
%disownarg( wxImageList *imageList );
void AssignImageList(wxImageList *imageList);
void AssignStateImageList(wxImageList *imageList);
void AssignButtonsImageList(wxImageList *imageList);
%cleardisown( wxImageList *imageList );
// adds a column
void AddColumn(const wxString& text);
// void AddColumn(const wxString& text,
// size_t width,
// wxTreeListColumnAlign alignment = wxTL_ALIGN_LEFT);
%Rename(AddColumnInfo, void, AddColumn(const wxTreeListColumnInfo& col));
// inserts a column before the given one
void InsertColumn(size_t before, const wxString& text);
%Rename(InsertColumnInfo, void, InsertColumn(size_t before, const wxTreeListColumnInfo& col));
// deletes the given column - does not delete the corresponding column
// of each item
void RemoveColumn(size_t column);
// returns the number of columns in the ctrl
size_t GetColumnCount() const;
void SetColumnWidth(size_t column, size_t width);
int GetColumnWidth(size_t column) const;
// tells which column is the "main" one, i.e. the "threaded" one
void SetMainColumn(size_t column);
size_t GetMainColumn() const;
void SetColumnText(size_t column, const wxString& text);
wxString GetColumnText(size_t column) const;
void SetColumn(size_t column, const wxTreeListColumnInfo& info);
wxTreeListColumnInfo& GetColumn(size_t column);
// other column-related methods
void SetColumnAlignment(size_t column, wxTreeListColumnAlign align);
wxTreeListColumnAlign GetColumnAlignment(size_t column) const;
void SetColumnImage(size_t column, int image);
int GetColumnImage(size_t column) const;
void ShowColumn(size_t column, bool shown);
bool IsColumnShown(size_t column) const;
%extend {
// retrieves item's label of the given column (main column by default)
wxString GetItemText(const wxTreeItemId& item, int column = -1) {
if (column < 0) column = self->GetMainColumn();
return self->GetItemText(item, column);
}
// get one of the images associated with the item (normal by default)
int GetItemImage(const wxTreeItemId& item, int column = -1,
wxTreeItemIcon which = wxTreeItemIcon_Normal) {
if (column < 0) column = self->GetMainColumn();
return self->GetItemImage(item, column, which);
}
// set item's label (main column by default)
void SetItemText(const wxTreeItemId& item, const wxString& text, int column = -1) {
if (column < 0) column = self->GetMainColumn();
self->SetItemText(item, column, text);
}
// set one of the images associated with the item (normal by default)
// the which parameter is ignored for all columns but the main one
void SetItemImage(const wxTreeItemId& item, int image, int column = -1,
wxTreeItemIcon which = wxTreeItemIcon_Normal) {
if (column < 0) column = self->GetMainColumn();
self->SetItemImage(item, column, image, which);
}
// [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
// if needed.
wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData();
data->SetId(item); // set the id
self->SetItemData(item, data);
}
return data;
}
%disownarg( wxPyTreeItemData* data );
void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
data->SetId(item); // set the id
self->SetItemData(item, data);
}
%cleardisown(wxPyTreeItemData* data );
// [Get|Set]ItemPyData are short-cuts. Also made somewhat crash-proof by
// automatically creating data classes.
PyObject* GetItemPyData(const wxTreeItemId& item) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData();
data->SetId(item); // set the id
self->SetItemData(item, data);
}
return data->GetData();
}
void SetItemPyData(const wxTreeItemId& item, PyObject* obj) {
wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
if (data == NULL) {
data = new wxPyTreeItemData(obj);
data->SetId(item); // set the id
self->SetItemData(item, data);
} else
data->SetData(obj);
}
}
%pythoncode { GetPyData = GetItemPyData }
%pythoncode { SetPyData = SetItemPyData }
// force appearance of [+] button near the item. This is useful to
// 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);
// the item will be shown in bold
void SetItemBold(const wxTreeItemId& item, bool bold = true);
// set the item's text colour
void SetItemTextColour(const wxTreeItemId& item, const wxColour& colour);
// set the item's background colour
void SetItemBackgroundColour(const wxTreeItemId& item,
const wxColour& colour);
// set the item's font (should be of the same height for all items)
void SetItemFont(const wxTreeItemId& item, const wxFont& font);
bool GetItemBold(const wxTreeItemId& item) const;
wxColour GetItemTextColour(const wxTreeItemId& item) const;
wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
wxFont GetItemFont(const wxTreeItemId& item) const;
// is the item visible (it might be outside the view or not expanded)?
bool IsVisible(const wxTreeItemId& item) const;
// does the item has any children?
bool ItemHasChildren(const wxTreeItemId& item) const;
// is the item expanded (only makes sense if HasChildren())?
bool IsExpanded(const wxTreeItemId& item) const;
// is this item currently selected (the same as has focus)?
bool IsSelected(const wxTreeItemId& item) const;
// is item text in bold font?
bool IsBold(const wxTreeItemId& item) const;
// 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);
// wxTreeItemId.IsOk() will return False if there is no such item
// get the root tree item
wxTreeItemId GetRootItem() const;
// get the item currently selected (may return NULL if no selection)
wxTreeItemId GetSelection() const;
// get the items currently selected, return the number of such item
//size_t GetSelections(wxArrayTreeItemIds&) const;
%extend {
PyObject* GetSelections() {
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* item = wxPyConstructObject((void*)tii, wxT("wxTreeItemId"), true);
PyList_Append(rval, item);
Py_DECREF(item);
}
wxPyEndBlockThreads(blocked);
return rval;
}
}
// get the parent of this item (may return NULL if root)
wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
// for this enumeration function you must pass in a "cookie" parameter
// which is opaque for the application but is necessary for the library
// to make these functions reentrant (i.e. allow more than one
// enumeration on one and the same object simultaneously). Of course,
// the "cookie" passed to GetFirstChild() and GetNextChild() should be
// the same!
// NOTE: These are a copy of the same methods in _treectrl.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
// order to continue the search.
PyObject* GetFirstChild(const wxTreeItemId& item) {
void* cookie = 0;
wxTreeItemId* ritem = new wxTreeItemId(self->GetFirstChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
// Get the next child of this item. The cookie parameter is the 2nd
// value returned from GetFirstChild or the previous GetNextChild.
// Returns a wxTreeItemId and an opaque "cookie" value that should be
// passed to GetNextChild in order to continue the search.
PyObject* GetNextChild(const wxTreeItemId& item, void* cookie) {
wxTreeItemId* ritem = new wxTreeItemId(self->GetNextChild(item, cookie));
wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, wxPyConstructObject(ritem, wxT("wxTreeItemId"), true));
PyTuple_SET_ITEM(tup, 1, wxPyMakeSwigPtr(cookie, wxT("void")));
wxPyEndBlockThreads(blocked);
return tup;
}
// TODO: GetPrevChild
}
// get the last child of this item - this method doesn't use cookies
wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
// get the next sibling of this item
wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
// get the previous sibling
wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
// get first visible item
wxTreeItemId GetFirstVisibleItem() const;
// get the next visible item: item must be visible itself!
// see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
// get the previous visible item: item must be visible itself!
wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
// Only for internal use right now, but should probably be public
wxTreeItemId GetNext(const wxTreeItemId& item) const;
%disownarg( wxPyTreeItemData* data );
// add the root node to the tree
wxTreeItemId AddRoot(const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item in as the first child of the parent
wxTreeItemId PrependItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item after a given one
wxTreeItemId InsertItem(const wxTreeItemId& parent,
const wxTreeItemId& idPrevious,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
// insert a new item before the one with the given index
%Rename(InsertItemBefore,
wxTreeItemId, InsertItem(const wxTreeItemId& parent,
size_t index,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL));
// insert a new item in as the last child of the parent
wxTreeItemId AppendItem(const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxPyTreeItemData *data = NULL);
%cleardisown(wxPyTreeItemData* data );
// delete this item and associated data if any
void Delete(const wxTreeItemId& item);
// delete all children (but don't delete the item itself)
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteChildren(const wxTreeItemId& item);
// delete all items from the tree
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteAllItems();
// expand this item
void Expand(const wxTreeItemId& item);
// expand this item and all subitems recursively
void ExpandAll(const wxTreeItemId& item);
// collapse the item without removing its children
void Collapse(const wxTreeItemId& item);
// collapse the item and remove all children
void CollapseAndReset(const wxTreeItemId& item);
// toggles the current state
void Toggle(const wxTreeItemId& item);
// remove the selection from currently selected item (if any)
void Unselect();
void UnselectAll();
// select this item
void SelectItem(const wxTreeItemId& item, bool unselect_others=true,
bool extended_select=false);
void SelectAll(bool extended_select=false);
// make sure this item is visible (expanding the parent item and/or
// scrolling to this item if necessary)
void EnsureVisible(const wxTreeItemId& item);
// scroll to this item (but don't expand its parent)
void ScrollTo(const wxTreeItemId& item);
// Returns wxTreeItemId, flags, and column
wxTreeItemId HitTest(const wxPoint& point, int& OUTPUT, int& OUTPUT);
%extend {
// get the bounding rectangle of the item (or of its label only)
PyObject* GetBoundingRect(const wxTreeItemId& item, bool textOnly = false) {
wxRect rect;
if (self->GetBoundingRect(item, rect, textOnly)) {
wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxRect* r = new wxRect(rect);
PyObject* val = wxPyConstructObject((void*)r, wxT("wxRect"), 1);
wxPyEndBlockThreads(blocked);
return val;
}
else {
RETURN_NONE();
}
}
}
// Start editing the item label: this (temporarily) replaces the item
// with a one line edit control. The item will be selected if it hadn't
// been before.
void EditLabel( const wxTreeItemId& item );
void Edit( const wxTreeItemId& item );
// sort the children of this item using OnCompareItems
void SortChildren(const wxTreeItemId& item);
// searching
wxTreeItemId FindItem (const wxTreeItemId& item, const wxString& str, int flags = 0);
wxWindow* GetHeaderWindow() const;
wxScrolledWindow* GetMainWindow() const;
};
%include _treelist.i
//----------------------------------------------------------------------
@@ -1020,14 +472,9 @@ public:
//----------------------------------------------------------------------
%init %{
wxPyPtrTypeMap_Add("wxTreeCompanionWindow", "wxPyTreeCompanionWindow");
wxPyPtrTypeMap_Add("wxTreeListCtrl", "wxPyTreeListCtrl");
%}
%pragma(python) include="_gizmoextras.py";
//----------------------------------------------------------------------
//----------------------------------------------------------------------

388
wxPython/contrib/gizmos/wxCode/include/wx/treelistctrl.h
View File

@@ -2,10 +2,10 @@
// Name: treelistctrl.h
// Purpose: wxTreeListCtrl class
// Author: Robert Roebling
// Modified by: Alberto Griggio, 2002
// Maintainer: Otto Wyss
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Robert Roebling, Julian Smart, Alberto Griggio,
// Copyright: (c) 2004 Robert Roebling, Julian Smart, Alberto Griggio,
// Vadim Zeitlin, Otto Wyss
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
@@ -30,6 +30,8 @@ class GIZMODLLEXPORT wxTreeListItem;
class GIZMODLLEXPORT wxTreeListHeaderWindow;
class GIZMODLLEXPORT wxTreeListMainWindow;
#define wxTR_COLUMN_LINES 0x1000 // put border around items
#define wxTR_VIRTUAL 0x4000 // The application provides items text on demand.
// Using this typedef removes an ambiguity when calling Remove()
#ifdef __WXMSW__
@@ -40,96 +42,91 @@ typedef void *wxTreeItemIdValue;
#endif
#endif
#define wxTR_DONT_ADJUST_MAC 0x0100 // Don't adjust the style for the Mac
//-----------------------------------------------------------------------------
// wxTreeListColumnAttrs
//-----------------------------------------------------------------------------
enum wxTreeListColumnAlign {
wxTL_ALIGN_LEFT,
wxTL_ALIGN_RIGHT,
wxTL_ALIGN_CENTER
enum {
DEFAULT_COL_WIDTH = 100
};
class GIZMODLLEXPORT wxTreeListColumnInfo: public wxObject {
public:
enum { DEFAULT_COL_WIDTH = 100 };
wxTreeListColumnInfo(const wxString &text = wxT(""),
public:
wxTreeListColumnInfo (const wxString &text = wxEmptyString,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
size_t width = DEFAULT_COL_WIDTH,
bool shown = true,
wxTreeListColumnAlign alignment = wxTL_ALIGN_LEFT)
{
m_image = image;
m_selected_image = -1;
bool edit = false) {
m_text = text;
m_width = width;
m_flag = flag;
m_image = image;
m_selected_image = -1;
m_shown = shown;
m_alignment = alignment;
m_edit = edit;
}
wxTreeListColumnInfo(const wxTreeListColumnInfo& other)
{
m_image = other.m_image;
m_selected_image = other.m_selected_image;
wxTreeListColumnInfo (const wxTreeListColumnInfo& other) {
m_text = other.m_text;
m_width = other.m_width;
m_flag = other.m_flag;
m_image = other.m_image;
m_selected_image = other.m_selected_image;
m_shown = other.m_shown;
m_alignment = other.m_alignment;
m_edit = other.m_edit;
}
~wxTreeListColumnInfo() {}
// getters
bool GetShown() const { return m_shown; }
wxTreeListColumnAlign GetAlignment() const { return m_alignment; }
// get/set
wxString GetText() const { return m_text; }
wxTreeListColumnInfo& SetText (const wxString& text) { m_text = text; return *this; }
int GetWidth() const { return m_width; }
wxTreeListColumnInfo& SetWidth (int width) { m_width = width; return *this; }
int GetAlignment() const { return m_flag; }
wxTreeListColumnInfo& SetAlignment (int flag) { m_flag = flag; return *this; }
int GetImage() const { return m_image; }
wxTreeListColumnInfo& SetImage (int image) { m_image = image; return *this; }
int GetSelectedImage() const { return m_selected_image; }
size_t GetWidth() const { return m_width; }
wxTreeListColumnInfo& SetSelectedImage (int image) { m_selected_image = image; return *this; }
// setters
wxTreeListColumnInfo& SetShown(bool shown)
{ m_shown = shown; return *this; }
bool IsEditable() const { return m_edit; }
wxTreeListColumnInfo& SetEditable (bool edit)
{ m_edit = edit; return *this; }
wxTreeListColumnInfo& SetAlignment(wxTreeListColumnAlign alignment)
{ m_alignment = alignment; return *this; }
wxTreeListColumnInfo& SetText(const wxString& text)
{ m_text = text; return *this; }
wxTreeListColumnInfo& SetImage(int image)
{ m_image = image; return *this; }
wxTreeListColumnInfo& SetSelectedImage(int image)
{ m_selected_image = image; return *this; }
wxTreeListColumnInfo& SetWidth(size_t with)
{ m_width = with; return *this; }
bool IsShown() const { return m_shown; }
wxTreeListColumnInfo& SetShown(bool shown) { m_shown = shown; return *this; }
private:
bool m_shown;
wxTreeListColumnAlign m_alignment;
wxString m_text;
int m_width;
int m_flag;
int m_image;
int m_selected_image;
size_t m_width;
bool m_shown;
bool m_edit;
};
//----------------------------------------------------------------------------
// wxTreeListCtrl - the multicolumn tree control
//----------------------------------------------------------------------------
// flags for FindItem
const int wxTL_SEARCH_VISIBLE = 0x0000;
const int wxTL_SEARCH_LEVEL = 0x0001;
const int wxTL_SEARCH_FULL = 0x0002;
const int wxTL_SEARCH_PARTIAL = 0x0010;
const int wxTL_SEARCH_NOCASE = 0x0020;
// modes for navigation
const int wxTL_MODE_NAV_FULLTREE = 0x0000; // default
const int wxTL_MODE_NAV_EXPANDED = 0x0001;
const int wxTL_MODE_NAV_VISIBLE = 0x0002;
const int wxTL_MODE_NAV_LEVEL = 0x0004;
// modes for FindItem
const int wxTL_MODE_FIND_EXACT = 0x0000; // default
const int wxTL_MODE_FIND_PARTIAL = 0x0010;
const int wxTL_MODE_FIND_NOCASE = 0x0020;
// additional flag for HitTest
const int wxTREE_HITTEST_ONITEMCOLUMN = 0x2000;
@@ -207,144 +204,147 @@ public:
void AssignButtonsImageList(wxImageList *imageList);
// Functions to work with tree list ctrl columns
// Functions to work with columns
// adds a column
void AddColumn(const wxString& text)
{ AddColumn(wxTreeListColumnInfo(text)); }
void AddColumn(const wxString& text,
size_t width,
wxTreeListColumnAlign alignment = wxTL_ALIGN_LEFT)
{ AddColumn(wxTreeListColumnInfo(text,
-1,
width,
true,
alignment)); }
void AddColumn(const wxTreeListColumnInfo& col);
void AddColumn (const wxString& text,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
bool shown = true,
bool edit = false) {
AddColumn (wxTreeListColumnInfo (text, width, flag, image, shown, edit));
}
void AddColumn (const wxTreeListColumnInfo& colInfo);
// inserts a column before the given one
void InsertColumn(size_t before, const wxString& text)
{ InsertColumn(before, wxTreeListColumnInfo(text)); }
void InsertColumn(size_t before, const wxTreeListColumnInfo& col);
void InsertColumn (int before,
const wxString& text,
int width = DEFAULT_COL_WIDTH,
int flag = wxALIGN_LEFT,
int image = -1,
bool shown = true,
bool edit = false) {
InsertColumn (before,
wxTreeListColumnInfo (text, width, flag, image, shown, edit));
}
void InsertColumn (int before, const wxTreeListColumnInfo& colInfo);
// deletes the given column - does not delete the corresponding column
// of each item
void RemoveColumn(size_t column);
void RemoveColumn (int column);
// returns the number of columns in the ctrl
size_t GetColumnCount() const;
void SetColumnWidth(size_t column, size_t width);
int GetColumnWidth(size_t column) const;
int GetColumnCount() const;
// tells which column is the "main" one, i.e. the "threaded" one
void SetMainColumn(size_t column);
size_t GetMainColumn() const;
void SetMainColumn (int column);
int GetMainColumn() const;
void SetColumnText(size_t column, const wxString& text);
wxString GetColumnText(size_t column) const;
void SetColumn (int column, const wxTreeListColumnInfo& colInfo);
wxTreeListColumnInfo& GetColumn (int column);
const wxTreeListColumnInfo& GetColumn (int column) const;
void SetColumn(size_t column, const wxTreeListColumnInfo& info);
wxTreeListColumnInfo& GetColumn(size_t column);
const wxTreeListColumnInfo& GetColumn(size_t column) const;
void SetColumnText (int column, const wxString& text);
wxString GetColumnText (int column) const;
// other column-related methods
void SetColumnAlignment(size_t column, wxTreeListColumnAlign align);
wxTreeListColumnAlign GetColumnAlignment(size_t column) const;
void SetColumnWidth (int column, int width);
int GetColumnWidth (int column) const;
void SetColumnImage(size_t column, int image);
int GetColumnImage(size_t column) const;
void SetColumnAlignment (int column, int flag);
int GetColumnAlignment (int column) const;
void ShowColumn(size_t column, bool shown);
bool IsColumnShown(size_t column) const;
void SetColumnImage (int column, int image);
int GetColumnImage (int column) const;
// Functions to work with tree list ctrl items.
void SetColumnShown (int column, bool shown = true);
bool IsColumnShown (int column) const;
void SetColumnEditable (int column, bool edit = true);
bool IsColumnEditable (int column) const;
// Functions to work with items.
// accessors
// ---------
// retrieve item's label (of the main column)
wxString GetItemText(const wxTreeItemId& item) const
{ return GetItemText(item, GetMainColumn()); }
wxString GetItemText (const wxTreeItemId& item) const
{ return GetItemText (item, GetMainColumn()); }
// retrieves item's label of the given column
wxString GetItemText(const wxTreeItemId& item, size_t column) const;
wxString GetItemText (const wxTreeItemId& item, int column) const;
// get one of the images associated with the item (normal by default)
int GetItemImage(const wxTreeItemId& item,
int GetItemImage (const wxTreeItemId& item,
wxTreeItemIcon which = wxTreeItemIcon_Normal) const
{ return GetItemImage(item, GetMainColumn(), which); }
int GetItemImage(const wxTreeItemId& item, size_t column,
{ return GetItemImage (item, GetMainColumn(), which); }
int GetItemImage (const wxTreeItemId& item, int column,
wxTreeItemIcon which = wxTreeItemIcon_Normal) const;
// get the data associated with the item
wxTreeItemData *GetItemData(const wxTreeItemId& item) const;
wxTreeItemData *GetItemData (const wxTreeItemId& item) const;
bool GetItemBold(const wxTreeItemId& item) const;
wxColour GetItemTextColour(const wxTreeItemId& item) const;
wxColour GetItemBackgroundColour(const wxTreeItemId& item) const;
wxFont GetItemFont(const wxTreeItemId& item) const;
bool GetItemBold (const wxTreeItemId& item) const;
wxColour GetItemTextColour (const wxTreeItemId& item) const;
wxColour GetItemBackgroundColour (const wxTreeItemId& item) const;
wxFont GetItemFont (const wxTreeItemId& item) const;
// modifiers
// ---------
// set item's label
void SetItemText(const wxTreeItemId& item, const wxString& text)
{ SetItemText(item, GetMainColumn(), text); }
void SetItemText(const wxTreeItemId& item, size_t column,
const wxString& text);
void SetItemText (const wxTreeItemId& item, const wxString& text)
{ SetItemText (item, GetMainColumn(), text); }
void SetItemText (const wxTreeItemId& item, int column, const wxString& text);
// get one of the images associated with the item (normal by default)
void SetItemImage(const wxTreeItemId& item, int image,
void SetItemImage (const wxTreeItemId& item, int image,
wxTreeItemIcon which = wxTreeItemIcon_Normal)
{ SetItemImage(item, GetMainColumn(), image, which); }
{ SetItemImage (item, GetMainColumn(), image, which); }
// the which parameter is ignored for all columns but the main one
void SetItemImage(const wxTreeItemId& item, size_t column, int image,
void SetItemImage (const wxTreeItemId& item, int column, int image,
wxTreeItemIcon which = wxTreeItemIcon_Normal);
// associate some data with the item
void SetItemData(const wxTreeItemId& item, wxTreeItemData *data);
void SetItemData (const wxTreeItemId& item, wxTreeItemData *data);
// force appearance of [+] button near the item. This is useful to
// 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
void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
void SetItemBold (const wxTreeItemId& item, bool bold = true);
// set the item's text colour
void SetItemTextColour(const wxTreeItemId& item, const wxColour& colour);
void SetItemTextColour (const wxTreeItemId& item, const wxColour& colour);
// set the item's background colour
void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& colour);
void SetItemBackgroundColour (const wxTreeItemId& item, const wxColour& colour);
// set the item's font (should be of the same height for all items)
void SetItemFont(const wxTreeItemId& item, const wxFont& font);
void SetItemFont (const wxTreeItemId& item, const wxFont& font);
// set the window font
virtual bool SetFont( const wxFont &font );
virtual bool SetFont ( const wxFont &font );
// set the styles.
void SetWindowStyle(const long styles);
void SetWindowStyle (const long styles);
long GetWindowStyle() const;
long GetWindowStyleFlag() const { return GetWindowStyle(); }
long GetWindowStyleFlag () const { return GetWindowStyle(); }
// item status inquiries
// ---------------------
// is the item visible (it might be outside the view or not expanded)?
bool IsVisible(const wxTreeItemId& item) const;
bool IsVisible (const wxTreeItemId& item, bool fullRow = false) const;
// does the item has any children?
bool HasChildren(const wxTreeItemId& item) const
{ return ItemHasChildren(item); }
bool ItemHasChildren(const wxTreeItemId& item) const;
bool HasChildren (const wxTreeItemId& item) const;
// is the item expanded (only makes sense if HasChildren())?
bool IsExpanded(const wxTreeItemId& item) const;
bool IsExpanded (const wxTreeItemId& item) const;
// is this item currently selected (the same as has focus)?
bool IsSelected(const wxTreeItemId& item) const;
bool IsSelected (const wxTreeItemId& item) const;
// is item text in bold font?
bool IsBold(const wxTreeItemId& item) const;
bool IsBold (const wxTreeItemId& item) const;
// does the layout include space for a button?
// number of children
@@ -352,7 +352,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, bool recursively = TRUE);
size_t GetChildrenCount (const wxTreeItemId& item, bool recursively = true);
// navigation
// ----------
@@ -366,10 +366,10 @@ public:
wxTreeItemId GetSelection() const;
// get the items currently selected, return the number of such item
size_t GetSelections(wxArrayTreeItemIds&) const;
size_t GetSelections (wxArrayTreeItemIds&) const;
// get the parent of this item (may return NULL if root)
wxTreeItemId GetItemParent(const wxTreeItemId& item) const;
wxTreeItemId GetItemParent (const wxTreeItemId& item) const;
// for this enumeration function you must pass in a "cookie" parameter
// which is opaque for the application but is necessary for the library
@@ -378,148 +378,148 @@ public:
// the "cookie" passed to GetFirstChild() and GetNextChild() should be
// the same!
// get the first child of this item
// get child of this item
#if !wxCHECK_VERSION(2, 5, 0)
wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& cookie) const;
wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
wxTreeItemId GetPrevChild(const wxTreeItemId& item, long& cookie) const;
wxTreeItemId GetLastChild(const wxTreeItemId& item, long& cookie) const;
#else
wxTreeItemId GetFirstChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const;
#endif
// get the next child
#if !wxCHECK_VERSION(2, 5, 0)
wxTreeItemId GetNextChild(const wxTreeItemId& item, long& cookie) const;
#else
wxTreeItemId GetNextChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const;
#endif
// get the prev child
#if !wxCHECK_VERSION(2, 5, 0)
wxTreeItemId GetPrevChild(const wxTreeItemId& item, long& cookie) const;
#else
wxTreeItemId GetPrevChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const;
wxTreeItemId GetLastChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const;
#endif
// get the last child of this item - this method doesn't use cookies
wxTreeItemId GetLastChild(const wxTreeItemId& item) const;
// get the next sibling of this item
// get sibling of this item
wxTreeItemId GetNextSibling(const wxTreeItemId& item) const;
// get the previous sibling
wxTreeItemId GetPrevSibling(const wxTreeItemId& item) const;
// get first visible item
wxTreeItemId GetFirstVisibleItem() const;
// get the next visible item: item must be visible itself!
// see IsVisible() and wxTreeCtrl::GetFirstVisibleItem()
wxTreeItemId GetNextVisible(const wxTreeItemId& item) const;
// get the previous visible item: item must be visible itself!
wxTreeItemId GetPrevVisible(const wxTreeItemId& item) const;
// Only for internal use right now, but should probably be public
// get item in the full tree (currently only for internal use)
wxTreeItemId GetNext(const wxTreeItemId& item) const;
wxTreeItemId GetPrev(const wxTreeItemId& item) const;
// get expanded item, see IsExpanded()
wxTreeItemId GetFirstExpandedItem() const;
wxTreeItemId GetNextExpanded(const wxTreeItemId& item) const;
wxTreeItemId GetPrevExpanded(const wxTreeItemId& item) const;
// get visible item, see IsVisible()
wxTreeItemId GetFirstVisibleItem(bool fullRow = false) const;
wxTreeItemId GetNextVisible(const wxTreeItemId& item, bool fullRow = false) const;
wxTreeItemId GetPrevVisible(const wxTreeItemId& item, bool fullRow = false) const;
// operations
// ----------
// add the root node to the tree
wxTreeItemId AddRoot(const wxString& text,
wxTreeItemId AddRoot (const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item in as the first child of the parent
wxTreeItemId PrependItem(const wxTreeItemId& parent,
wxTreeItemId PrependItem (const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item after a given one
wxTreeItemId InsertItem(const wxTreeItemId& parent,
wxTreeItemId InsertItem (const wxTreeItemId& parent,
const wxTreeItemId& idPrevious,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item before the one with the given index
wxTreeItemId InsertItem(const wxTreeItemId& parent,
wxTreeItemId InsertItem (const wxTreeItemId& parent,
size_t index,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// insert a new item in as the last child of the parent
wxTreeItemId AppendItem(const wxTreeItemId& parent,
wxTreeItemId AppendItem (const wxTreeItemId& parent,
const wxString& text,
int image = -1, int selectedImage = -1,
wxTreeItemData *data = NULL);
// delete this item and associated data if any
void Delete(const wxTreeItemId& item);
// delete this item (except root) and associated data if any
void Delete (const wxTreeItemId& item);
// delete all children (but don't delete the item itself)
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteChildren(const wxTreeItemId& item);
// delete all items from the tree
void DeleteChildren (const wxTreeItemId& item);
// delete the root and all its children from the tree
// NB: this won't send wxEVT_COMMAND_TREE_ITEM_DELETED events
void DeleteAllItems();
void DeleteRoot();
// expand this item
void Expand(const wxTreeItemId& item);
void Expand (const wxTreeItemId& item);
// expand this item and all subitems recursively
void ExpandAll(const wxTreeItemId& item);
void ExpandAll (const wxTreeItemId& item);
// collapse the item without removing its children
void Collapse(const wxTreeItemId& item);
void Collapse (const wxTreeItemId& item);
// collapse the item and remove all children
void CollapseAndReset(const wxTreeItemId& item);
void CollapseAndReset(const wxTreeItemId& item); //? TODO ???
// toggles the current state
void Toggle(const wxTreeItemId& item);
void Toggle (const wxTreeItemId& item);
// remove the selection from currently selected item (if any)
void Unselect();
void UnselectAll();
// select this item
void SelectItem(const wxTreeItemId& item, bool unselect_others=TRUE,
bool extended_select=FALSE);
void SelectAll(bool extended_select=FALSE);
void SelectItem (const wxTreeItemId& item,
const wxTreeItemId& last = (wxTreeItemId*)NULL,
bool unselect_others = true);
// select all items in the expanded tree
void SelectAll();
// make sure this item is visible (expanding the parent item and/or
// scrolling to this item if necessary)
void EnsureVisible(const wxTreeItemId& item);
void EnsureVisible (const wxTreeItemId& item);
// scroll to this item (but don't expand its parent)
void ScrollTo(const wxTreeItemId& item);
//void AdjustMyScrollbars();
void ScrollTo (const wxTreeItemId& item);
// The first function is more portable (because easier to implement
// on other platforms), but the second one returns some extra info.
wxTreeItemId HitTest(const wxPoint& point)
{ int dummy; return HitTest(point, dummy); }
wxTreeItemId HitTest(const wxPoint& point, int& flags)
{ int col; return HitTest(point, flags, col); }
wxTreeItemId HitTest(const wxPoint& point, int& flags, int& column);
wxTreeItemId HitTest (const wxPoint& point)
{ int flags; int column; return HitTest (point, flags, column); }
wxTreeItemId HitTest (const wxPoint& point, int& flags)
{ int column; return HitTest (point, flags, column); }
wxTreeItemId HitTest (const wxPoint& point, int& flags, int& column);
// get the bounding rectangle of the item (or of its label only)
bool GetBoundingRect(const wxTreeItemId& item,
wxRect& rect,
bool textOnly = FALSE) const;
bool GetBoundingRect (const wxTreeItemId& item, wxRect& rect,
bool textOnly = false) const;
// Start editing the item label: this (temporarily) replaces the item
// with a one line edit control. The item will be selected if it hadn't
// been before.
void EditLabel( const wxTreeItemId& item ) { Edit( item ); }
void Edit( const wxTreeItemId& item );
void EditLabel (const wxTreeItemId& item)
{ EditLabel (item, GetMainColumn()); }
// edit item's label of the given column
void EditLabel (const wxTreeItemId& item, int column);
// virtual mode
virtual wxString OnGetItemText( wxTreeItemData* item, long column ) const;
// sorting
// this function is called to compare 2 items and should return -1, 0
// or +1 if the first item is less than, equal to or greater than the
// second one. The base class version performs alphabetic comparaison
// of item labels (GetText)
virtual int OnCompareItems(const wxTreeItemId& item1,
const wxTreeItemId& item2);
virtual int OnCompareItems (const wxTreeItemId& item1, const wxTreeItemId& item2);
// sort the children of this item using OnCompareItems
//
// NB: this function is not reentrant and not MT-safe (FIXME)!
void SortChildren(const wxTreeItemId& item);
// searching
wxTreeItemId FindItem (const wxTreeItemId& item, const wxString& str, int flags = 0);
wxTreeItemId FindItem (const wxTreeItemId& item, const wxString& str, int mode = 0);
// overridden base class virtuals
virtual bool SetBackgroundColour(const wxColour& colour);
virtual bool SetForegroundColour(const wxColour& colour);
virtual bool SetBackgroundColour (const wxColour& colour);
virtual bool SetForegroundColour (const wxColour& colour);
// drop over item
void SetDragItem (const wxTreeItemId& item = (wxTreeItemId*)NULL);
wxTreeListHeaderWindow* GetHeaderWindow() const
@@ -533,20 +533,16 @@ public:
protected:
// header window, responsible for column visualization and manipulation
wxTreeListHeaderWindow* m_header_win;
// main window, the "true" tree ctrl
wxTreeListMainWindow* m_main_win;
// // the common part of all ctors
// void Init();
void OnGetToolTip( wxTreeEvent &event );
void OnSize(wxSizeEvent& event);
void CalculateAndSetHeaderHeight();
void DoHeaderLayout();
void OnSize(wxSizeEvent& event);
private:
size_t fill_column;
size_t m_headerHeight;
int m_headerHeight;
DECLARE_EVENT_TABLE()
DECLARE_DYNAMIC_CLASS(wxTreeListCtrl)

4725
wxPython/contrib/gizmos/wxCode/src/treelistctrl.cpp
View File

File diff suppressed because it is too large Load Diff

7
wxPython/demo/TreeListCtrl.py
View File

@@ -16,14 +16,9 @@ class TestPanel(wx.Panel):
wx.TR_DEFAULT_STYLE
#wx.TR_TWIST_BUTTONS
#| wx.TR_ROW_LINES
#| wx.TR_COLUMN_LINES
#| wx.TR_NO_LINES
| wx.TR_FULL_ROW_HIGHLIGHT
# By default the style will be adjusted on
# Mac to use twisty buttons and no lines. If
# you would rather control this yourself then
# add this style.
#| wx.TR_DONT_ADJUST_MAC
)
isz = (16,16)

17
wxPython/docs/CHANGES.txt
View File

@@ -196,7 +196,7 @@ wx.BitmapFromBufferRGBA factory functions. They enable loading of an
image or bitmap directly from a Python object that implements the
buffer interface, such as strings, arrays, etc.
Added wx.App.DisplayAvailable() which can be used to determine if a
Added wx.App.IsDisplayAvailable() which can be used to determine if a
GUI can be created in the current environment. (Still need an
implementation for wxMSW...)
@@ -232,7 +232,22 @@ restrictions in how/where the toolbar can be used.
Added wx.Window.IsVisible.
Added Python properties for many of the getter/setter methods of wx
classes. In order for the names to be predicatble for somebody
already familiar with wxPython the property names are simply the name
of the getter with the "Get" dropped. For example, wx.Window has a
property named "Size" that maps to GetSize and SetSize. So far there
is only one known name conflict using this naming convention, and that
is wx.KeyEvent.KeyCode, however since KeyCode was formerly a
compatibility alias for GetKeyCode (and has been for a long time) it
was decided to just switch it to a property. If you want to use the
method then change your calls to event.KeyCode() to
event.GetKeyCode(), otherwise you can use it as a property just by
dropping the parentheses.
Updated the C++ code for wx.gizmos.TreeListCtrl from the wxCode
project. This has resulted in some minor API changes, most of which
were handled in the wrapper code.

3
wxPython/setup.py
View File

@@ -684,7 +684,8 @@ if BUILD_GIZMOS:
location = 'contrib/gizmos'
swig_sources = run_swig(['gizmos.i'], location, GENDIR, PKGDIR,
USE_SWIG, swig_force, swig_args, swig_deps)
USE_SWIG, swig_force, swig_args, swig_deps +
[ '%s/_treelist.i' % location])
ext = Extension('_gizmos',
[ '%s/treelistctrl.cpp' % opj(location, 'wxCode/src') ] + swig_sources,