| 1 |
////////////////////////////////////////////////////////////////////// |
| 2 |
// This file was auto-generated by codelite's wxCrafter Plugin |
| 3 |
// Do not modify this file by hand! |
| 4 |
////////////////////////////////////////////////////////////////////// |
| 5 |
|
| 6 |
#ifndef __BLOCK_GUARD__ |
| 7 |
#define __BLOCK_GUARD__ |
| 8 |
|
| 9 |
#include <algorithm> |
| 10 |
#include <wx/clntdata.h> |
| 11 |
#include <wx/dataview.h> |
| 12 |
#include <wx/variant.h> |
| 13 |
|
| 14 |
/** |
| 15 |
* @brief each item in the wxDataViewCtrl is represented in the model by this class. |
| 16 |
* m_data - contains the data (columns values) as passed when adding an item to the wxDataViewCtrl model class |
| 17 |
* m_clientData - is the user client data (owned by the model) |
| 18 |
* To convert between a wxDataViewItem to a MODEL_NAME_Item class, simply use: |
| 19 |
* @code |
| 20 |
* MODEL_NAME_Item* itemData = reinterpret_cast<MODEL_NAME_Item*>( item.GetID() ); |
| 21 |
* if ( itemData ) { |
| 22 |
* // you can now traverse the tree or have a direct access to the model internal data |
| 23 |
* // note that you must not delete itemData as it is owned by the model |
| 24 |
* } |
| 25 |
* @endcode |
| 26 |
*/ |
| 27 |
class MODEL_NAME_Item |
| 28 |
{ |
| 29 |
protected: |
| 30 |
wxVector<wxVariant> m_data; |
| 31 |
MODEL_NAME_Item* m_parent; |
| 32 |
wxVector<MODEL_NAME_Item*> m_children; |
| 33 |
bool m_isContainer; |
| 34 |
wxClientData* m_clientData; |
| 35 |
|
| 36 |
public: |
| 37 |
MODEL_NAME_Item() |
| 38 |
: m_parent(NULL) |
| 39 |
, m_isContainer(false) |
| 40 |
, m_clientData(NULL) |
| 41 |
{} |
| 42 |
virtual ~MODEL_NAME_Item() { |
| 43 |
if ( m_clientData ) { |
| 44 |
delete m_clientData; |
| 45 |
m_clientData = NULL; |
| 46 |
} |
| 47 |
m_data.clear(); |
| 48 |
|
| 49 |
// Delete our children |
| 50 |
// since the deletion of a child may alter its parent m_children array |
| 51 |
// we use a temporary vector for the loop |
| 52 |
wxVector<MODEL_NAME_Item*> tmpChildren = m_children; |
| 53 |
while ( !tmpChildren.empty() ) { |
| 54 |
delete (*tmpChildren.begin()); |
| 55 |
tmpChildren.erase(tmpChildren.begin()); |
| 56 |
} |
| 57 |
m_children.clear(); |
| 58 |
|
| 59 |
// Remove us from the parent |
| 60 |
if ( m_parent ) { |
| 61 |
m_parent->RemoveChild(this); |
| 62 |
} |
| 63 |
} |
| 64 |
|
| 65 |
void SetIsContainer(bool b) { |
| 66 |
m_isContainer = b; |
| 67 |
} |
| 68 |
|
| 69 |
bool IsContainer() const { |
| 70 |
return m_isContainer; |
| 71 |
} |
| 72 |
|
| 73 |
/** |
| 74 |
* @brief remove a child from this node and free its memory |
| 75 |
* @param child |
| 76 |
*/ |
| 77 |
void DeleteChild(MODEL_NAME_Item* child) { |
| 78 |
wxVector<MODEL_NAME_Item*>::iterator iter = std::find(m_children.begin(), m_children.end(), child); |
| 79 |
if ( iter != m_children.end() ) { |
| 80 |
delete *iter; |
| 81 |
m_children.erase(iter); |
| 82 |
} |
| 83 |
} |
| 84 |
|
| 85 |
/** |
| 86 |
* @brief remove child from this node without freeing its memory |
| 87 |
* @param child |
| 88 |
*/ |
| 89 |
void RemoveChild(MODEL_NAME_Item* child) { |
| 90 |
wxVector<MODEL_NAME_Item*>::iterator iter = std::find(m_children.begin(), m_children.end(), child); |
| 91 |
if ( iter != m_children.end() ) { |
| 92 |
m_children.erase(iter); |
| 93 |
} |
| 94 |
} |
| 95 |
|
| 96 |
/** |
| 97 |
* @brief add child to this node |
| 98 |
*/ |
| 99 |
void AddChild(MODEL_NAME_Item* child) { |
| 100 |
m_children.push_back(child); |
| 101 |
child->m_parent = this; |
| 102 |
} |
| 103 |
|
| 104 |
bool IsRoot() const { |
| 105 |
return m_parent == NULL; |
| 106 |
} |
| 107 |
|
| 108 |
// Setters / Getters |
| 109 |
void SetChildren(const wxVector<MODEL_NAME_Item*>& children) { |
| 110 |
this->m_children = children; |
| 111 |
} |
| 112 |
void SetData(const wxVector<wxVariant>& data) { |
| 113 |
this->m_data = data; |
| 114 |
} |
| 115 |
void SetParent(MODEL_NAME_Item* parent) { |
| 116 |
this->m_parent = parent; |
| 117 |
} |
| 118 |
const wxVector<MODEL_NAME_Item*>& GetChildren() const { |
| 119 |
return m_children; |
| 120 |
} |
| 121 |
wxVector<MODEL_NAME_Item*>& GetChildren() { |
| 122 |
return m_children; |
| 123 |
} |
| 124 |
const wxVector<wxVariant>& GetData() const { |
| 125 |
return m_data; |
| 126 |
} |
| 127 |
wxVector<wxVariant>& GetData() { |
| 128 |
return m_data; |
| 129 |
} |
| 130 |
MODEL_NAME_Item* GetParent() { |
| 131 |
return m_parent; |
| 132 |
} |
| 133 |
|
| 134 |
void SetClientObject(wxClientData *data) { |
| 135 |
if ( m_clientData ) { |
| 136 |
delete m_clientData; |
| 137 |
} |
| 138 |
m_clientData = data; |
| 139 |
} |
| 140 |
|
| 141 |
wxClientData* GetClientObject() const { |
| 142 |
return m_clientData; |
| 143 |
} |
| 144 |
}; |
| 145 |
|
| 146 |
////////////////////////////////////////////// |
| 147 |
// The TreeListCtrl model |
| 148 |
////////////////////////////////////////////// |
| 149 |
|
| 150 |
class MODEL_NAME : public wxDataViewModel |
| 151 |
{ |
| 152 |
protected: |
| 153 |
wxVector<MODEL_NAME_Item*> m_data; |
| 154 |
unsigned int m_colCount; |
| 155 |
|
| 156 |
public: |
| 157 |
MODEL_NAME(); |
| 158 |
virtual ~MODEL_NAME(); |
| 159 |
|
| 160 |
/** |
| 161 |
* @brief a helper method creating a wxVariant containing both bitmap and text |
| 162 |
* this is useful when mostly when populating a column of type 'icontext' |
| 163 |
*/ |
| 164 |
static wxVariant CreateIconTextVariant(const wxString &text, const wxBitmap& bmp); |
| 165 |
|
| 166 |
void SetColCount(unsigned int colCount) { |
| 167 |
this->m_colCount = colCount; |
| 168 |
} |
| 169 |
void SetData(const wxVector<MODEL_NAME_Item*> data) { |
| 170 |
this->m_data = data; |
| 171 |
} |
| 172 |
unsigned int GetColCount() const { |
| 173 |
return m_colCount; |
| 174 |
} |
| 175 |
const wxVector<MODEL_NAME_Item*>& GetData() const { |
| 176 |
return m_data; |
| 177 |
} |
| 178 |
wxVector<MODEL_NAME_Item*>& GetData() { |
| 179 |
return m_data; |
| 180 |
} |
| 181 |
|
| 182 |
virtual bool HasContainerColumns (const wxDataViewItem& item) const { |
| 183 |
return HAS_CONTAINER_COLUMNS; |
| 184 |
} |
| 185 |
|
| 186 |
public: |
| 187 |
// Make the functions below 'virtual' so the user may override them |
| 188 |
virtual unsigned int GetColumnCount() const; |
| 189 |
virtual wxString GetColumnType(unsigned int col) const; |
| 190 |
virtual void GetValue(wxVariant& variant, const wxDataViewItem& item, unsigned int col) const; |
| 191 |
virtual bool SetValue(const wxVariant &variant, const wxDataViewItem &item, unsigned int col); |
| 192 |
|
| 193 |
protected: |
| 194 |
// Helpers |
| 195 |
virtual wxDataViewItem DoAppendItem(const wxDataViewItem& parent, const wxVector<wxVariant>& data, bool isContainer, wxClientData *clientData = NULL); |
| 196 |
virtual wxDataViewItem DoInsertItem(const wxDataViewItem& insertBeforeMe, const wxVector<wxVariant>& data, bool isContainer, wxClientData *clientData); |
| 197 |
virtual void DoChangeItemType(const wxDataViewItem& item, bool changeToContainer); |
| 198 |
|
| 199 |
public: |
| 200 |
/** |
| 201 |
* @brief Append a line to the model |
| 202 |
* clientData will be owned by the model once added (i.e. the clientData must be allocated on the heap and it will be freed by the model) |
| 203 |
*/ |
| 204 |
virtual wxDataViewItem AppendItem(const wxDataViewItem& parent, const wxVector<wxVariant>& data, wxClientData *clientData = NULL); |
| 205 |
|
| 206 |
/** |
| 207 |
* @brief Append a lines to the model |
| 208 |
*/ |
| 209 |
virtual wxDataViewItemArray AppendItems(const wxDataViewItem& parent, const wxVector<wxVector<wxVariant> >& data); |
| 210 |
|
| 211 |
/** |
| 212 |
* @brief delete an item and all its children |
| 213 |
* @param parent |
| 214 |
*/ |
| 215 |
virtual void DeleteItem(const wxDataViewItem& item); |
| 216 |
|
| 217 |
/** |
| 218 |
* @brief delete an item |
| 219 |
* @param parent |
| 220 |
*/ |
| 221 |
virtual void DeleteItems(const wxDataViewItem& parent, const wxDataViewItemArray& items); |
| 222 |
|
| 223 |
/** |
| 224 |
* @brief update an item data + client-data |
| 225 |
*/ |
| 226 |
virtual void UpdateItem(const wxDataViewItem& item, const wxVector<wxVariant>& data); |
| 227 |
|
| 228 |
/** |
| 229 |
* @brief insert an item into the model before 'insertBeforeMe' item. Return the newly inserted item on success |
| 230 |
*/ |
| 231 |
virtual wxDataViewItem InsertItem (const wxDataViewItem& insertBeforeMe, const wxVector<wxVariant>& data, wxClientData *clientData = NULL); |
| 232 |
|
| 233 |
/** |
| 234 |
* @brief clear the control and delete all its content |
| 235 |
*/ |
| 236 |
virtual void Clear(); |
| 237 |
|
| 238 |
virtual bool IsEmpty() const; |
| 239 |
|
| 240 |
/** |
| 241 |
* @brief returns the client data associated with this item |
| 242 |
**/ |
| 243 |
wxClientData* GetClientObject(const wxDataViewItem& item) const; |
| 244 |
|
| 245 |
/** |
| 246 |
* @brief set the client data for an item. The item data will be freed by the model |
| 247 |
*/ |
| 248 |
void SetClientObject(const wxDataViewItem& item, wxClientData *data); |
| 249 |
|
| 250 |
/** |
| 251 |
* @brief returns the item columns data (as passed to AppendItem(..) / InsertItem(...)) |
| 252 |
*/ |
| 253 |
wxVector<wxVariant> GetItemColumnsData(const wxDataViewItem& item) const; |
| 254 |
|
| 255 |
/** |
| 256 |
* @brief return true if this node is a container (i.e. has children) |
| 257 |
*/ |
| 258 |
virtual bool IsContainer(const wxDataViewItem& item) const; |
| 259 |
|
| 260 |
/** |
| 261 |
* @brief return true if item has children |
| 262 |
*/ |
| 263 |
virtual bool HasChildren(const wxDataViewItem& item) const; |
| 264 |
|
| 265 |
/** |
| 266 |
* @brief return the item parent. Return an invalid item if this item has no parent (item.IsOk() = false) |
| 267 |
*/ |
| 268 |
virtual wxDataViewItem GetParent(const wxDataViewItem& item) const; |
| 269 |
|
| 270 |
/** |
| 271 |
* @brief return the item's children as an array. |
| 272 |
* @return children count |
| 273 |
*/ |
| 274 |
virtual unsigned int GetChildren(const wxDataViewItem& item, wxDataViewItemArray& children) const; |
| 275 |
}; |
| 276 |
#endif // __BLOCK_GUARD__ |