X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9804d5404a9607cda3d08ec8225f52f78b78bc72..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/include/wx/bookctrl.h diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h index 50b6dcdf13..50087a2526 100644 --- a/include/wx/bookctrl.h +++ b/include/wx/bookctrl.h @@ -22,10 +22,12 @@ #include "wx/control.h" #include "wx/dynarray.h" +#include "wx/withimages.h" WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages); -class WXDLLEXPORT wxImageList; +class WXDLLIMPEXP_FWD_CORE wxImageList; +class WXDLLIMPEXP_FWD_CORE wxBookCtrlEvent; // ---------------------------------------------------------------------------- // constants @@ -41,11 +43,20 @@ 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 wxWithImages { public: // construction @@ -76,9 +87,6 @@ public: long style = 0, const wxString& name = wxEmptyString); - // dtor - virtual ~wxBookCtrlBase(); - // accessors // --------- @@ -87,8 +95,7 @@ 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]; } + virtual wxWindow *GetPage(size_t n) const { return m_pages[n]; } // get the current page or NULL if none wxWindow *GetCurrentPage() const @@ -98,7 +105,7 @@ public: } // get the currently selected page or wxNOT_FOUND if none - virtual int GetSelection() const = 0; + virtual int GetSelection() const { return m_selection; } // set/get the title of a page virtual bool SetPageText(size_t n, const wxString& strText) = 0; @@ -109,15 +116,6 @@ public: // images belong to the same image list) // --------------------------------------------------------------------- - // sets the image list to use, it is *not* deleted by the control - virtual void SetImageList(wxImageList *imageList); - - // as SetImageList() but we will delete the image list ourselves - void AssignImageList(wxImageList *imageList); - - // get pointer (may be NULL) to the associated image list - wxImageList* GetImageList() const { return m_imageList; } - // sets/returns item's image index in the current image list virtual int GetPageImage(size_t n) const = 0; virtual bool SetPageImage(size_t n, int imageId) = 0; @@ -129,8 +127,14 @@ public: // resize the notebook so that all pages will have the specified size virtual void SetPageSize(const wxSize& size); + // return the size of the area needed to accommodate the controller + wxSize GetControllerSize() const; + // calculate the size of the control from the size of its page - virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const = 0; + // + // by default this simply returns size enough to fit both the page and the + // controller + virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const; // get/set size of area between book control area and page area unsigned int GetInternalBorder() const { return m_internalBorder; } @@ -150,6 +154,7 @@ public: // returns the sizer containing the control, if any wxSizer* GetControlSizer() const { return m_controlSizer; } + // operations // ---------- @@ -159,14 +164,15 @@ 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(); + m_selection = wxNOT_FOUND; + DoInvalidateBestSize(); WX_CLEAR_ARRAY(m_pages); return true; } @@ -175,9 +181,9 @@ public: virtual bool AddPage(wxWindow *page, const wxString& text, bool bSelect = false, - int imageId = -1) + int imageId = NO_IMAGE) { - InvalidateBestSize(); + DoInvalidateBestSize(); return InsertPage(GetPageCount(), page, text, bSelect, imageId); } @@ -186,20 +192,23 @@ public: wxWindow *page, const wxString& text, bool bSelect = false, - int imageId = -1) = 0; + int imageId = NO_IMAGE) = 0; // set the currently selected page, return the index of the previously - // selected one (or -1 on error) + // selected one (or wxNOT_FOUND on error) // // NB: this function will 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) { int nPage = GetNextPage(forward); - if ( nPage != -1 ) + if ( nPage != wxNOT_FOUND ) { // cast is safe because of the check above SetSelection((size_t)nPage); @@ -213,7 +222,61 @@ public: return wxNOT_FOUND; } + + // 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 + { + SetSelection_SendEvent = 1 + }; + + // choose the default border for this window + virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; } + + // After the insertion of the page in the method InsertPage, calling this + // method sets the selection to the given page or the first one if there is + // still no selection. The "selection changed" event is sent only if + // bSelect is true, so when it is false, no event is sent even if the + // selection changed from wxNOT_FOUND to 0 when inserting the first page. + // + // Returns true if the selection was set to the specified page (explicitly + // because of bSelect == true or implicitly because it's the first page) or + // false otherwise. + bool DoSetSelectionAfterInsertion(size_t n, bool bSelect); + + // 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 + virtual int DoSetSelection(size_t nPage, int flags = 0); + + // if the derived class uses DoSetSelection() for implementing + // [Set|Change]Selection, it must override UpdateSelectedPage(), + // CreatePageChangingEvent() and MakeChangedEvent(), but as it might not + // use it, these functions are not pure virtual + + // called to notify the control about a new current page + virtual void UpdateSelectedPage(size_t WXUNUSED(newsel)) + { wxFAIL_MSG(wxT("Override this function!")); } + + // create a new "page changing" event + 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(wxBookCtrlEvent& WXUNUSED(event)) + { wxFAIL_MSG(wxT("Override this function!")); } + + // Should we accept NULL page pointers in Add/InsertPage()? // // Default is no but derived classes may override it if they can treat NULL @@ -230,11 +293,13 @@ 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(); + virtual 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 @@ -245,17 +310,10 @@ protected: // the array of all pages of this control wxArrayPages m_pages; - // the associated image list or NULL - wxImageList *m_imageList; - - // true if we must delete m_imageList - bool m_ownsImageList; - // get the page area - wxRect GetPageRect() const; + virtual wxRect GetPageRect() const; // event handlers - virtual wxSize GetControllerSize() const; void OnSize(wxSizeEvent& event); // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook) @@ -265,10 +323,15 @@ 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; + + // The currently selected page (in range 0..m_pages.size()-1 inclusive) or + // wxNOT_FOUND if none (this can normally only be the case for an empty + // control without any pages). + int m_selection; private: @@ -279,51 +342,63 @@ private: unsigned int m_internalBorder; DECLARE_ABSTRACT_CLASS(wxBookCtrlBase) - DECLARE_NO_COPY_CLASS(wxBookCtrlBase) + wxDECLARE_NO_COPY_CLASS(wxBookCtrlBase); + DECLARE_EVENT_TABLE() }; // ---------------------------------------------------------------------------- -// 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, - int nSel = -1, int nOldSel = -1) + wxBookCtrlEvent(wxEventType commandType = wxEVT_NULL, int winid = 0, + int nSel = wxNOT_FOUND, int nOldSel = wxNOT_FOUND) : wxNotifyEvent(commandType, winid) { m_nSel = nSel; 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) + // the currently selected page (wxNOT_FOUND if none) int GetSelection() const { return m_nSel; } void SetSelection(int nSel) { m_nSel = nSel; } - // the page that was selected before the change (-1 if none) + // the page that was selected before the change (wxNOT_FOUND if none) int GetOldSelection() const { return m_nOldSel; } void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; } 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) @@ -332,7 +407,6 @@ private: // 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)