Applied rowspan patch #15276 (dghart)

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

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index 86a89acfd13c2b634cbcd136049da14382625a6f..324fd94ca1509503fd3d23287052fda10c256458 100644 (file)
--- a/include/wx/bookctrl.h
+++ b/include/wx/bookctrl.h
@@ -22,6 +22,7 @@
 
 #include "wx/control.h"
 #include "wx/dynarray.h"
 
 #include "wx/control.h"
 #include "wx/dynarray.h"

+#include "wx/withimages.h"

 
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 
 
 WX_DEFINE_EXPORTED_ARRAY_PTR(wxWindow *, wxArrayPages);
 


@@ -54,7 +55,8 @@ enum
 // wxBookCtrlBase
 // ----------------------------------------------------------------------------
 
 // wxBookCtrlBase
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxBookCtrlBase : public wxControl
+class WXDLLIMPEXP_CORE wxBookCtrlBase : public wxControl,
+                                        public wxWithImages

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


@@ -85,9 +87,6 @@ public:
                 long style = 0,
                 const wxString& name = wxEmptyString);
 
                 long style = 0,
                 const wxString& name = wxEmptyString);
 

-    // dtor
-    virtual ~wxBookCtrlBase();
-

 
     // accessors
     // ---------
 
     // accessors
     // ---------


@@ -96,7 +95,7 @@ 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) 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
 
     // get the current page or NULL if none
     wxWindow *GetCurrentPage() const


@@ -106,7 +105,7 @@ public:
     }
 
     // get the currently selected page or wxNOT_FOUND if none
     }
 
     // get the currently selected page or wxNOT_FOUND if none

-    int GetSelection() const { return m_selection; }
+    virtual int GetSelection() const { return m_selection; }

 
     // set/get the title of a page
     virtual bool SetPageText(size_t n, const wxString& strText) = 0;
 
     // set/get the title of a page
     virtual bool SetPageText(size_t n, const wxString& strText) = 0;


@@ -117,15 +116,6 @@ public:
     // images belong to the same image list)
     // ---------------------------------------------------------------------
 
     // 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;
     // 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;


@@ -191,7 +181,7 @@ public:
     virtual bool AddPage(wxWindow *page,
                          const wxString& text,
                          bool bSelect = false,
     virtual bool AddPage(wxWindow *page,
                          const wxString& text,
                          bool bSelect = false,

-                         int imageId = -1)
+                         int imageId = NO_IMAGE)

     {
         DoInvalidateBestSize();
         return InsertPage(GetPageCount(), page, text, bSelect, imageId);
     {
         DoInvalidateBestSize();
         return InsertPage(GetPageCount(), page, text, bSelect, imageId);


@@ -202,7 +192,7 @@ public:
                             wxWindow *page,
                             const wxString& text,
                             bool bSelect = false,
                             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 wxNOT_FOUND on error)
 
     // set the currently selected page, return the index of the previously
     // selected one (or wxNOT_FOUND on error)


@@ -225,6 +215,9 @@ public:
         }
     }
 
         }
     }
 

+    // return the index of the given page or wxNOT_FOUND
+    int FindPage(const wxWindow* page) const;
+

     // hit test: returns which page is hit and, optionally, where (icon, label)
     virtual int HitTest(const wxPoint& WXUNUSED(pt),
                         long * WXUNUSED(flags) = NULL) const
     // hit test: returns which page is hit and, optionally, where (icon, label)
     virtual int HitTest(const wxPoint& WXUNUSED(pt),
                         long * WXUNUSED(flags) = NULL) const


@@ -263,6 +256,10 @@ protected:
     // false otherwise.
     bool DoSetSelectionAfterInsertion(size_t n, bool bSelect);
 
     // false otherwise.
     bool DoSetSelectionAfterInsertion(size_t n, bool bSelect);
 

+    // Update the selection after removing the page at the given index,
+    // typically called from the derived class overridden DoRemovePage().
+    void DoSetSelectionAfterRemoval(size_t n);
+

     // 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
     // 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


@@ -287,6 +284,11 @@ protected:
         { wxFAIL_MSG(wxT("Override this function!")); }
 
 
         { wxFAIL_MSG(wxT("Override this function!")); }
 
 

+    // The derived class also may override the following method, also called
+    // from DoSetSelection(), to show/hide pages differently.
+    virtual void DoShowPage(wxWindow* page, bool show) { page->Show(show); }
+
+

     // 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


@@ -294,7 +296,11 @@ protected:
     // having nodes without any associated page)
     virtual bool AllowNullPage() const { return false; }
 
     // having nodes without any associated page)
     virtual bool AllowNullPage() const { return false; }
 

-    // remove the page and return a pointer to it
+    // Remove the page and return a pointer to it.
+    //
+    // It also needs to update the current selection if necessary, i.e. if the
+    // page being removed comes before the selected one and the helper method
+    // DoSetSelectionAfterRemoval() can be used for this.

     virtual wxWindow *DoRemovePage(size_t page) = 0;
 
     // our best size is the size which fits all our pages
     virtual wxWindow *DoRemovePage(size_t page) = 0;
 
     // our best size is the size which fits all our pages


@@ -320,12 +326,6 @@ protected:
     // the array of all pages of this control
     wxArrayPages m_pages;
 
     // 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
     virtual wxRect GetPageRect() const;
 
     // get the page area
     virtual wxRect GetPageRect() const;
 


@@ -415,20 +415,24 @@ typedef void (wxEvtHandler::*wxBookCtrlEventFunction)(wxBookCtrlEvent&);
     // dedicated to majority of desktops
     #include "wx/notebook.h"
     #define wxBookCtrl                             wxNotebook
     // dedicated to majority of desktops
     #include "wx/notebook.h"
     #define wxBookCtrl                             wxNotebook

-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED
-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING
+    #define wxEVT_BOOKCTRL_PAGE_CHANGED            wxEVT_NOTEBOOK_PAGE_CHANGED
+    #define wxEVT_BOOKCTRL_PAGE_CHANGING           wxEVT_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)
 #else
     // dedicated to Smartphones
     #include "wx/choicebk.h"
     #define wxBookCtrl                             wxChoicebook
     #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)
 #else
     // dedicated to Smartphones
     #include "wx/choicebk.h"
     #define wxBookCtrl                             wxChoicebook

-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED
-    #define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING
+    #define wxEVT_BOOKCTRL_PAGE_CHANGED            wxEVT_CHOICEBOOK_PAGE_CHANGED
+    #define wxEVT_BOOKCTRL_PAGE_CHANGING           wxEVT_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)
 #endif
 
     #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)
 #endif
 

+// old wxEVT_COMMAND_* constants
+#define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED    wxEVT_BOOKCTRL_PAGE_CHANGED
+#define wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING   wxEVT_BOOKCTRL_PAGE_CHANGING
+

 #if WXWIN_COMPATIBILITY_2_6
     #define wxBC_TOP                               wxBK_TOP
     #define wxBC_BOTTOM                            wxBK_BOTTOM
 #if WXWIN_COMPATIBILITY_2_6
     #define wxBC_TOP                               wxBK_TOP
     #define wxBC_BOTTOM                            wxBK_BOTTOM