]> git.saurik.com Git - wxWidgets.git/blame - utils/wxPython/src/controls2.i
Squashed another threading and interpreter lock bug
[wxWidgets.git] / utils / wxPython / src / controls2.i
CommitLineData
7bf85405
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: controls2.i
3// Purpose: More control (widget) classes for wxPython
4//
5// Author: Robin Dunn
6//
7// Created: 6/10/98
8// RCS-ID: $Id$
9// Copyright: (c) 1998 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
03e9bead 13%module controls2
7bf85405 14
03e9bead 15%{
7bf85405 16#include "helpers.h"
2f90df85
RD
17#ifdef __WXMSW__
18#include <windows.h>
19#endif
7bf85405
RD
20#include <wx/listctrl.h>
21#include <wx/treectrl.h>
7bf85405
RD
22%}
23
24//----------------------------------------------------------------------
25
26%include typemaps.i
27%include my_typemaps.i
28
29// Import some definitions of other classes, etc.
30%import _defs.i
31%import misc.i
32%import windows.i
33%import gdi.i
34%import events.i
35%import controls.i
36
b8b8dda7 37%pragma(python) code = "import wx"
9c039d08 38
7bf85405
RD
39//----------------------------------------------------------------------
40
41%{
42extern wxValidator wxPyDefaultValidator;
43%}
44
45//----------------------------------------------------------------------
46
af309447
RD
47enum {
48 wxLIST_MASK_TEXT,
49 wxLIST_MASK_IMAGE,
50 wxLIST_MASK_DATA,
51 wxLIST_MASK_WIDTH,
52 wxLIST_MASK_FORMAT,
bb0054cd 53 wxLIST_MASK_STATE,
af309447
RD
54 wxLIST_STATE_DONTCARE,
55 wxLIST_STATE_DROPHILITED,
56 wxLIST_STATE_FOCUSED,
57 wxLIST_STATE_SELECTED,
58 wxLIST_STATE_CUT,
59 wxLIST_HITTEST_ABOVE,
60 wxLIST_HITTEST_BELOW,
61 wxLIST_HITTEST_NOWHERE,
62 wxLIST_HITTEST_ONITEMICON,
63 wxLIST_HITTEST_ONITEMLABEL,
64 wxLIST_HITTEST_ONITEMRIGHT,
65 wxLIST_HITTEST_ONITEMSTATEICON,
66 wxLIST_HITTEST_TOLEFT,
67 wxLIST_HITTEST_TORIGHT,
68 wxLIST_HITTEST_ONITEM,
69 wxLIST_NEXT_ABOVE,
70 wxLIST_NEXT_ALL,
71 wxLIST_NEXT_BELOW,
72 wxLIST_NEXT_LEFT,
73 wxLIST_NEXT_RIGHT,
74 wxLIST_ALIGN_DEFAULT,
75 wxLIST_ALIGN_LEFT,
76 wxLIST_ALIGN_TOP,
77 wxLIST_ALIGN_SNAP_TO_GRID,
78 wxLIST_FORMAT_LEFT,
79 wxLIST_FORMAT_RIGHT,
80 wxLIST_FORMAT_CENTRE,
81 wxLIST_FORMAT_CENTER,
82 wxLIST_AUTOSIZE,
83 wxLIST_AUTOSIZE_USEHEADER,
84 wxLIST_RECT_BOUNDS,
85 wxLIST_RECT_ICON,
86 wxLIST_RECT_LABEL,
87 wxLIST_FIND_UP,
88 wxLIST_FIND_DOWN,
89 wxLIST_FIND_LEFT,
90 wxLIST_FIND_RIGHT,
91};
92
93
7bf85405
RD
94class wxListItem {
95public:
96 long m_mask; // Indicates what fields are valid
97 long m_itemId; // The zero-based item position
98 int m_col; // Zero-based column, if in report mode
99 long m_state; // The state of the item
100 long m_stateMask; // Which flags of m_state are valid (uses same flags)
101 wxString m_text; // The label/header text
102 int m_image; // The zero-based index into an image list
103 long m_data; // App-defined data
104// wxColour *m_colour; // only wxGLC, not supported by Windows ;->
105
106 // For columns only
107 int m_format; // left, right, centre
108 int m_width; // width of column
109
110 wxListItem();
111 ~wxListItem();
112};
113
114class wxListEvent: public wxCommandEvent {
115public:
116 int m_code;
117 long m_itemIndex;
118 long m_oldItemIndex;
119 int m_col;
120 bool m_cancelled;
121 wxPoint m_pointDrag;
122 wxListItem m_item;
123};
124
125
126
127
128class wxListCtrl : public wxControl {
129public:
130 wxListCtrl(wxWindow* parent, wxWindowID id,
131 const wxPoint& pos = wxPyDefaultPosition,
132 const wxSize& size = wxPyDefaultSize,
133 long style = wxLC_ICON,
134 const wxValidator& validator = wxPyDefaultValidator,
135 char* name = "listCtrl");
136
b8b8dda7 137 %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
9c039d08 138
7bf85405
RD
139 bool Arrange(int flag = wxLIST_ALIGN_DEFAULT);
140 bool DeleteItem(long item);
141 bool DeleteAllItems();
142 bool DeleteColumn(int col);
143 bool DeleteAllColumns(void);
144 void ClearAll(void);
4f22cf8d 145#ifdef __WXMSW__
7bf85405
RD
146 wxTextCtrl* EditLabel(long item);
147 bool EndEditLabel(bool cancel);
4f22cf8d 148 wxTextCtrl* GetEditControl();
8bf5d46e
RD
149#else
150 void EditLabel(long item);
fb5e0af0 151#endif
7bf85405
RD
152 bool EnsureVisible(long item);
153 long FindItem(long start, const wxString& str, bool partial = FALSE);
154 %name(FindItemData)long FindItem(long start, long data);
155 %name(FindItemAtPos)long FindItem(long start, const wxPoint& pt,
156 int direction);
157 bool GetColumn(int col, wxListItem& item);
158 int GetColumnWidth(int col);
159 int GetCountPerPage();
7bf85405
RD
160 wxImageList* GetImageList(int which);
161 long GetItemData(long item);
162
163 %addmethods {
e166644c 164 %new wxListItem* GetItem(long itemId, int col=0) {
7bf85405 165 wxListItem* info = new wxListItem;
0699c864 166 info->m_itemId = itemId;
e166644c 167 info->m_col = col;
7bf85405
RD
168 self->GetItem(*info);
169 return info;
170 }
171 %new wxPoint* GetItemPosition(long item) {
172 wxPoint* pos = new wxPoint;
173 self->GetItemPosition(item, *pos);
174 return pos;
175 }
176 %new wxRect* GetItemRect(long item, int code = wxLIST_RECT_BOUNDS) {
177 wxRect* rect= new wxRect;
178 self->GetItemRect(item, *rect, code);
179 return rect;
180 }
181 }
182
183 int GetItemState(long item, long stateMask);
184 int GetItemCount();
185 int GetItemSpacing(bool isSmall);
186 wxString GetItemText(long item);
187 long GetNextItem(long item,
188 int geometry = wxLIST_NEXT_ALL,
189 int state = wxLIST_STATE_DONTCARE);
190 int GetSelectedItemCount();
fb5e0af0 191#ifdef __WXMSW__
7bf85405 192 wxColour GetTextColour();
4f22cf8d 193 void SetTextColour(const wxColour& col);
fb5e0af0 194#endif
7bf85405
RD
195 long GetTopItem();
196 long HitTest(const wxPoint& point, int& OUTPUT);
0699c864 197 %name(InsertColumnWith)long InsertColumn(long col, wxListItem& info);
7bf85405
RD
198 long InsertColumn(long col, const wxString& heading,
199 int format = wxLIST_FORMAT_LEFT,
200 int width = -1);
201
202 long InsertItem(wxListItem& info);
203 %name(InsertStringItem) long InsertItem(long index, const wxString& label);
204 %name(InsertImageItem) long InsertItem(long index, int imageIndex);
205 %name(InsertImageStringItem)long InsertItem(long index, const wxString& label,
206 int imageIndex);
207
208 bool ScrollList(int dx, int dy);
209 void SetBackgroundColour(const wxColour& col);
210 bool SetColumn(int col, wxListItem& item);
211 bool SetColumnWidth(int col, int width);
212 void SetImageList(wxImageList* imageList, int which);
af309447 213
7bf85405 214 bool SetItem(wxListItem& info);
af309447 215 %name(SetStringItem)long SetItem(long index, int col, const wxString& label,
7bf85405 216 int imageId = -1);
af309447 217
7bf85405
RD
218 bool SetItemData(long item, long data);
219 bool SetItemImage(long item, int image, int selImage);
220 bool SetItemPosition(long item, const wxPoint& pos);
221 bool SetItemState(long item, long state, long stateMask);
222 void SetItemText(long item, const wxString& text);
223 void SetSingleStyle(long style, bool add = TRUE);
7bf85405
RD
224 void SetWindowStyleFlag(long style);
225 // TODO: bool SortItems(wxListCtrlCompare fn, long data);
226};
227
228
229
230//----------------------------------------------------------------------
231
232
d5c9047a
RD
233class wxTreeItemId {
234public:
235 wxTreeItemId();
236 ~wxTreeItemId();
bb0054cd 237 bool IsOk();
d5c9047a 238
d5c9047a
RD
239};
240
241
242
cf694132
RD
243%{
244class wxPyTreeItemData : public wxTreeItemData {
d5c9047a 245public:
cf694132
RD
246 wxPyTreeItemData(PyObject* obj = NULL) {
247 if (obj == NULL)
248 obj = Py_None;
249 Py_INCREF(obj);
250 m_obj = obj;
251 }
d5c9047a 252
cf694132 253 ~wxPyTreeItemData() {
1afc06c2 254 bool doSave = wxPyRestoreThread();
cf694132 255 Py_DECREF(m_obj);
1afc06c2 256 wxPySaveThread(doSave);
cf694132
RD
257 }
258
259 PyObject* GetData() {
260 Py_INCREF(m_obj);
261 return m_obj;
262 }
263
264 void SetData(PyObject* obj) {
265 Py_DECREF(m_obj);
266 m_obj = obj;
267 Py_INCREF(obj);
268 }
269
270 PyObject* m_obj;
d5c9047a 271};
cf694132 272%}
d5c9047a
RD
273
274
275
cf694132
RD
276%name(wxTreeItemData) class wxPyTreeItemData {
277public:
278 wxPyTreeItemData(PyObject* obj = NULL);
279
280 PyObject* GetData();
281 void SetData(PyObject* obj);
282
283 const wxTreeItemId& GetId();
284 void SetId(const wxTreeItemId& id);
285};
286
287
d5c9047a 288
8bf5d46e 289class wxTreeEvent : public wxNotifyEvent {
d5c9047a
RD
290public:
291 wxTreeItemId GetItem();
292 wxTreeItemId GetOldItem();
293 wxPoint GetPoint();
294 int GetCode();
8bf5d46e 295 const wxString& GetLabel();
d5c9047a
RD
296};
297
298
299// These are for the GetFirstChild/GetNextChild methods below
300%typemap(python, in) long& INOUT = long* INOUT;
301%typemap(python, argout) long& INOUT = long* INOUT;
302
303
304class wxTreeCtrl : public wxControl {
305public:
306 wxTreeCtrl(wxWindow *parent, wxWindowID id = -1,
307 const wxPoint& pos = wxPyDefaultPosition,
308 const wxSize& size = wxPyDefaultSize,
309 long style = wxTR_HAS_BUTTONS | wxTR_LINES_AT_ROOT,
310 const wxValidator& validator = wxPyDefaultValidator,
311 char* name = "wxTreeCtrl");
312
b8b8dda7 313 %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
d5c9047a
RD
314
315 size_t GetCount();
316 unsigned int GetIndent();
317 void SetIndent(unsigned int indent);
318 wxImageList *GetImageList();
319 wxImageList *GetStateImageList();
320 void SetImageList(wxImageList *imageList);
321 void SetStateImageList(wxImageList *imageList);
322
323 wxString GetItemText(const wxTreeItemId& item);
324 int GetItemImage(const wxTreeItemId& item);
325 int GetItemSelectedImage(const wxTreeItemId& item);
d5c9047a
RD
326
327 void SetItemText(const wxTreeItemId& item, const wxString& text);
328 void SetItemImage(const wxTreeItemId& item, int image);
329 void SetItemSelectedImage(const wxTreeItemId& item, int image);
08127323 330 void SetItemHasChildren(const wxTreeItemId& item, bool hasChildren = TRUE);
d5c9047a 331
cf694132
RD
332 %addmethods {
333 // [Get|Set]ItemData substitutes. Automatically create wxPyTreeItemData
334 // if needed.
335 wxPyTreeItemData* GetItemData(const wxTreeItemId& item) {
336 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
337 if (data == NULL) {
338 data = new wxPyTreeItemData();
339 self->SetItemData(item, data);
340 }
341 return data;
342 }
343
344 void SetItemData(const wxTreeItemId& item, wxPyTreeItemData* data) {
345 self->SetItemData(item, data);
346 }
347
348 // [Get|Set]PyData are short-cuts. Also made somewhat crash-proof by
349 // automatically creating data classes.
350 PyObject* GetPyData(const wxTreeItemId& item) {
351 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
352 if (data == NULL) {
353 data = new wxPyTreeItemData();
354 self->SetItemData(item, data);
355 }
356 return data->GetData();
357 }
358
359 void SetPyData(const wxTreeItemId& item, PyObject* obj) {
360 wxPyTreeItemData* data = (wxPyTreeItemData*)self->GetItemData(item);
361 if (data == NULL) {
362 data = new wxPyTreeItemData(obj);
363 self->SetItemData(item, data);
364 } else
365 data->SetData(obj);
366 }
367 }
368
369
d5c9047a
RD
370 bool IsVisible(const wxTreeItemId& item);
371 bool ItemHasChildren(const wxTreeItemId& item);
372 bool IsExpanded(const wxTreeItemId& item);
373 bool IsSelected(const wxTreeItemId& item);
374
375 wxTreeItemId GetRootItem();
376 wxTreeItemId GetSelection();
377 wxTreeItemId GetParent(const wxTreeItemId& item);
d426c97e
RD
378 //size_t GetSelections(wxArrayTreeItemIds& selection);
379 %addmethods {
380 PyObject* GetSelections() {
381 PyObject* rval = PyList_New(0);
382 wxArrayTreeItemIds array;
383 size_t num, x;
384 num = self->GetSelections(array);
385 for (x=0; x < num; x++) {
386 PyObject* item = wxPyConstructObject((void*)&array.Item(x),
387 "wxTreeItemId");
388 PyList_Append(rval, item);
389 }
390 return rval;
391 }
392 }
393
394
d5c9047a 395
bb0054cd
RD
396 size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = TRUE);
397
d5c9047a
RD
398 wxTreeItemId GetFirstChild(const wxTreeItemId& item, long& INOUT);
399 wxTreeItemId GetNextChild(const wxTreeItemId& item, long& INOUT);
400 wxTreeItemId GetNextSibling(const wxTreeItemId& item);
401 wxTreeItemId GetPrevSibling(const wxTreeItemId& item);
402 wxTreeItemId GetFirstVisibleItem();
403 wxTreeItemId GetNextVisible(const wxTreeItemId& item);
404 wxTreeItemId GetPrevVisible(const wxTreeItemId& item);
d426c97e
RD
405 wxTreeItemId GetLastChild(const wxTreeItemId& item);
406
d5c9047a
RD
407
408
409 wxTreeItemId AddRoot(const wxString& text,
410 int image = -1, int selectedImage = -1,
cf694132 411 wxPyTreeItemData *data = NULL);
d5c9047a
RD
412 wxTreeItemId PrependItem(const wxTreeItemId& parent,
413 const wxString& text,
414 int image = -1, int selectedImage = -1,
cf694132 415 wxPyTreeItemData *data = NULL);
d5c9047a
RD
416 wxTreeItemId InsertItem(const wxTreeItemId& parent,
417 const wxTreeItemId& idPrevious,
418 const wxString& text,
419 int image = -1, int selectedImage = -1,
cf694132 420 wxPyTreeItemData *data = NULL);
d5c9047a
RD
421 wxTreeItemId AppendItem(const wxTreeItemId& parent,
422 const wxString& text,
423 int image = -1, int selectedImage = -1,
cf694132 424 wxPyTreeItemData *data = NULL);
d5c9047a
RD
425
426 void Delete(const wxTreeItemId& item);
08127323 427 void DeleteChildren(const wxTreeItemId& item);
d5c9047a
RD
428 void DeleteAllItems();
429
430 void Expand(const wxTreeItemId& item);
431 void Collapse(const wxTreeItemId& item);
432 void CollapseAndReset(const wxTreeItemId& item);
433 void Toggle(const wxTreeItemId& item);
434
435 void Unselect();
8bf5d46e 436 void UnselectAll();
d5c9047a
RD
437 void SelectItem(const wxTreeItemId& item);
438 void EnsureVisible(const wxTreeItemId& item);
439 void ScrollTo(const wxTreeItemId& item);
8bf5d46e 440#ifdef __WXMSW__
d5c9047a 441 wxTextCtrl* EditLabel(const wxTreeItemId& item);
d5c9047a
RD
442 wxTextCtrl* GetEditControl();
443 void EndEditLabel(const wxTreeItemId& item, bool discardChanges = FALSE);
8bf5d46e
RD
444#else
445 void EditLabel(const wxTreeItemId& item);
446#endif
d5c9047a 447
d426c97e 448 void SortChildren(const wxTreeItemId& item);
d5c9047a 449
b8b8dda7
RD
450 void SetItemBold(const wxTreeItemId& item, bool bold = TRUE);
451 bool IsBold(const wxTreeItemId& item) const;
452 wxTreeItemId HitTest(const wxPoint& point);
c127177f 453
761a9d2b 454#ifdef __WXMSW__
d426c97e
RD
455 //bool GetBoundingRect(const wxTreeItemId& item, wxRect& rect, int textOnly = FALSE)
456 %addmethods {
457 PyObject* GetBoundingRect(const wxTreeItemId& item, int textOnly = FALSE) {
458 wxRect rect;
459 if (self->GetBoundingRect(item, rect, textOnly))
460 return wxPyConstructObject((void*)&rect, "wxRect");
461 else {
462 Py_INCREF(Py_None);
463 return Py_None;
464 }
465 }
466 }
761a9d2b 467#endif
d426c97e 468
c127177f
RD
469%pragma(python) addtoclass = "
470 # Redefine a couple methods that SWIG gets a bit confused on...
471 def GetFirstChild(self,arg0,arg1):
472 val1, val2 = controls2c.wxTreeCtrl_GetFirstChild(self.this,arg0.this,arg1)
473 val1 = wxTreeItemIdPtr(val1)
474 val1.thisown = 1
475 return (val1,val2)
476 def GetNextChild(self,arg0,arg1):
bb0054cd 477 val1, val2 = controls2c.wxTreeCtrl_GetNextChild(self.this,arg0.this,arg1)
c127177f
RD
478 val1 = wxTreeItemIdPtr(val1)
479 val1.thisown = 1
480 return (val1,val2)
481"
d5c9047a
RD
482};
483
d5c9047a 484
7bf85405
RD
485//----------------------------------------------------------------------
486
9c039d08 487#ifdef SKIPTHIS
fb5e0af0 488#ifdef __WXMSW__
7bf85405
RD
489class wxTabEvent : public wxCommandEvent {
490public:
491};
492
493
494
495class wxTabCtrl : public wxControl {
496public:
497 wxTabCtrl(wxWindow* parent, wxWindowID id,
498 const wxPoint& pos = wxPyDefaultPosition,
499 const wxSize& size = wxPyDefaultSize,
500 long style = 0,
501 char* name = "tabCtrl");
502
b8b8dda7 503 %pragma(python) addtomethod = "__init__:wx._StdWindowCallbacks(self)"
9c039d08 504
7bf85405
RD
505 bool DeleteAllItems();
506 bool DeleteItem(int item);
507 wxImageList* GetImageList();
508 int GetItemCount();
509 // TODO: void* GetItemData();
510 int GetItemImage(int item);
511
512 %addmethods {
513 %new wxRect* GetItemRect(int item) {
514 wxRect* rect = new wxRect;
515 self->GetItemRect(item, *rect);
516 return rect;
517 }
518 }
519
520 wxString GetItemText(int item);
521 bool GetRowCount();
522 int GetSelection();
523 int HitTest(const wxPoint& pt, long& OUTPUT);
524 void InsertItem(int item, const wxString& text,
525 int imageId = -1, void* clientData = NULL);
526 // TODO: bool SetItemData(int item, void* data);
527 bool SetItemImage(int item, int image);
528 void SetImageList(wxImageList* imageList);
529 void SetItemSize(const wxSize& size);
530 bool SetItemText(int item, const wxString& text);
531 void SetPadding(const wxSize& padding);
532 int SetSelection(int item);
533
534};
535
9c039d08 536#endif
fb5e0af0
RD
537#endif
538
7bf85405
RD
539//----------------------------------------------------------------------
540
541