synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/bookctrl.h b/include/wx/bookctrl.h
index c7c7c27f9c81a71e35f298b05d566eaf7da92228..50087a252608a3042bb051708c62e3efbcf5a188 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)


@@ -252,6 +242,17 @@ protected:
     // choose the default border for this window
     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
 
     // 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
     // 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


@@ -309,12 +310,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;