X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/deb325e3b21d956705214520b172ae8bf898a1ae..51c9c13c05b3aa6e713b7bcfcc027e7ece75541c:/include/wx/bookctrl.h diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h index 8d5a2a3072..9085595d68 100644 --- a/include/wx/bookctrl.h +++ b/include/wx/bookctrl.h @@ -25,8 +25,8 @@ WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages); -class WXDLLEXPORT wxImageList; -class WXDLLEXPORT wxBookCtrlBaseEvent; +class WXDLLIMPEXP_FWD_CORE wxImageList; +class WXDLLIMPEXP_FWD_CORE wxBookCtrlEvent; // ---------------------------------------------------------------------------- // constants @@ -42,11 +42,19 @@ enum wxBK_HITTEST_ONPAGE = 8 // not on tab control, but over the selected page }; +// wxBookCtrl flags (common for wxNotebook, wxListbook, wxChoicebook, wxTreebook) +#define wxBK_DEFAULT 0x0000 +#define wxBK_TOP 0x0010 +#define wxBK_BOTTOM 0x0020 +#define wxBK_LEFT 0x0040 +#define wxBK_RIGHT 0x0080 +#define wxBK_ALIGN_MASK (wxBK_TOP | wxBK_BOTTOM | wxBK_LEFT | wxBK_RIGHT) + // ---------------------------------------------------------------------------- // wxBookCtrlBase // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxBookCtrlBase : public wxControl +class WXDLLIMPEXP_CORE wxBookCtrlBase : public wxControl { public: // construction @@ -88,7 +96,6 @@ public: virtual size_t GetPageCount() const { return m_pages.size(); } // get the panel which represents the given page - wxWindow *GetPage(size_t n) { return m_pages[n]; } wxWindow *GetPage(size_t n) const { return m_pages[n]; } // get the current page or NULL if none @@ -151,6 +158,7 @@ public: // returns the sizer containing the control, if any wxSizer* GetControlSizer() const { return m_controlSizer; } + // operations // ---------- @@ -160,14 +168,14 @@ public: // remove one page from the notebook, without deleting it virtual bool RemovePage(size_t n) { - InvalidateBestSize(); + DoInvalidateBestSize(); return DoRemovePage(n) != NULL; } // remove all pages and delete them virtual bool DeleteAllPages() { - InvalidateBestSize(); + DoInvalidateBestSize(); WX_CLEAR_ARRAY(m_pages); return true; } @@ -178,7 +186,7 @@ public: bool bSelect = false, int imageId = -1) { - InvalidateBestSize(); + DoInvalidateBestSize(); return InsertPage(GetPageCount(), page, text, bSelect, imageId); } @@ -221,6 +229,12 @@ public: // we do have multiple pages virtual bool HasMultiplePages() const { return true; } + // we don't want focus for ourselves + virtual bool AcceptsFocus() const { return false; } + + // returns true if the platform should explicitly apply a theme border + virtual bool CanApplyThemeBorder() const { return false; } + protected: // flags for DoSetSelection() enum @@ -228,6 +242,9 @@ protected: SetSelection_SendEvent = 1 }; + // choose the default border for this window + virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } + // set the selection to the given page, sending the events (which can // possibly prevent the page change from taking place) if SendEvent flag is // included @@ -243,12 +260,12 @@ protected: { wxFAIL_MSG(wxT("Override this function!")); } // create a new "page changing" event - virtual wxBookCtrlBaseEvent* CreatePageChangingEvent() const + virtual wxBookCtrlEvent* CreatePageChangingEvent() const { wxFAIL_MSG(wxT("Override this function!")); return NULL; } // modify the event created by CreatePageChangingEvent() to "page changed" // event, usually by just calling SetEventType() on it - virtual void MakeChangedEvent(wxBookCtrlBaseEvent& WXUNUSED(event)) + virtual void MakeChangedEvent(wxBookCtrlEvent& WXUNUSED(event)) { wxFAIL_MSG(wxT("Override this function!")); } @@ -268,12 +285,14 @@ protected: // helper: get the next page wrapping if we reached the end int GetNextPage(bool forward) const; - // Always rely on GetBestSize, which will look at all the pages - virtual void SetInitialBestSize(const wxSize& WXUNUSED(size)) { } - // Lay out controls void DoSize(); + // This method also invalidates the size of the controller and should be + // called instead of just InvalidateBestSize() whenever pages are added or + // removed as this also affects the controller + void DoInvalidateBestSize(); + #if wxUSE_HELP // Show the help for the corresponding page void OnHelp(wxHelpEvent& event); @@ -303,10 +322,10 @@ protected: bool m_fitToCurrentPage; // the sizer containing the choice control - wxSizer* m_controlSizer; + wxSizer *m_controlSizer; // the margin around the choice control - int m_controlMargin; + int m_controlMargin; private: @@ -322,13 +341,13 @@ private: }; // ---------------------------------------------------------------------------- -// wxBookCtrlBaseEvent: page changing events generated by derived classes +// wxBookCtrlEvent: page changing events generated by book classes // ---------------------------------------------------------------------------- -class WXDLLEXPORT wxBookCtrlBaseEvent : public wxNotifyEvent +class WXDLLIMPEXP_CORE wxBookCtrlEvent : public wxNotifyEvent { public: - wxBookCtrlBaseEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, + wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, int nSel = -1, int nOldSel = -1) : wxNotifyEvent(commandType, winid) { @@ -336,13 +355,15 @@ public: m_nOldSel = nOldSel; } - wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event) + wxBookCtrlEvent(const wxBookCtrlEvent& event) : wxNotifyEvent(event) { m_nSel = event.m_nSel; m_nOldSel = event.m_nOldSel; } + virtual wxEvent *Clone() const { return new wxBookCtrlEvent(*this); } + // accessors // the currently selected page (-1 if none) int GetSelection() const { return m_nSel; } @@ -354,29 +375,35 @@ public: private: int m_nSel, // currently selected page m_nOldSel; // previously selected page + + DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxBookCtrlEvent) }; +typedef void (wxEvtHandler::*wxBookCtrlEventFunction)(wxBookCtrlEvent&); + +#define wxBookCtrlEventHandler(func) \ + wxEVENT_HANDLER_CAST(wxBookCtrlEventFunction, func) + +// obsolete name, defined for compatibility only +#define wxBookCtrlBaseEvent wxBookCtrlEvent + // make a default book control for given platform #if wxUSE_NOTEBOOK // dedicated to majority of desktops #include "wx/notebook.h" #define wxBookCtrl wxNotebook - #define wxBookCtrlEvent wxNotebookEvent #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn) EVT_NOTEBOOK_PAGE_CHANGED(id, fn) #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn) EVT_NOTEBOOK_PAGE_CHANGING(id, fn) - #define wxBookctrlEventHandler(func) wxNotebookEventHandler(func) #else // dedicated to Smartphones #include "wx/choicebk.h" #define wxBookCtrl wxChoicebook - #define wxBookCtrlEvent wxChoicebookEvent #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING #define EVT_BOOKCTRL_PAGE_CHANGED(id, fn) EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) #define EVT_BOOKCTRL_PAGE_CHANGING(id, fn) EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) - #define wxBookctrlEventHandler(func) wxChoicebookEventHandler(func) #endif #if WXWIN_COMPATIBILITY_2_6