add an assert indicating that old code overriding OnExecute() must be updated with 2.9

[wxWidgets.git] / include / wx / msw / notebook.h

diff --git a/include/wx/msw/notebook.h b/include/wx/msw/notebook.h
index 4f59ab01cfe3183b62013ef9301f06f58af85e38..0509755d5f8341bf6d742f5ee7630a9dede60755 100644 (file)
--- a/include/wx/msw/notebook.h
+++ b/include/wx/msw/notebook.h
@@ -1,68 +1,63 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        msw/notebook.h
+// Name:        wx/msw/notebook.h

 // Purpose:     MSW/GTK compatible notebook (a.k.a. property sheet)
 // Author:      Robert Roebling
 // Modified by: Vadim Zeitlin for Windows version
 // RCS-ID:      $Id$
 // Purpose:     MSW/GTK compatible notebook (a.k.a. property sheet)
 // Author:      Robert Roebling
 // Modified by: Vadim Zeitlin for Windows version
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:    wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _NOTEBOOK_H
 #define _NOTEBOOK_H
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _NOTEBOOK_H
 #define _NOTEBOOK_H
 

-#ifdef __GNUG__
-  #pragma interface "notebook.h"
-#endif
+#if wxUSE_NOTEBOOK

 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

-#ifndef   _DYNARRAY_H
-  #include <wx/dynarray.h>
-#endif  //_DYNARRAY_H

 
 

-// ----------------------------------------------------------------------------
-// types
-// ----------------------------------------------------------------------------
-
-// fwd declarations
-class wxImageList;
-class wxWindow;
-
-// array of notebook pages
-typedef wxWindow wxNotebookPage;  // so far, any window can be a page
-WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
+#include "wx/control.h"

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// notebook events
+// wxNotebook

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-class WXDLLEXPORT wxNotebookEvent : public wxCommandEvent
-{
-public:
-  wxNotebookEvent(WXTYPE commandType = 0, int id = 0, 
-                  int nSel = -1, int nOldSel = -1)
-    : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }

 
 

-  // accessors
-  int GetSelection() const { return m_nSel; }
-  int GetOldSelection() const { return m_nOldSel; }
+class WXDLLIMPEXP_CORE wxNotebookPageInfo : public wxObject
+{
+public :
+    wxNotebookPageInfo() { m_page = NULL; m_imageId = -1; m_selected = false; }
+    virtual ~wxNotebookPageInfo() { }
+
+    void Create(wxNotebookPage *page,
+                const wxString& text,
+                bool selected,
+                int imageId)
+    {
+        m_page = page;
+        m_text = text;
+        m_selected = selected;
+        m_imageId = imageId;
+    }
+
+    wxNotebookPage* GetPage() const { return m_page; }
+    wxString GetText() const { return m_text; }
+    bool GetSelected() const { return m_selected; }
+    int GetImageId() const { return m_imageId; }

 
 private:
 
 private:

-  int m_nSel,     // currently selected page
-      m_nOldSel;  // previously selected page
+    wxNotebookPage *m_page;
+    wxString m_text;
+    bool m_selected;
+    int m_imageId;

 
 

-  DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
+    DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo)

 };
 
 };
 

-// ----------------------------------------------------------------------------
-// wxNotebook
-// ----------------------------------------------------------------------------

 
 

-// @@@ this class should really derive from wxTabCtrl, but the interface is not
-//     exactly the same, so I can't do it right now and instead we reimplement
-//     part of wxTabCtrl here
-class wxNotebook : public wxControl
+WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
+
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase

 {
 public:
   // ctors
 {
 public:
   // ctors


@@ -71,38 +66,38 @@ public:
   wxNotebook();
     // the same arguments as for wxControl (@@@ any special styles?)
   wxNotebook(wxWindow *parent,
   wxNotebook();
     // the same arguments as for wxControl (@@@ any special styles?)
   wxNotebook(wxWindow *parent,

-             const wxWindowID id, 
+             wxWindowID id,

              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,

-             const long style = 0,
-             const wxString& name = "notebook");
+             long style = 0,
+             const wxString& name = wxNotebookNameStr);

     // Create() function
   bool Create(wxWindow *parent,
     // Create() function
   bool Create(wxWindow *parent,

-              const wxWindowID id, 
+              wxWindowID id,

               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,

-              const long style = 0,
-              const wxString& name = "notebook");
-    // dtor
-  ~wxNotebook();
+              long style = 0,
+              const wxString& name = wxNotebookNameStr);
+  virtual ~wxNotebook();

 
   // accessors
   // ---------
     // get number of pages in the dialog
 
   // accessors
   // ---------
     // get number of pages in the dialog

-  int GetPageCount() const;
+  virtual size_t GetPageCount() const;

 
     // set the currently selected page, return the index of the previously
     // selected one (or -1 on error)
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
 
     // set the currently selected page, return the index of the previously
     // selected one (or -1 on error)
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events

-  int SetSelection(int nPage);
-    // cycle thru the tabs
-  void AdvanceSelection(bool bForward = TRUE);
+  int SetSelection(size_t nPage);

     // get the currently selected page
   int GetSelection() const { return m_nSelection; }
 
     // get the currently selected page
   int GetSelection() const { return m_nSelection; }
 

+    // changes selected page without sending events
+  int ChangeSelection(size_t nPage);
+

     // set/get the title of a page
     // set/get the title of a page

-  bool SetPageText(int nPage, const wxString& strText);
-  wxString GetPageText(int nPage) const;
+  bool SetPageText(size_t nPage, const wxString& strText);
+  wxString GetPageText(size_t nPage) const;

 
   // image list stuff: each page may have an image associated with it. All
   // the images belong to an image list, so you have to
 
   // image list stuff: each page may have an image associated with it. All
   // the images belong to an image list, so you have to


@@ -111,17 +106,10 @@ public:
   // 3) set for each page it's image
     // associate image list with a control
   void SetImageList(wxImageList* imageList);
   // 3) set for each page it's image
     // associate image list with a control
   void SetImageList(wxImageList* imageList);

-    // get pointer (may be NULL) to the associated image list
-  wxImageList* GetImageList() const { return m_pImageList; }

 
     // sets/returns item's image index in the current image list
 
     // sets/returns item's image index in the current image list

-  int  GetPageImage(int nPage) const;
-  bool SetPageImage(int nPage, int nImage);
-
-  // each page can have some user-defined data associated with it:
-    // set/retrieve this pointer
-  bool  SetPageData(int nPage, void* data);
-  void* GetPageData(int nPage) const;
+  int  GetPageImage(size_t nPage) const;
+  bool SetPageImage(size_t nPage, int nImage);

 
     // currently it's always 1 because wxGTK doesn't support multi-row
     // tab controls
 
     // currently it's always 1 because wxGTK doesn't support multi-row
     // tab controls


@@ -135,75 +123,132 @@ public:
 
   // operations
   // ----------
 
   // operations
   // ----------

-    // remove one page from the notebook
-  bool DeletePage(int nPage);

     // remove all pages
   bool DeleteAllPages();
     // remove all pages
   bool DeleteAllPages();

-    // adds a new page to the notebook (it will be deleted ny the notebook,
+
+    // inserts a new page to the notebook (it will be deleted ny the notebook,

     // don't delete it yourself). If bSelect, this page becomes active.
     // don't delete it yourself). If bSelect, this page becomes active.

-  bool AddPage(wxNotebookPage *pPage,
-               const wxString& strText,
-               bool bSelect = FALSE,
-               int imageId = -1,
-               void* data = NULL);
-    // the same as AddPage(), but adds it at the specified position
-  bool InsertPage(int nPage,
+  bool InsertPage(size_t nPage,

                   wxNotebookPage *pPage,
                   const wxString& strText,
                   wxNotebookPage *pPage,
                   const wxString& strText,

-                  bool bSelect = FALSE,
-                  int imageId = -1,
-                  void* data = NULL);
-    // get the panel which represents the given page
-  wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
+                  bool bSelect = false,
+                  int imageId = -1);
+
+  void AddPageInfo( wxNotebookPageInfo* info ) { AddPage( info->GetPage() , info->GetText() , info->GetSelected() , info->GetImageId() ); }
+  const wxNotebookPageInfoList& GetPageInfos() const;
+
+    // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
+    // style.
+  void SetTabSize(const wxSize& sz);
+
+    // hit test
+  virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
+
+    // calculate the size of the notebook from the size of its page
+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

 
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);
   void OnSelChange(wxNotebookEvent& event);
 
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);
   void OnSelChange(wxNotebookEvent& event);

-  
+  void OnNavigationKey(wxNavigationKeyEvent& event);
+

   // base class virtuals
   // -------------------
   // base class virtuals
   // -------------------

-  virtual void Command(wxCommandEvent& event);
-  virtual bool MSWNotify(const WXWPARAM wParam, const WXLPARAM lParam);
+
+  virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+  virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
+                           WXWORD pos, WXHWND control);
+
+#if wxUSE_CONSTRAINTS
+  virtual void SetConstraintSizes(bool recurse = true);
+  virtual bool DoPhase(int nPhase);
+#endif // wxUSE_CONSTRAINTS
+
+  // Attempts to get colour for UX theme page background
+  wxColour GetThemeBackgroundColour() const;
+
+  // implementation only
+  // -------------------
+
+#if wxUSE_UXTHEME
+  virtual bool SetBackgroundColour(const wxColour& colour)
+  {
+      if ( !wxNotebookBase::SetBackgroundColour(colour) )
+          return false;
+
+      UpdateBgBrush();
+
+      return true;
+  }
+
+  // return the themed brush for painting our children
+  virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd);
+
+  // draw child background
+  virtual bool MSWPrintChild(WXHDC hDC, wxWindow *win);
+#endif // wxUSE_UXTHEME
+
+  // translate wxWin styles to the Windows ones
+  virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;

 
 protected:
   // common part of all ctors
   void Init();
 
 
 protected:
   // common part of all ctors
   void Init();
 

-  // helper functions
-  void ChangePage(int nOldSel, int nSel); // change pages
-  void FitPage(wxNotebookPage *pPage);    // fit a page in the tab control
+  // hides the currently shown page and shows the given one (if not -1) and
+  // updates m_nSelection accordingly
+  void UpdateSelection(int selNew);
+
+  // remove one page from the notebook, without deleting
+  virtual wxNotebookPage *DoRemovePage(size_t nPage);

 
 

-  wxImageList  *m_pImageList; // we can have an associated image list
-  wxArrayPages  m_aPages;     // array of pages
+  // get the page rectangle for the current notebook size
+  //
+  // returns empty rectangle if an error occurs, do test for it
+  wxRect GetPageSize() const;

 
 

-  int m_nSelection;           // the current selection (-1 if none)
+  // set the size of the given page to fit in the notebook
+  void AdjustPageSize(wxNotebookPage *page);

 
 

-  DECLARE_DYNAMIC_CLASS(wxNotebook)
+#if wxUSE_UXTHEME
+  // gets the bitmap of notebook background and returns a brush from it
+  WXHBRUSH QueryBgBitmap();
+
+  // creates the brush to be used for drawing the tab control background
+  void UpdateBgBrush();
+
+  // common part of QueryBgBitmap() and MSWPrintChild()
+  //
+  // if child == NULL, draw background for the entire notebook itself
+  bool DoDrawBackground(WXHDC hDC, wxWindow *child = NULL);
+#endif // wxUSE_UXTHEME
+
+  // these function are only used for reducing flicker on notebook resize and
+  // we don't need to do this for WinCE
+#ifndef __WXWINCE__
+  void OnEraseBackground(wxEraseEvent& event);
+  void OnPaint(wxPaintEvent& event);
+
+  // true if we have already subclassed our updown control
+  bool m_hasSubclassedUpdown;
+#endif // __WXWINCE__
+
+  // the current selection (-1 if none)
+  int m_nSelection;
+
+  wxNotebookPageInfoList m_pageInfos;
+
+#if wxUSE_UXTHEME
+  // background brush used to paint the tab control
+  WXHBRUSH m_hbrBackground;
+#endif // wxUSE_UXTHEME
+
+
+  DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebook)

   DECLARE_EVENT_TABLE()
 };
 
   DECLARE_EVENT_TABLE()
 };
 

-// ----------------------------------------------------------------------------
-// event macros
-// ----------------------------------------------------------------------------
-typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
-
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
-  {                                                                         \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  },
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
-  {                                                                         \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \                                 \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  },
+#endif // wxUSE_NOTEBOOK

 
 #endif // _NOTEBOOK_H
 
 #endif // _NOTEBOOK_H