removed unused method declaration

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

diff --git a/include/wx/msw/notebook.h b/include/wx/msw/notebook.h
index 7ce1bd427472a074c3c9b1c0c2944c9ebe53ca84..714f15cda74159f5e9d36d66a66016cf7a12e2a1 100644 (file)
--- a/include/wx/msw/notebook.h
+++ b/include/wx/msw/notebook.h
@@ -4,8 +4,8 @@
 // Author:      Robert Roebling
 // Modified by: Vadim Zeitlin for Windows version
 // RCS-ID:      $Id$
 // 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
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _NOTEBOOK_H


@@ -15,58 +15,28 @@
   #pragma interface "notebook.h"
 #endif
 
   #pragma interface "notebook.h"
 #endif
 

-// ----------------------------------------------------------------------------
-// headers
-// ----------------------------------------------------------------------------
-#ifndef   _DYNARRAY_H
-  #include <wx/dynarray.h>
-#endif  //_DYNARRAY_H
+#if wxUSE_NOTEBOOK

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

-// types
+// headers

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

-// fwd declarations
-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxWindow;
-
-// array of notebook pages
-typedef wxWindow WXDLLEXPORT 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(wxEventType commandType = wxEVT_NULL, int id = 0,
-                  int nSel = -1, int nOldSel = -1)
-    : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }

 
 

-  // accessors
-    // the currently selected page (-1 if none)
-  int GetSelection() const { return m_nSel; }
-  void SetSelection(int nSel) { m_nSel = nSel; }
-    // the page that was selected before the change (-1 if none)
-  int GetOldSelection() const { return m_nOldSel; }
-  void SetOldSelection(int nOldSel) { m_nOldSel = nOldSel; }
-
-private:
-  int m_nSel,     // currently selected page
-      m_nOldSel;  // previously selected page
-
-  DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
-};
+/*
+ * Flags returned by HitTest
+ */

 
 

-// ----------------------------------------------------------------------------
-// wxNotebook
-// ----------------------------------------------------------------------------
+#define wxNB_HITTEST_NOWHERE           1
+#define wxNB_HITTEST_ONICON            2
+#define wxNB_HITTEST_ONLABEL           4
+#define wxNB_HITTEST_ONITEM            6

 
 

-// @@@ 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 WXDLLEXPORT wxNotebook : public wxControl
+class WXDLLEXPORT wxNotebook : public wxNotebookBase

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


@@ -79,16 +49,14 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,

-             const wxString& name = "notebook");
+             const wxString& name = wxNOTEBOOK_NAME);

     // Create() function
   bool Create(wxWindow *parent,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
     // Create() function
   bool Create(wxWindow *parent,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,

-              const wxString& name = "notebook");
-    // dtor
-  ~wxNotebook();
+              const wxString& name = wxNOTEBOOK_NAME);

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


@@ -99,8 +67,6 @@ public:
     // selected one (or -1 on error)
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
   int SetSelection(int nPage);
     // 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);

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


@@ -115,8 +81,6 @@ 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
   int  GetPageImage(int nPage) const;
 
     // sets/returns item's image index in the current image list
   int  GetPageImage(int nPage) const;


@@ -132,26 +96,32 @@ public:
     // set the padding between tabs (in pixels)
   void SetPadding(const wxSize& padding);
 
     // set the padding between tabs (in pixels)
   void SetPadding(const wxSize& padding);
 

+    // Windows only: attempts to get colour for UX theme page background
+  wxColour GetThemeBackgroundColour();
+

   // 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);
-    // the same as AddPage(), but adds it at the specified position

   bool InsertPage(int nPage,
                   wxNotebookPage *pPage,
                   const wxString& strText,
                   bool bSelect = FALSE,
                   int imageId = -1);
   bool InsertPage(int nPage,
                   wxNotebookPage *pPage,
                   const wxString& strText,
                   bool bSelect = FALSE,
                   int imageId = -1);

-    // get the panel which represents the given page
-  wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
+
+    // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
+    // style.
+  void SetTabSize(const wxSize& sz);
+
+    // Windows only: attempts to apply the UX theme page background to this page
+  void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
+
+  // Hit test
+  int HitTest(const wxPoint& pt, long& flags);
+  // calculate the size of the notebook from the size of its page
+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

 
   // callbacks
   // ---------
 
   // callbacks
   // ---------


@@ -159,52 +129,41 @@ public:
   void OnSelChange(wxNotebookEvent& event);
   void OnSetFocus(wxFocusEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);
   void OnSelChange(wxNotebookEvent& event);
   void OnSetFocus(wxFocusEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);

-  void OnEraseBackground(wxEraseEvent& event);

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

-  virtual void Command(wxCommandEvent& event);
-  virtual bool MSWNotify(WXWPARAM wParam, 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);
   virtual void SetConstraintSizes(bool recurse = TRUE);
   virtual bool DoPhase(int nPhase);

+#endif // wxUSE_CONSTRAINTS

 
 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
+  // translate wxWin styles to the Windows ones
+  virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
+
+  // remove one page from the notebook, without deleting
+  virtual wxNotebookPage *DoRemovePage(int nPage);
+
+  // set the size of the given page to fit in the notebook
+  void AdjustPageSize(wxNotebookPage *page);

 
 

-  wxImageList  *m_pImageList; // we can have an associated image list
-  wxArrayPages  m_aPages;     // array of pages

 
 

-  int m_nSelection;           // the current selection (-1 if none)
+  // the current selection (-1 if none)
+  int m_nSelection;
+

 
   DECLARE_DYNAMIC_CLASS(wxNotebook)
   DECLARE_EVENT_TABLE()
 };
 
 
   DECLARE_DYNAMIC_CLASS(wxNotebook)
   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