1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface defs for wxNotebook and such
7 // Created: 2-June-1998
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
18 MAKE_CONST_WXSTRING(NotebookNameStr);
20 //---------------------------------------------------------------------------
34 wxBK_HITTEST_NOWHERE = 1, // not on tab
35 wxBK_HITTEST_ONICON = 2, // on icon
36 wxBK_HITTEST_ONLABEL = 4, // on label
37 wxBK_HITTEST_ONITEM = wxBK_HITTEST_ONICON | wxBK_HITTEST_ONLABEL,
38 wxBK_HITTEST_ONPAGE = 8, // not on tab control, but over the selected page
42 // TODO: Virtualize this class so other book controls can be derived in Python
44 MustHaveApp(wxBookCtrlBase);
46 // Common base class for wxList/Tree/Notebook
47 class wxBookCtrlBase : public wxControl
50 // This is an ABC, it can't be constructed...
52 // wxBookCtrlBase(wxWindow *parent,
54 // const wxPoint& pos = wxDefaultPosition,
55 // const wxSize& size = wxDefaultSize,
57 // const wxString& name = wxPyEmptyString);
58 // %RenameCtor(PreBookCtrlBase, wxBookCtrlBase());
59 // bool Create(wxWindow *parent,
61 // const wxPoint& pos = wxDefaultPosition,
62 // const wxSize& size = wxDefaultSize,
64 // const wxString& name = wxPyEmptyString);
67 // get number of pages in the dialog
68 virtual size_t GetPageCount() const;
70 // get the panel which represents the given page
71 virtual wxWindow *GetPage(size_t n);
73 // get the current page or NULL if none
74 wxWindow* GetCurrentPage() const;
76 // get the currently selected page or wxNOT_FOUND if none
77 virtual int GetSelection() const/* = 0*/;
79 // set/get the title of a page
80 virtual bool SetPageText(size_t n, const wxString& strText)/* = 0*/;
81 virtual wxString GetPageText(size_t n) const/* = 0*/;
84 // image list stuff: each page may have an image associated with it (all
85 // images belong to the same image list)
87 // sets the image list to use, it is *not* deleted by the control
88 virtual void SetImageList(wxImageList *imageList);
90 // as SetImageList() but we will delete the image list ourselves
91 %disownarg( wxImageList *imageList );
92 void AssignImageList(wxImageList *imageList);
93 %cleardisown( wxImageList *imageList );
95 // get pointer (may be NULL) to the associated image list
96 wxImageList* GetImageList() const;
98 // sets/returns item's image index in the current image list
99 virtual int GetPageImage(size_t n) const/* = 0*/;
100 virtual bool SetPageImage(size_t n, int imageId)/* = 0*/;
103 // resize the notebook so that all pages will have the specified size
104 virtual void SetPageSize(const wxSize& size);
106 // calculate the size of the control from the size of its page
107 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const/* = 0*/;
110 // get/set size of area between book control area and page area
111 unsigned int GetInternalBorder() const;
112 void SetInternalBorder(unsigned int internalBorder);
114 // returns true if we have wxCHB_TOP or wxCHB_BOTTOM style
115 bool IsVertical() const;
117 // Sets/gets the margin around the controller
118 void SetControlMargin(int margin);
119 int GetControlMargin() const;
121 // set/get option to shrink to fit current page
122 void SetFitToCurrentPage(bool fit);
123 bool GetFitToCurrentPage() const;
125 // returns the sizer containing the control, if any
126 wxSizer* GetControlSizer() const;
129 // remove one page from the control and delete it
130 virtual bool DeletePage(size_t n);
132 // remove one page from the notebook, without deleting it
133 virtual bool RemovePage(size_t n);
135 // remove all pages and delete them
136 virtual bool DeleteAllPages();
138 // adds a new page to the control
139 virtual bool AddPage(wxWindow *page,
140 const wxString& text,
144 // the same as AddPage(), but adds the page at the specified position
145 virtual bool InsertPage(size_t n,
147 const wxString& text,
149 int imageId = -1)/* = 0*/;
151 // set the currently selected page, return the index of the previously
152 // selected one (or -1 on error)
154 // NB: this function will _not_ generate PAGE_CHANGING/ED events
155 virtual int SetSelection(size_t n)/* = 0*/;
158 // cycle thru the pages
159 void AdvanceSelection(bool forward = true);
162 virtual int, HitTest(const wxPoint& pt, long* OUTPUT) const,
163 "HitTest(Point pt) -> (tab, where)",
164 "Returns the page/tab which is hit, and flags indicating where using
165 wx.NB_HITTEST flags.", "");
167 static wxVisualAttributes
168 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
170 %property(ControlMargin, GetControlMargin, SetControlMargin, doc="See `GetControlMargin` and `SetControlMargin`");
171 %property(ControlSizer, GetControlSizer, doc="See `GetControlSizer`");
172 %property(CurrentPage, GetCurrentPage, doc="See `GetCurrentPage`");
173 %property(FitToCurrentPage, GetFitToCurrentPage, SetFitToCurrentPage, doc="See `GetFitToCurrentPage` and `SetFitToCurrentPage`");
174 %property(ImageList, GetImageList, SetImageList, doc="See `GetImageList` and `SetImageList`");
175 %property(InternalBorder, GetInternalBorder, SetInternalBorder, doc="See `GetInternalBorder` and `SetInternalBorder`");
176 %property(Page, GetPage, doc="See `GetPage`");
177 %property(PageCount, GetPageCount, doc="See `GetPageCount`");
178 %property(PageImage, GetPageImage, SetPageImage, doc="See `GetPageImage` and `SetPageImage`");
179 %property(PageText, GetPageText, SetPageText, doc="See `GetPageText` and `SetPageText`");
180 %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
186 class wxBookCtrlBaseEvent : public wxNotifyEvent
189 wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
190 int nSel = -1, int nOldSel = -1);
192 // the currently selected page (-1 if none)
193 int GetSelection() const;
194 void SetSelection(int nSel);
195 // the page that was selected before the change (-1 if none)
196 int GetOldSelection() const;
197 void SetOldSelection(int nOldSel);
199 %property(OldSelection, GetOldSelection, SetOldSelection, doc="See `GetOldSelection` and `SetOldSelection`");
200 %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
206 //---------------------------------------------------------------------------
219 // for backwards compatibility only
220 wxNB_HITTEST_NOWHERE,
222 wxNB_HITTEST_ONLABEL,
229 MustHaveApp(wxNotebook);
231 class wxNotebook : public wxBookCtrlBase {
233 %pythonAppend wxNotebook "self._setOORInfo(self)"
234 %pythonAppend wxNotebook() ""
235 %typemap(out) wxNotebook*; // turn off this typemap
237 wxNotebook(wxWindow *parent,
239 const wxPoint& pos = wxDefaultPosition,
240 const wxSize& size = wxDefaultSize,
242 const wxString& name = wxPyNotebookNameStr);
243 %RenameCtor(PreNotebook, wxNotebook());
245 // Turn it back on again
246 %typemap(out) wxNotebook* { $result = wxPyMake_wxObject($1, $owner); }
248 bool Create(wxWindow *parent,
250 const wxPoint& pos = wxDefaultPosition,
251 const wxSize& size = wxDefaultSize,
253 const wxString& name = wxPyNotebookNameStr);
256 // get the number of rows for a control with wxNB_MULTILINE style (not all
257 // versions support it - they will always return 1 then)
258 virtual int GetRowCount() const;
260 // set the padding between tabs (in pixels)
261 virtual void SetPadding(const wxSize& padding);
263 // set the size of the tabs for wxNB_FIXEDWIDTH controls
264 virtual void SetTabSize(const wxSize& sz);
266 // implement some base class functions
267 virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
269 // On platforms that support it, get the theme page background colour,
270 // else invalid colour
271 wxColour GetThemeBackgroundColour() const;
273 static wxVisualAttributes
274 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
276 %property(RowCount, GetRowCount, doc="See `GetRowCount`");
277 %property(ThemeBackgroundColour, GetThemeBackgroundColour, doc="See `GetThemeBackgroundColour`");
282 class wxNotebookEvent : public wxBookCtrlBaseEvent
285 wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
286 int nSel = -1, int nOldSel = -1);
290 // notebook control event types
291 %constant wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED;
292 %constant wxEventType wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING;
297 EVT_NOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED, 1 )
298 EVT_NOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, 1 )
303 %#----------------------------------------------------------------------------
305 class NotebookPage(wx.Panel):
307 There is an old (and apparently unsolvable) bug when placing a
308 window with a nonstandard background colour in a wx.Notebook on
309 wxGTK1, as the notbooks's background colour would always be used
310 when the window is refreshed. The solution is to place a panel in
311 the notbook and the coloured window on the panel, sized to cover
312 the panel. This simple class does that for you, just put an
313 instance of this in the notebook and make your regular window a
314 child of this one and it will handle the resize for you.
316 def __init__(self, parent, id=-1,
317 pos=wx.DefaultPosition, size=wx.DefaultSize,
318 style=wx.TAB_TRAVERSAL, name="panel"):
319 wx.Panel.__init__(self, parent, id, pos, size, style, name)
321 self.Bind(wx.EVT_SIZE, self.OnSize)
323 def OnSize(self, evt):
324 if self.child is None:
325 children = self.GetChildren()
327 self.child = children[0]
329 self.child.SetPosition((0,0))
330 self.child.SetSize(self.GetSize())
334 //---------------------------------------------------------------------------
340 // default alignment: left everywhere except Mac where it is top
343 // put the list control to the left/right/top/bottom of the page area
349 // the mask which can be used to extract the alignment from the style
350 wxLB_ALIGN_MASK = 0xf,
355 MustHaveApp(wxListbook);
357 // wxListCtrl and wxNotebook combination
358 class wxListbook : public wxBookCtrlBase
361 %pythonAppend wxListbook "self._setOORInfo(self)"
362 %pythonAppend wxListbook() ""
364 wxListbook(wxWindow *parent,
366 const wxPoint& pos = wxDefaultPosition,
367 const wxSize& size = wxDefaultSize,
369 const wxString& name = wxPyEmptyString);
370 %RenameCtor(PreListbook, wxListbook());
372 bool Create(wxWindow *parent,
374 const wxPoint& pos = wxDefaultPosition,
375 const wxSize& size = wxDefaultSize,
377 const wxString& name = wxPyEmptyString);
379 wxListView* GetListView();
380 %property(ListView, GetListView, doc="See `GetListView`");
385 class wxListbookEvent : public wxBookCtrlBaseEvent
388 wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
389 int nSel = -1, int nOldSel = -1);
393 %constant wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED;
394 %constant wxEventType wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING;
397 EVT_LISTBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED, 1 )
398 EVT_LISTBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_LISTBOOK_PAGE_CHANGING, 1 )
402 //---------------------------------------------------------------------------
418 MustHaveApp(wxChoicebook);
420 class wxChoicebook : public wxBookCtrlBase
423 %pythonAppend wxChoicebook "self._setOORInfo(self)"
424 %pythonAppend wxChoicebook() ""
426 wxChoicebook(wxWindow *parent,
428 const wxPoint& pos = wxDefaultPosition,
429 const wxSize& size = wxDefaultSize,
431 const wxString& name = wxPyEmptyString);
432 %RenameCtor(PreChoicebook, wxChoicebook());
435 bool Create(wxWindow *parent,
437 const wxPoint& pos = wxDefaultPosition,
438 const wxSize& size = wxDefaultSize,
440 const wxString& name = wxPyEmptyString);
443 // returns the choice control
444 wxChoice* GetChoiceCtrl() const;
446 virtual bool DeleteAllPages();
448 %property(ChoiceCtrl, GetChoiceCtrl, doc="See `GetChoiceCtrl`");
453 class wxChoicebookEvent : public wxBookCtrlBaseEvent
456 wxChoicebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
457 int nSel = -1, int nOldSel = -1);
460 %constant wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED;
461 %constant wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING;
464 EVT_CHOICEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED, 1 )
465 EVT_CHOICEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, 1 )
468 //---------------------------------------------------------------------------
471 MustHaveApp(wxTreebook);
473 class wxTreebook : public wxBookCtrlBase
476 %pythonAppend wxTreebook "self._setOORInfo(self)"
477 %pythonAppend wxTreebook() ""
480 // This ctor creates the tree book control
481 wxTreebook(wxWindow *parent,
483 const wxPoint& pos = wxDefaultPosition,
484 const wxSize& size = wxDefaultSize,
485 long style = wxBK_DEFAULT,
486 const wxString& name = wxPyEmptyString);
488 %RenameCtor(PreTreebook, wxTreebook());
491 // Really creates the control
492 bool Create(wxWindow *parent,
494 const wxPoint& pos = wxDefaultPosition,
495 const wxSize& size = wxDefaultSize,
496 long style = wxBK_DEFAULT,
497 const wxString& name = wxPyEmptyString);
500 // Notice that page pointer may be NULL in which case the next non NULL
501 // page (usually the first child page of a node) is shown when this page is
504 // Inserts a new page just before the page indicated by page.
505 // The new page is placed on the same level as page.
506 virtual bool InsertPage(size_t pos,
508 const wxString& text,
510 int imageId = wxNOT_FOUND);
512 // Inserts a new sub-page to the end of children of the page at given pos.
513 virtual bool InsertSubPage(size_t pos,
515 const wxString& text,
517 int imageId = wxNOT_FOUND);
519 // Adds a new page at top level after all other pages.
520 virtual bool AddPage(wxWindow *page,
521 const wxString& text,
523 int imageId = wxNOT_FOUND);
525 // Adds a new child-page to the last top-level page inserted.
526 // Useful when constructing 1 level tree structure.
527 virtual bool AddSubPage(wxWindow *page,
528 const wxString& text,
530 int imageId = wxNOT_FOUND);
532 // Deletes the page and ALL its children. Could trigger page selection
533 // change in a case when selected page is removed. In that case its parent
534 // is selected (or the next page if no parent).
535 virtual bool DeletePage(size_t pos);
541 // Gets the page node state -- node is expanded or collapsed
542 virtual bool IsNodeExpanded(size_t pos) const;
544 // Expands or collapses the page node. Returns the previous state.
545 // May generate page changing events (if selected page
546 // is under the collapsed branch, then parent is autoselected).
547 virtual bool ExpandNode(size_t pos, bool expand = true);
549 // shortcut for ExpandNode(pos, false)
550 bool CollapseNode(size_t pos);
552 // get the parent page or wxNOT_FOUND if this is a top level page
553 int GetPageParent(size_t pos) const;
555 // the tree control we use for showing the pages index tree
556 wxPyTreeCtrl* GetTreeCtrl() const;
558 %property(TreeCtrl, GetTreeCtrl, doc="See `GetTreeCtrl`");
562 class wxTreebookEvent : public wxBookCtrlBaseEvent
565 wxTreebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
566 int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND);
569 %constant wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED;
570 %constant wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING;
571 %constant wxEventType wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED;
572 %constant wxEventType wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED;
576 EVT_TREEBOOK_PAGE_CHANGED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED, 1 )
577 EVT_TREEBOOK_PAGE_CHANGING= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING, 1)
578 EVT_TREEBOOK_NODE_COLLAPSED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED, 1 )
579 EVT_TREEBOOK_NODE_EXPANDED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED, 1 )
582 //---------------------------------------------------------------------------
585 MustHaveApp(wxTreebook);
587 class wxToolbook : public wxBookCtrlBase
590 %pythonAppend wxToolbook "self._setOORInfo(self)"
591 %pythonAppend wxToolbook() ""
594 // This ctor creates the tree book control
595 wxToolbook(wxWindow *parent,
597 const wxPoint& pos = wxDefaultPosition,
598 const wxSize& size = wxDefaultSize,
599 long style = wxBK_DEFAULT,
600 const wxString& name = wxPyEmptyString);
602 %RenameCtor(PreToolbook, wxToolbook());
605 bool Create(wxWindow *parent,
607 const wxPoint& pos = wxDefaultPosition,
608 const wxSize& size = wxDefaultSize,
610 const wxString& name = wxEmptyString);
613 wxToolBarBase* GetToolBar() const;
615 // Not part of the wxBookctrl API, but must be called in OnIdle or
616 // by application to realize the toolbar and select the initial page.
619 %property(ToolBar, GetToolBar, doc="See `GetToolBar`");
623 class wxToolbookEvent : public wxBookCtrlBaseEvent
626 wxToolbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
627 int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND);
631 %constant wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED;
632 %constant wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING;
636 EVT_TOOLBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED, 1)
637 EVT_TOOLBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING, 1)
640 //---------------------------------------------------------------------------