Don't mention non-existent setup.exe in wxMSW installation notes.

[wxWidgets.git] / include / wx / bookctrl.h

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index 85d769d71ae392e31ffec88662acb1cfbffe124f..66704cb9a1df0cda14bb4c24e4de12c07c8acc3f 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -25,8 +25,8 @@
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 

-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxBookCtrlBaseEvent;
+class WXDLLIMPEXP_FWD_CORE wxImageList;
+class WXDLLIMPEXP_FWD_CORE wxBookCtrlEvent;

 
 // ----------------------------------------------------------------------------
 // constants
 
 // ----------------------------------------------------------------------------
 // constants


@@ -42,11 +42,19 @@ enum
     wxBK_HITTEST_ONPAGE  = 8    // not on tab control, but over the selected page
 };
 
     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
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // wxBookCtrlBase
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxBookCtrlBase : public wxControl
+class WXDLLIMPEXP_CORE wxBookCtrlBase : public wxControl

 {
 public:
     // construction
 {
 public:
     // construction


@@ -88,7 +96,6 @@ public:
     virtual size_t GetPageCount() const { return m_pages.size(); }
 
     // get the panel which represents the given page
     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
     wxWindow *GetPage(size_t n) const { return m_pages[n]; }
 
     // get the current page or NULL if none


@@ -130,8 +137,14 @@ public:
     // resize the notebook so that all pages will have the specified size
     virtual void SetPageSize(const wxSize& size);
 
     // 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
     // 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; }
 
     // get/set size of area between book control area and page area
     unsigned int GetInternalBorder() const { return m_internalBorder; }


@@ -151,6 +164,7 @@ public:
     // returns the sizer containing the control, if any
     wxSizer* GetControlSizer() const { return m_controlSizer; }
 
     // returns the sizer containing the control, if any
     wxSizer* GetControlSizer() const { return m_controlSizer; }
 

+

     // operations
     // ----------
 
     // operations
     // ----------
 


@@ -160,14 +174,14 @@ public:
     // remove one page from the notebook, without deleting it
     virtual bool RemovePage(size_t n)
     {
     // 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()
     {
         return DoRemovePage(n) != NULL;
     }
 
     // remove all pages and delete them
     virtual bool DeleteAllPages()
     {

-        InvalidateBestSize();
+        DoInvalidateBestSize();

         WX_CLEAR_ARRAY(m_pages);
         return true;
     }
         WX_CLEAR_ARRAY(m_pages);
         return true;
     }


@@ -178,7 +192,7 @@ public:
                          bool bSelect = false,
                          int imageId = -1)
     {
                          bool bSelect = false,
                          int imageId = -1)
     {

-        InvalidateBestSize();
+        DoInvalidateBestSize();

         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
     }
 
         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
     }
 


@@ -221,23 +235,46 @@ public:
     // we do have multiple pages
     virtual bool HasMultiplePages() const { return true; }
 
     // 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:
 protected:

-    // typically, wxBookCtrl-derived classes will use DoSetSelection() function
-    // to implement SetSelection() and ChangeSelection() functions.
-    // these flags make DoSetSelection() more readable
+    // flags for DoSetSelection()

     enum
     {
         SetSelection_SendEvent = 1
     };
 
     enum
     {
         SetSelection_SendEvent = 1
     };
 

-    // if using DoSetSelection() for implementing [Set|Change]Selection,
-    // then override UpdateSelectedPage() and MakeChangedEvent()
-    virtual int DoSetSelection(size_t nPage, int flags, wxBookCtrlBaseEvent &event);
+    // 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
+    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!")); }
     virtual void UpdateSelectedPage(size_t WXUNUSED(newsel))
         { wxFAIL_MSG(wxT("Override this function!")); }

-    virtual void MakeChangedEvent(wxBookCtrlBaseEvent &WXUNUSED(event))
+
+    // 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!")); }
 
         { 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
     // Should we accept NULL page pointers in Add/InsertPage()?
     //
     // Default is no but derived classes may override it if they can treat NULL


@@ -254,11 +291,13 @@ protected:
     // helper: get the next page wrapping if we reached the end
     int GetNextPage(bool forward) const;
 
     // 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
     // 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
 
 #if wxUSE_HELP
     // Show the help for the corresponding page


@@ -276,10 +315,9 @@ protected:
     bool m_ownsImageList;
 
     // get the page area
     bool m_ownsImageList;
 
     // get the page area

-    wxRect GetPageRect() const;
+    virtual wxRect GetPageRect() const;

 
     // event handlers
 
     // event handlers

-    virtual wxSize GetControllerSize() const;

     void OnSize(wxSizeEvent& event);
 
     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)
     void OnSize(wxSizeEvent& event);
 
     // controller buddy if available, NULL otherwise (usually for native book controls like wxNotebook)


@@ -289,10 +327,10 @@ protected:
     bool m_fitToCurrentPage;
 
     // the sizer containing the choice control
     bool m_fitToCurrentPage;
 
     // the sizer containing the choice control

-    wxSizer*    m_controlSizer;
+    wxSizer *m_controlSizer;

 
     // the margin around the choice control
 
     // the margin around the choice control

-    int         m_controlMargin;
+    int m_controlMargin;

 
 private:
 
 
 private:
 


@@ -303,18 +341,18 @@ private:
     unsigned int m_internalBorder;
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)
     unsigned int m_internalBorder;
 
     DECLARE_ABSTRACT_CLASS(wxBookCtrlBase)

-    DECLARE_NO_COPY_CLASS(wxBookCtrlBase)
+    wxDECLARE_NO_COPY_CLASS(wxBookCtrlBase);

     DECLARE_EVENT_TABLE()
 };
 
 // ----------------------------------------------------------------------------
     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:
 {
 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)
     {
                         int nSel = -1, int nOldSel = -1)
         : wxNotifyEvent(commandType, winid)
     {


@@ -322,13 +360,15 @@ public:
         m_nOldSel = nOldSel;
     }
 
         m_nOldSel = nOldSel;
     }
 

-    wxBookCtrlBaseEvent(const wxBookCtrlBaseEvent& event)
+    wxBookCtrlEvent(const wxBookCtrlEvent& event)

         : wxNotifyEvent(event)
     {
         m_nSel = event.m_nSel;
         m_nOldSel = event.m_nOldSel;
     }
 
         : 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; }
     // accessors
         // the currently selected page (-1 if none)
     int GetSelection() const { return m_nSel; }


@@ -340,29 +380,35 @@ public:
 private:
     int m_nSel,     // currently selected page
         m_nOldSel;  // previously selected page
 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
 // 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 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
 #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 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
 #endif
 
 #if WXWIN_COMPATIBILITY_2_6