//---------------------------------------------------------------------------
-%{
- DECLARE_DEF_STRING(NOTEBOOK_NAME);
-%}
+MAKE_CONST_WXSTRING(NotebookNameStr);
//---------------------------------------------------------------------------
%newgroup
+
+enum {
+ wxBK_DEFAULT,
+ wxBK_TOP,
+ wxBK_BOTTOM,
+ wxBK_LEFT,
+ wxBK_RIGHT,
+ wxBK_ALIGN_MASK,
+ wxBK_BUTTONBAR,
+
+ // hittest flags
+ wxBK_HITTEST_NOWHERE = 1, // not on tab
+ wxBK_HITTEST_ONICON = 2, // on icon
+ wxBK_HITTEST_ONLABEL = 4, // on label
+ wxBK_HITTEST_ONITEM = wxBK_HITTEST_ONICON | wxBK_HITTEST_ONLABEL,
+ wxBK_HITTEST_ONPAGE = 8, // not on tab control, but over the selected page
+};
+
+
// TODO: Virtualize this class so other book controls can be derived in Python
+MustHaveApp(wxBookCtrlBase);
+
// Common base class for wxList/Tree/Notebook
-class wxBookCtrl : public wxControl
+class wxBookCtrlBase : public wxControl
{
public:
// This is an ABC, it can't be constructed...
-// wxBookCtrl(wxWindow *parent,
+// wxBookCtrlBase(wxWindow *parent,
// wxWindowID id,
// const wxPoint& pos = wxDefaultPosition,
// const wxSize& size = wxDefaultSize,
// long style = 0,
// const wxString& name = wxPyEmptyString);
-// %name(PreBookCtrl)wxBookCtrl();
+// %RenameCtor(PreBookCtrlBase, wxBookCtrlBase());
// bool Create(wxWindow *parent,
// wxWindowID id,
// const wxPoint& pos = wxDefaultPosition,
// get the panel which represents the given page
virtual wxWindow *GetPage(size_t n);
+ // get the current page or NULL if none
+ wxWindow* GetCurrentPage() const;
+
// get the currently selected page or wxNOT_FOUND if none
virtual int GetSelection() const/* = 0*/;
virtual void SetImageList(wxImageList *imageList);
// as SetImageList() but we will delete the image list ourselves
- %addtofunc AssignImageList "args[1].thisown = 0"
+ %disownarg( wxImageList *imageList );
void AssignImageList(wxImageList *imageList);
+ %cleardisown( wxImageList *imageList );
// get pointer (may be NULL) to the associated image list
wxImageList* GetImageList() const;
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const/* = 0*/;
+ // get/set size of area between book control area and page area
+ unsigned int GetInternalBorder() const;
+ void SetInternalBorder(unsigned int internalBorder);
+
+ // returns true if we have wxCHB_TOP or wxCHB_BOTTOM style
+ bool IsVertical() const;
+
+ // Sets/gets the margin around the controller
+ void SetControlMargin(int margin);
+ int GetControlMargin() const;
+
+ // set/get option to shrink to fit current page
+ void SetFitToCurrentPage(bool fit);
+ bool GetFitToCurrentPage() const;
+
+ // returns the sizer containing the control, if any
+ wxSizer* GetControlSizer() const;
+
// remove one page from the control and delete it
virtual bool DeletePage(size_t n);
// adds a new page to the control
virtual bool AddPage(wxWindow *page,
const wxString& text,
- bool select = False,
+ bool select = false,
int imageId = -1);
// the same as AddPage(), but adds the page at the specified position
virtual bool InsertPage(size_t n,
wxWindow *page,
const wxString& text,
- bool select = False,
+ bool select = false,
int imageId = -1)/* = 0*/;
// set the currently selected page, return the index of the previously
// NB: this function will _not_ generate PAGE_CHANGING/ED events
virtual int SetSelection(size_t n)/* = 0*/;
+
+ // acts as SetSelection but does not generate events
+ virtual int ChangeSelection(size_t n)/* = 0*/;
// cycle thru the pages
- void AdvanceSelection(bool forward = True);
+ void AdvanceSelection(bool forward = true);
+
+ DocDeclAStr(
+ virtual int, HitTest(const wxPoint& pt, long* OUTPUT) const,
+ "HitTest(Point pt) -> (tab, where)",
+ "Returns the page/tab which is hit, and flags indicating where using
+wx.NB_HITTEST flags.", "");
+
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+ %property(ControlMargin, GetControlMargin, SetControlMargin, doc="See `GetControlMargin` and `SetControlMargin`");
+ %property(ControlSizer, GetControlSizer, doc="See `GetControlSizer`");
+ %property(CurrentPage, GetCurrentPage, doc="See `GetCurrentPage`");
+ %property(FitToCurrentPage, GetFitToCurrentPage, SetFitToCurrentPage, doc="See `GetFitToCurrentPage` and `SetFitToCurrentPage`");
+ %property(ImageList, GetImageList, SetImageList, doc="See `GetImageList` and `SetImageList`");
+ %property(InternalBorder, GetInternalBorder, SetInternalBorder, doc="See `GetInternalBorder` and `SetInternalBorder`");
+ %property(Page, GetPage, doc="See `GetPage`");
+ %property(PageCount, GetPageCount, doc="See `GetPageCount`");
+ %property(PageImage, GetPageImage, SetPageImage, doc="See `GetPageImage` and `SetPageImage`");
+ %property(PageText, GetPageText, SetPageText, doc="See `GetPageText` and `SetPageText`");
+ %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
+
};
-class wxBookCtrlEvent : public wxNotifyEvent
+class wxBookCtrlBaseEvent : public wxNotifyEvent
{
public:
- wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+ wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
int nSel = -1, int nOldSel = -1);
// the currently selected page (-1 if none)
// the page that was selected before the change (-1 if none)
int GetOldSelection() const;
void SetOldSelection(int nOldSel);
+
+ %property(OldSelection, GetOldSelection, SetOldSelection, doc="See `GetOldSelection` and `SetOldSelection`");
+ %property(Selection, GetSelection, SetSelection, doc="See `GetSelection` and `SetSelection`");
+
};
wxNB_RIGHT,
wxNB_BOTTOM,
wxNB_MULTILINE,
-
- // hittest flags
- wxNB_HITTEST_NOWHERE = 1, // not on tab
- wxNB_HITTEST_ONICON = 2, // on icon
- wxNB_HITTEST_ONLABEL = 4, // on label
- wxNB_HITTEST_ONITEM = wxNB_HITTEST_ONICON | wxNB_HITTEST_ONLABEL,
-
+ wxNB_NOPAGETHEME,
+
+ // for backwards compatibility only
+ wxNB_HITTEST_NOWHERE,
+ wxNB_HITTEST_ONICON,
+ wxNB_HITTEST_ONLABEL,
+ wxNB_HITTEST_ONITEM,
+ wxNB_HITTEST_ONPAGE,
};
-class wxNotebook : public wxBookCtrl {
+MustHaveApp(wxNotebook);
+
+class wxNotebook : public wxBookCtrlBase {
public:
- %addtofunc wxNotebook "self._setOORInfo(self)"
- %addtofunc wxNotebook() ""
+ %pythonAppend wxNotebook "self._setOORInfo(self)"
+ %pythonAppend wxNotebook() ""
+ %typemap(out) wxNotebook*; // turn off this typemap
wxNotebook(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = wxPyNOTEBOOK_NAME);
- %name(PreNotebook)wxNotebook();
+ const wxString& name = wxPyNotebookNameStr);
+ %RenameCtor(PreNotebook, wxNotebook());
+
+ // Turn it back on again
+ %typemap(out) wxNotebook* { $result = wxPyMake_wxObject($1, $owner); }
bool Create(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
- const wxString& name = wxPyNOTEBOOK_NAME);
+ const wxString& name = wxPyNotebookNameStr);
// get the number of rows for a control with wxNB_MULTILINE style (not all
// set the size of the tabs for wxNB_FIXEDWIDTH controls
virtual void SetTabSize(const wxSize& sz);
- // hit test, returns which tab is hit and, optionally, where (icon, label)
- // (not implemented on all platforms)
- virtual int HitTest(const wxPoint& pt, long* OUTPUT) const;
-
// implement some base class functions
virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
-#ifdef __WXMSW__
- // Windows only: attempts to apply the UX theme page background to this page
- void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
-#endif
+ // On platforms that support it, get the theme page background colour,
+ // else invalid colour
+ wxColour GetThemeBackgroundColour() const;
+
+ static wxVisualAttributes
+ GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+ // returns false if the change to nPage is vetoed by the program
+ bool SendPageChangingEvent(int nPage);
+
+ // sends the event about page change from old to new (or GetSelection() if
+ // new is -1)
+ void SendPageChangedEvent(int nPageOld, int nPageNew = -1);
+
+ %property(RowCount, GetRowCount, doc="See `GetRowCount`");
+ %property(ThemeBackgroundColour, GetThemeBackgroundColour, doc="See `GetThemeBackgroundColour`");
};
-class wxNotebookEvent : public wxBookCtrlEvent
+class wxNotebookEvent : public wxBookCtrlBaseEvent
{
public:
wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
class NotebookPage(wx.Panel):
"""
There is an old (and apparently unsolvable) bug when placing a
- window with a nonstandard background colour in a wxNotebook on
- wxGTK, as the notbooks's background colour would always be used
+ window with a nonstandard background colour in a wx.Notebook on
+ wxGTK1, as the notbooks's background colour would always be used
when the window is refreshed. The solution is to place a panel in
the notbook and the coloured window on the panel, sized to cover
the panel. This simple class does that for you, just put an
style=wx.TAB_TRAVERSAL, name="panel"):
wx.Panel.__init__(self, parent, id, pos, size, style, name)
self.child = None
- EVT_SIZE(self, self.OnSize)
-
+ self.Bind(wx.EVT_SIZE, self.OnSize)
+
def OnSize(self, evt):
if self.child is None:
children = self.GetChildren()
+MustHaveApp(wxListbook);
+
// wxListCtrl and wxNotebook combination
-class wxListbook : public wxBookCtrl
+class wxListbook : public wxBookCtrlBase
{
public:
- %addtofunc wxListbook "self._setOORInfo(self)"
- %addtofunc wxListbook() ""
+ %pythonAppend wxListbook "self._setOORInfo(self)"
+ %pythonAppend wxListbook() ""
wxListbook(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxPyEmptyString);
- %name(PreListbook)wxListbook();
+ %RenameCtor(PreListbook, wxListbook());
bool Create(wxWindow *parent,
- wxWindowID id,
+ wxWindowID id=-1,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
long style = 0,
const wxString& name = wxPyEmptyString);
- // returns True if we have wxLB_TOP or wxLB_BOTTOM style
- bool IsVertical() const;
-
+ wxListView* GetListView();
+ %property(ListView, GetListView, doc="See `GetListView`");
};
-class wxListbookEvent : public wxBookCtrlEvent
+class wxListbookEvent : public wxBookCtrlBaseEvent
{
public:
wxListbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
}
+//---------------------------------------------------------------------------
+
+
+/*
+ * wxChoicebook flags
+ */
+enum {
+ wxCHB_DEFAULT,
+ wxCHB_TOP,
+ wxCHB_BOTTOM,
+ wxCHB_LEFT,
+ wxCHB_RIGHT,
+ wxCHB_ALIGN_MASK
+};
+
+
+MustHaveApp(wxChoicebook);
+
+class wxChoicebook : public wxBookCtrlBase
+{
+public:
+ %pythonAppend wxChoicebook "self._setOORInfo(self)"
+ %pythonAppend wxChoicebook() ""
+
+ wxChoicebook(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxPyEmptyString);
+ %RenameCtor(PreChoicebook, wxChoicebook());
+
+ // quasi ctor
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxPyEmptyString);
+
+
+ // returns the choice control
+ wxChoice* GetChoiceCtrl() const;
+
+ virtual bool DeleteAllPages();
+
+ %property(ChoiceCtrl, GetChoiceCtrl, doc="See `GetChoiceCtrl`");
+
+};
+
+
+class wxChoicebookEvent : public wxBookCtrlBaseEvent
+{
+public:
+ wxChoicebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+ int nSel = -1, int nOldSel = -1);
+};
+
+%constant wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED;
+%constant wxEventType wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING;
+
+%pythoncode {
+ EVT_CHOICEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED, 1 )
+ EVT_CHOICEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING, 1 )
+}
+
//---------------------------------------------------------------------------
%newgroup;
+MustHaveApp(wxTreebook);
-class wxBookCtrlSizer: public wxSizer
+class wxTreebook : public wxBookCtrlBase
{
public:
- %addtofunc wxBookCtrlSizer "self._setOORInfo(self)"
+ %pythonAppend wxTreebook "self._setOORInfo(self)"
+ %pythonAppend wxTreebook() ""
- wxBookCtrlSizer( wxBookCtrl *nb );
-
- void RecalcSizes();
- wxSize CalcMin();
- wxBookCtrl *GetControl();
+
+ // This ctor creates the tree book control
+ wxTreebook(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxBK_DEFAULT,
+ const wxString& name = wxPyEmptyString);
+
+ %RenameCtor(PreTreebook, wxTreebook());
+
+
+ // Really creates the control
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxBK_DEFAULT,
+ const wxString& name = wxPyEmptyString);
+
+
+ // Notice that page pointer may be NULL in which case the next non NULL
+ // page (usually the first child page of a node) is shown when this page is
+ // selected
+
+ // Inserts a new page just before the page indicated by page.
+ // The new page is placed on the same level as page.
+ virtual bool InsertPage(size_t pos,
+ wxWindow *page,
+ const wxString& text,
+ bool select = false,
+ int imageId = wxNOT_FOUND);
+
+ // Inserts a new sub-page to the end of children of the page at given pos.
+ virtual bool InsertSubPage(size_t pos,
+ wxWindow *page,
+ const wxString& text,
+ bool select = false,
+ int imageId = wxNOT_FOUND);
+
+ // Adds a new page at top level after all other pages.
+ virtual bool AddPage(wxWindow *page,
+ const wxString& text,
+ bool select = false,
+ int imageId = wxNOT_FOUND);
+
+ // Adds a new child-page to the last top-level page inserted.
+ // Useful when constructing 1 level tree structure.
+ virtual bool AddSubPage(wxWindow *page,
+ const wxString& text,
+ bool select = false,
+ int imageId = wxNOT_FOUND);
+
+ // Deletes the page and ALL its children. Could trigger page selection
+ // change in a case when selected page is removed. In that case its parent
+ // is selected (or the next page if no parent).
+ virtual bool DeletePage(size_t pos);
+
+
+ // Tree operations
+ // ---------------
+
+ // Gets the page node state -- node is expanded or collapsed
+ virtual bool IsNodeExpanded(size_t pos) const;
+
+ // Expands or collapses the page node. Returns the previous state.
+ // May generate page changing events (if selected page
+ // is under the collapsed branch, then parent is autoselected).
+ virtual bool ExpandNode(size_t pos, bool expand = true);
+
+ // shortcut for ExpandNode(pos, false)
+ bool CollapseNode(size_t pos);
+
+ // get the parent page or wxNOT_FOUND if this is a top level page
+ int GetPageParent(size_t pos) const;
+
+ // the tree control we use for showing the pages index tree
+ wxPyTreeCtrl* GetTreeCtrl() const;
+
+ %property(TreeCtrl, GetTreeCtrl, doc="See `GetTreeCtrl`");
};
-class wxNotebookSizer: public wxSizer {
+class wxTreebookEvent : public wxBookCtrlBaseEvent
+{
public:
- %addtofunc wxNotebookSizer "self._setOORInfo(self)"
+ wxTreebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+ int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND);
+};
- wxNotebookSizer( wxNotebook *nb );
-
- void RecalcSizes();
- wxSize CalcMin();
- wxNotebook *GetNotebook();
+%constant wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED;
+%constant wxEventType wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING;
+%constant wxEventType wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED;
+%constant wxEventType wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED;
+
+
+%pythoncode {
+ EVT_TREEBOOK_PAGE_CHANGED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED, 1 )
+ EVT_TREEBOOK_PAGE_CHANGING= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_PAGE_CHANGING, 1)
+ EVT_TREEBOOK_NODE_COLLAPSED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_COLLAPSED, 1 )
+ EVT_TREEBOOK_NODE_EXPANDED= wx.PyEventBinder( wxEVT_COMMAND_TREEBOOK_NODE_EXPANDED, 1 )
+}
+
+//---------------------------------------------------------------------------
+%newgroup;
+
+MustHaveApp(wxTreebook);
+
+class wxToolbook : public wxBookCtrlBase
+{
+public:
+ %pythonAppend wxToolbook "self._setOORInfo(self)"
+ %pythonAppend wxToolbook() ""
+
+
+ // This ctor creates the tree book control
+ wxToolbook(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxBK_DEFAULT,
+ const wxString& name = wxPyEmptyString);
+
+ %RenameCtor(PreToolbook, wxToolbook());
+
+ // quasi ctor
+ bool Create(wxWindow *parent,
+ wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = 0,
+ const wxString& name = wxEmptyString);
+
+
+ wxToolBarBase* GetToolBar() const;
+
+ // Not part of the wxBookctrl API, but must be called in OnIdle or
+ // by application to realize the toolbar and select the initial page.
+ void Realize();
+
+ %property(ToolBar, GetToolBar, doc="See `GetToolBar`");
+};
+
+
+class wxToolbookEvent : public wxBookCtrlBaseEvent
+{
+public:
+ wxToolbookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
+ int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND);
};
+
+%constant wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED;
+%constant wxEventType wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING;
+
+
+%pythoncode {
+ EVT_TOOLBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED, 1)
+ EVT_TOOLBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGING, 1)
+}
+
//---------------------------------------------------------------------------
projects / wxWidgets.git / blobdiff