]> git.saurik.com Git - wxWidgets.git/blame - wxPython/contrib/gizmos/gizmos.i
Added wx.lib.delayedresult from Oliver Schoenborn.
[wxWidgets.git] / wxPython / contrib / gizmos / gizmos.i
CommitLineData
ebf4302c
RD
1/////////////////////////////////////////////////////////////////////////////
2// Name: gizmos.i
3// Purpose: Wrappers for the "gizmo" classes in wx/contrib
4//
5// Author: Robin Dunn
6//
7// Created: 23-Nov-2001
8// RCS-ID: $Id$
9// Copyright: (c) 2001 by Total Control Software
10// Licence: wxWindows license
11/////////////////////////////////////////////////////////////////////////////
12
c8fac2b6
RD
13%define DOCSTRING
14"Various *gizmo* classes: `DynamicSashWindow`, `EditableListBox`,
15`LEDNumberCtrl`, `TreeListCtrl`, etc."
16%enddef
17
b2eb030f 18%module(package="wx", docstring=DOCSTRING) gizmos
ebf4302c
RD
19
20
21%{
d14a1e28
RD
22#include "wx/wxPython/wxPython.h"
23#include "wx/wxPython/pyclasses.h"
28eab81f 24
611dc22c
RD
25#include <wx/gizmos/dynamicsash.h>
26#include <wx/gizmos/editlbox.h>
27#include <wx/gizmos/splittree.h>
950e7faf 28#include <wx/gizmos/ledctrl.h>
7e4b7f9a 29#include <wx/gizmos/statpict.h>
1fded56b 30
7c379a20 31#include <wx/listctrl.h>
1fded56b
RD
32#include <wx/treectrl.h>
33#include <wx/imaglist.h>
28eab81f 34
137b5242
RD
35%}
36
d14a1e28
RD
37//---------------------------------------------------------------------------
38
39%import windows.i
40%import controls.i
648d396c
RD
41%pythoncode { import wx }
42%pythoncode { __docfilter__ = wx._core.__DocFilter(globals()) }
d14a1e28 43
b2dc1044 44
089142a5
RD
45MAKE_CONST_WXSTRING2(DynamicSashNameStr, wxT("dynamicSashWindow"));
46MAKE_CONST_WXSTRING2(EditableListBoxNameStr, wxT("editableListBox"));
d3397f6a 47MAKE_CONST_WXSTRING(StaticPictureNameStr);
7e4b7f9a 48
b2dc1044
RD
49MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
50
d14a1e28 51//---------------------------------------------------------------------------
137b5242 52
ebf4302c 53enum {
ebf4302c
RD
54 wxDS_MANAGE_SCROLLBARS,
55 wxDS_DRAG_CORNER,
56};
57
6c56259a
RD
58%constant wxEventType wxEVT_DYNAMIC_SASH_SPLIT;
59%constant wxEventType wxEVT_DYNAMIC_SASH_UNIFY;
60
ebf4302c
RD
61
62/*
63 wxDynamicSashSplitEvents are sent to your view by wxDynamicSashWindow
64 whenever your view is being split by the user. It is your
65 responsibility to handle this event by creating a new view window as
66 a child of the wxDynamicSashWindow. wxDynamicSashWindow will
67 automatically reparent it to the proper place in its window hierarchy.
68*/
69class wxDynamicSashSplitEvent : public wxCommandEvent {
70public:
71 wxDynamicSashSplitEvent(wxObject *target);
72};
73
74
75/*
76 wxDynamicSashUnifyEvents are sent to your view by wxDynamicSashWindow
77 whenever the sash which splits your view and its sibling is being
78 reunified such that your view is expanding to replace its sibling.
79 You needn't do anything with this event if you are allowing
80 wxDynamicSashWindow to manage your view's scrollbars, but it is useful
81 if you are managing the scrollbars yourself so that you can keep
82 the scrollbars' event handlers connected to your view's event handler
83 class.
84*/
85class wxDynamicSashUnifyEvent : public wxCommandEvent {
86public:
87 wxDynamicSashUnifyEvent(wxObject *target);
88};
89
90
91
92/*
93
94 wxDynamicSashWindow
95
96 wxDynamicSashWindow widgets manages the way other widgets are viewed.
97 When a wxDynamicSashWindow is first shown, it will contain one child
98 view, a viewport for that child, and a pair of scrollbars to allow the
99 user to navigate the child view area. Next to each scrollbar is a small
100 tab. By clicking on either tab and dragging to the appropriate spot, a
101 user can split the view area into two smaller views separated by a
102 draggable sash. Later, when the user wishes to reunify the two subviews,
103 the user simply drags the sash to the side of the window.
104 wxDynamicSashWindow will automatically reparent the appropriate child
105 view back up the window hierarchy, and the wxDynamicSashWindow will have
106 only one child view once again.
107
108 As an application developer, you will simply create a wxDynamicSashWindow
109 using either the Create() function or the more complex constructor
611dc22c 110 provided below, and then create a view window whose parent is the
ebf4302c
RD
111 wxDynamicSashWindow. The child should respond to
112 wxDynamicSashSplitEvents -- perhaps with an OnSplit() event handler -- by
113 constructing a new view window whose parent is also the
114 wxDynamicSashWindow. That's it! Now your users can dynamically split
115 and reunify the view you provided.
116
117 If you wish to handle the scrollbar events for your view, rather than
118 allowing wxDynamicSashWindow to do it for you, things are a bit more
119 complex. (You might want to handle scrollbar events yourself, if,
120 for instance, you wish to scroll a subwindow of the view you add to
121 your wxDynamicSashWindow object, rather than scrolling the whole view.)
611dc22c 122 In this case, you will need to construct your wxDynamicSashWindow without
ebf4302c
RD
123 the wxDS_MANAGE_SCROLLBARS style and you will need to use the
124 GetHScrollBar() and GetVScrollBar() methods to retrieve the scrollbar
125 controls and call SetEventHanler() on them to redirect the scrolling
126 events whenever your window is reparented by wxDyanmicSashWindow.
127 You will need to set the scrollbars' event handler at three times:
128
129 * When your view is created
130 * When your view receives a wxDynamicSashSplitEvent
131 * When your view receives a wxDynamicSashUnifyEvent
132
133 See the dynsash_switch sample application for an example which does this.
134
135*/
136
ab1f7d2a
RD
137MustHaveApp(wxDynamicSashWindow);
138
ebf4302c
RD
139class wxDynamicSashWindow : public wxWindow {
140public:
2b9048c5
RD
141 %pythonAppend wxDynamicSashWindow "self._setOORInfo(self)"
142 %pythonAppend wxDynamicSashWindow() ""
d14a1e28 143
d5573410 144 wxDynamicSashWindow(wxWindow *parent, wxWindowID id=-1,
ebf4302c
RD
145 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
146 long style = wxCLIP_CHILDREN | wxDS_MANAGE_SCROLLBARS | wxDS_DRAG_CORNER,
137b5242 147 const wxString& name = wxPyDynamicSashNameStr);
1b8c7ba6 148 %RenameCtor(PreDynamicSashWindow, wxDynamicSashWindow());
ebf4302c 149
d5573410 150 bool Create(wxWindow *parent, wxWindowID id=-1,
ebf4302c
RD
151 const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
152 long style = wxCLIP_CHILDREN | wxDS_MANAGE_SCROLLBARS | wxDS_DRAG_CORNER,
137b5242 153 const wxString& name = wxPyDynamicSashNameStr);
ebf4302c 154
ebf4302c
RD
155 wxScrollBar *GetHScrollBar(const wxWindow *child) const;
156 wxScrollBar *GetVScrollBar(const wxWindow *child) const;
157};
158
159
160
d14a1e28
RD
161%pythoncode {
162EVT_DYNAMIC_SASH_SPLIT = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_SPLIT, 1 )
163EVT_DYNAMIC_SASH_UNIFY = wx.PyEventBinder( wxEVT_DYNAMIC_SASH_UNIFY, 1 )
164}
ebf4302c 165
d14a1e28
RD
166//---------------------------------------------------------------------------
167//---------------------------------------------------------------------------
7b7ac0ab 168
6187ec8f
RD
169enum {
170 wxEL_ALLOW_NEW,
171 wxEL_ALLOW_EDIT,
172 wxEL_ALLOW_DELETE,
173};
7b7ac0ab
RD
174
175// This class provides a composite control that lets the
176// user easily enter list of strings
ab1f7d2a 177MustHaveApp(wxEditableListBox);
7b7ac0ab
RD
178class wxEditableListBox : public wxPanel
179{
180public:
2b9048c5
RD
181 %pythonAppend wxEditableListBox "self._setOORInfo(self)"
182 %pythonAppend wxEditableListBox() ""
d14a1e28 183
d5573410
RD
184 wxEditableListBox(wxWindow *parent, wxWindowID id=-1,
185 const wxString& label = wxPyEmptyString,
7b7ac0ab
RD
186 const wxPoint& pos = wxDefaultPosition,
187 const wxSize& size = wxDefaultSize,
6187ec8f 188 long style = wxEL_ALLOW_NEW | wxEL_ALLOW_EDIT | wxEL_ALLOW_DELETE,
137b5242 189 const wxString& name = wxPyEditableListBoxNameStr);
7b7ac0ab 190
611dc22c 191
7b7ac0ab
RD
192 void SetStrings(const wxArrayString& strings);
193
194 //void GetStrings(wxArrayString& strings);
d14a1e28 195 %extend {
7b7ac0ab
RD
196 PyObject* GetStrings() {
197 wxArrayString strings;
198 self->GetStrings(strings);
199 return wxArrayString2PyList_helper(strings);
200 }
201 }
366d7bd6 202
15f80007 203 wxPyListCtrl* GetListCtrl();
d14a1e28
RD
204 wxBitmapButton* GetDelButton();
205 wxBitmapButton* GetNewButton();
206 wxBitmapButton* GetUpButton();
207 wxBitmapButton* GetDownButton();
208 wxBitmapButton* GetEditButton();
7b7ac0ab
RD
209};
210
211
212
d14a1e28 213//---------------------------------------------------------------------------
611dc22c
RD
214
215
216/*
217 * wxRemotelyScrolledTreeCtrl
218 *
219 * This tree control disables its vertical scrollbar and catches scroll
220 * events passed by a scrolled window higher in the hierarchy.
221 * It also updates the scrolled window vertical scrollbar as appropriate.
222 */
223
224%{
225 typedef wxTreeCtrl wxPyTreeCtrl;
226%}
227
ab1f7d2a
RD
228MustHaveApp(wxRemotelyScrolledTreeCtrl);
229
611dc22c
RD
230class wxRemotelyScrolledTreeCtrl: public wxPyTreeCtrl
231{
232public:
2b9048c5
RD
233 %pythonAppend wxRemotelyScrolledTreeCtrl "self._setOORInfo(self)"
234 %pythonAppend wxRemotelyScrolledTreeCtrl() ""
d14a1e28 235
611dc22c
RD
236 wxRemotelyScrolledTreeCtrl(wxWindow* parent, wxWindowID id,
237 const wxPoint& pos = wxDefaultPosition,
238 const wxSize& size = wxDefaultSize,
239 long style = wxTR_HAS_BUTTONS);
611dc22c
RD
240
241
242 void HideVScrollbar();
243
244 // Adjust the containing wxScrolledWindow's scrollbars appropriately
245 void AdjustRemoteScrollbars();
246
247 // Find the scrolled window that contains this control
248 wxScrolledWindow* GetScrolledWindow() const;
249
250 // Scroll to the given line (in scroll units where each unit is
251 // the height of an item)
252 void ScrollToLine(int posHoriz, int posVert);
253
254 // The companion window is one which will get notified when certain
255 // events happen such as node expansion
256 void SetCompanionWindow(wxWindow* companion);
257 wxWindow* GetCompanionWindow() const;
258};
259
260
261
262/*
263 * wxTreeCompanionWindow
264 *
265 * A window displaying values associated with tree control items.
266 */
267
268%{
269class wxPyTreeCompanionWindow: public wxTreeCompanionWindow
270{
271public:
272 wxPyTreeCompanionWindow(wxWindow* parent, wxWindowID id = -1,
273 const wxPoint& pos = wxDefaultPosition,
274 const wxSize& size = wxDefaultSize,
275 long style = 0)
276 : wxTreeCompanionWindow(parent, id, pos, size, style) {}
277
278
279 virtual void DrawItem(wxDC& dc, wxTreeItemId id, const wxRect& rect) {
280 bool found;
6e6b3557 281 wxPyBlock_t blocked = wxPyBeginBlockThreads();
611dc22c 282 if ((found = wxPyCBH_findCallback(m_myInst, "DrawItem"))) {
6d450e1a 283 PyObject* dcobj = wxPyMake_wxObject(&dc,false);
a72f4631
RD
284 PyObject* idobj = wxPyConstructObject((void*)&id, wxT("wxTreeItemId"), false);
285 PyObject* recobj= wxPyConstructObject((void*)&rect, wxT("wxRect"), false);
611dc22c
RD
286 wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OOO)", dcobj, idobj, recobj));
287 Py_DECREF(dcobj);
288 Py_DECREF(idobj);
289 Py_DECREF(recobj);
290 }
da32eb53 291 wxPyEndBlockThreads(blocked);
611dc22c
RD
292 if (! found)
293 wxTreeCompanionWindow::DrawItem(dc, id, rect);
294 }
295
296 PYPRIVATE;
297};
298%}
299
300
ab1f7d2a
RD
301MustHaveApp(wxPyTreeCompanionWindow);
302
1b8c7ba6
RD
303%rename(TreeCompanionWindow) wxPyTreeCompanionWindow;
304class wxPyTreeCompanionWindow: public wxWindow
611dc22c
RD
305{
306public:
2b9048c5
RD
307 %pythonAppend wxPyTreeCompanionWindow "self._setOORInfo(self);self._setCallbackInfo(self, TreeCompanionWindow)"
308 %pythonAppend wxPyTreeCompanionWindow() ""
d14a1e28 309
611dc22c
RD
310 wxPyTreeCompanionWindow(wxWindow* parent, wxWindowID id = -1,
311 const wxPoint& pos = wxDefaultPosition,
312 const wxSize& size = wxDefaultSize,
313 long style = 0);
314 void _setCallbackInfo(PyObject* self, PyObject* _class);
611dc22c
RD
315
316 wxRemotelyScrolledTreeCtrl* GetTreeCtrl() const;
317 void SetTreeCtrl(wxRemotelyScrolledTreeCtrl* treeCtrl);
318};
319
320
321
322/*
323 * wxThinSplitterWindow
324 *
325 * Implements a splitter with a less obvious sash
326 * than the usual one.
327 */
328
ab1f7d2a
RD
329MustHaveApp(wxThinSplitterWindow);
330
611dc22c
RD
331class wxThinSplitterWindow: public wxSplitterWindow
332{
333public:
2b9048c5
RD
334 %pythonAppend wxThinSplitterWindow "self._setOORInfo(self)"
335 %pythonAppend wxThinSplitterWindow() ""
d14a1e28 336
611dc22c
RD
337 wxThinSplitterWindow(wxWindow* parent, wxWindowID id = -1,
338 const wxPoint& pos = wxDefaultPosition,
339 const wxSize& size = wxDefaultSize,
340 long style = wxSP_3D | wxCLIP_CHILDREN);
611dc22c
RD
341};
342
343
d14a1e28 344
611dc22c
RD
345/*
346 * wxSplitterScrolledWindow
347 *
348 * This scrolled window is aware of the fact that one of its
349 * children is a splitter window. It passes on its scroll events
350 * (after some processing) to both splitter children for them
351 * scroll appropriately.
352 */
353
ab1f7d2a
RD
354MustHaveApp(wxSplitterScrolledWindow);
355
611dc22c
RD
356class wxSplitterScrolledWindow: public wxScrolledWindow
357{
358public:
2b9048c5
RD
359 %pythonAppend wxSplitterScrolledWindow "self._setOORInfo(self)"
360 %pythonAppend wxSplitterScrolledWindow() ""
d14a1e28 361
611dc22c
RD
362 wxSplitterScrolledWindow(wxWindow* parent, wxWindowID id = -1,
363 const wxPoint& pos = wxDefaultPosition,
364 const wxSize& size = wxDefaultSize,
365 long style = 0);
611dc22c
RD
366};
367
368
d14a1e28
RD
369//---------------------------------------------------------------------------
370//---------------------------------------------------------------------------
950e7faf
RD
371
372
373enum wxLEDValueAlign
374{
375 wxLED_ALIGN_LEFT,
376 wxLED_ALIGN_RIGHT,
377 wxLED_ALIGN_CENTER,
378
379 wxLED_ALIGN_MASK,
380
381 wxLED_DRAW_FADED,
382};
383
384
ab1f7d2a
RD
385MustHaveApp(wxLEDNumberCtrl);
386
950e7faf
RD
387class wxLEDNumberCtrl : public wxControl
388{
389public:
2b9048c5
RD
390 %pythonAppend wxLEDNumberCtrl "self._setOORInfo(self)"
391 %pythonAppend wxLEDNumberCtrl() ""
d14a1e28 392
950e7faf
RD
393 wxLEDNumberCtrl(wxWindow *parent, wxWindowID id = -1,
394 const wxPoint& pos = wxDefaultPosition,
395 const wxSize& size = wxDefaultSize,
396 long style = wxLED_ALIGN_LEFT | wxLED_DRAW_FADED);
1b8c7ba6 397 %RenameCtor(PreLEDNumberCtrl, wxLEDNumberCtrl());
950e7faf 398
950e7faf
RD
399 bool Create(wxWindow *parent, wxWindowID id = -1,
400 const wxPoint& pos = wxDefaultPosition,
401 const wxSize& size = wxDefaultSize,
402 long style = wxLED_ALIGN_LEFT | wxLED_DRAW_FADED);
403
d14a1e28
RD
404 wxLEDValueAlign GetAlignment() const;
405 bool GetDrawFaded() const;
406 const wxString &GetValue() const;
950e7faf
RD
407
408 void SetAlignment(wxLEDValueAlign Alignment, bool Redraw = true);
409 void SetDrawFaded(bool DrawFaded, bool Redraw = true);
410 void SetValue(const wxString &Value, bool Redraw = true);
411
412};
413
1fded56b
RD
414
415
33328cd8 416//----------------------------------------------------------------------
1fded56b 417
33328cd8 418%include _treelist.i
1fded56b 419
7e4b7f9a
RD
420//----------------------------------------------------------------------
421
422enum
423{
424 wxSCALE_HORIZONTAL,
425 wxSCALE_VERTICAL,
426 wxSCALE_UNIFORM,
427 wxSCALE_CUSTOM
428};
429
430MustHaveApp(wxStaticPicture);
431
432class wxStaticPicture : public wxControl
433{
434public:
435 %pythonAppend wxStaticPicture "self._setOORInfo(self)"
436 %pythonAppend wxStaticPicture() ""
437
d3397f6a
RD
438 wxStaticPicture( wxWindow* parent, wxWindowID id=-1,
439 const wxBitmap& label=wxNullBitmap,
7e4b7f9a
RD
440 const wxPoint& pos = wxDefaultPosition,
441 const wxSize& size = wxDefaultSize,
442 long style = 0,
443 const wxString& name = wxPyStaticPictureNameStr );
444
445 %RenameCtor(PreStaticPicture, wxStaticPicture());
446
d3397f6a
RD
447 bool Create( wxWindow* parent, wxWindowID id=-1,
448 const wxBitmap& label=wxNullBitmap,
7e4b7f9a
RD
449 const wxPoint& pos = wxDefaultPosition,
450 const wxSize& size = wxDefaultSize,
451 long style = 0,
452 const wxString& name = wxPyStaticPictureNameStr );
453
454 void SetBitmap( const wxBitmap& bmp );
455 wxBitmap GetBitmap() const;
456 void SetIcon( const wxIcon& icon );
457 wxIcon GetIcon() const;
1fded56b 458
7e4b7f9a
RD
459 void SetAlignment( int align );
460 int GetAlignment() const;
461
462 void SetScale( int scale );
463 int GetScale() const;
464
465 void SetCustomScale( float sx, float sy );
466 void GetCustomScale( float* OUTPUT, float* OUTPUT ) const;
467
468};
1fded56b
RD
469
470
950e7faf 471//----------------------------------------------------------------------
ebf4302c
RD
472//----------------------------------------------------------------------
473
474%init %{
611dc22c 475 wxPyPtrTypeMap_Add("wxTreeCompanionWindow", "wxPyTreeCompanionWindow");
ebf4302c
RD
476%}
477
ebf4302c
RD
478//----------------------------------------------------------------------
479//----------------------------------------------------------------------
480