add wxDataViewIconText

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

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index 85d769d71ae392e31ffec88662acb1cfbffe124f..15dd227715d3cf27ac11c4e4d1867c0af3073728 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 wxBookCtrlBaseEvent;

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


@@ -42,6 +42,14 @@ 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
 // ----------------------------------------------------------------------------


@@ -151,6 +159,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 +169,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 +187,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 +230,43 @@ 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);
+    // 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 wxBookCtrlBaseEvent* 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))

         { 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,12 +283,14 @@ 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
     void DoSize();
 
     // 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);
 #if wxUSE_HELP
     // Show the help for the corresponding page
     void OnHelp(wxHelpEvent& event);


@@ -289,10 +320,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: