]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msw/notebook.h
If several doc templates use the same document and view classes, they should
[wxWidgets.git] / include / wx / msw / notebook.h
index 60a4942b279bb765a3464a027c8981fc30143410..6e19b04fa3aadfb85bf9c36fe15de2afa6fe795c 100644 (file)
@@ -4,80 +4,54 @@
 // 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
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
   #pragma interface "notebook.h"
 #endif
 
+#if wxUSE_NOTEBOOK
+
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
-#ifndef   _DYNARRAY_H
-  #include <wx/dynarray.h>
-#endif  //_DYNARRAY_H
+
+#include "wx/control.h"
 
 // ----------------------------------------------------------------------------
-// types
+// wxNotebook
 // ----------------------------------------------------------------------------
 
-// fwd declarations
-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxWindow;
-
-// array of notebook pages
-typedef wxWindow WXDLLEXPORT wxNotebookPage;  // so far, any window can be a page
-
-#undef WXDLLEXPORTLOCAL
-#define WXDLLEXPORTLOCAL WXDLLEXPORT
-
-WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
+class WXDLLEXPORT wxNotebookPageInfo : public wxObject
+{
+public :
+    wxNotebookPageInfo() { m_page = NULL ; m_imageId = -1 ; m_selected = false ; }
+    virtual ~wxNotebookPageInfo() { }
 
-#undef  WXDLLEXPORTLOCAL
-#define WXDLLEXPORTLOCAL
+    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 :
+    wxNotebookPage *m_page ;
+    wxString m_text ;
+    bool m_selected ;
+    int m_imageId ;
 
-// ----------------------------------------------------------------------------
-// notebook events
-// ----------------------------------------------------------------------------
-class WXDLLEXPORT wxNotebookEvent : public wxNotifyEvent
-{
-public:
-  wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
-                  int nSel = -1, int nOldSel = -1)
-  : wxNotifyEvent(commandType, id)
-  {
-      m_nSel = nSel;
-      m_nOldSel = nOldSel;
-  }
+    DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo) ;
+} ;
 
-  // 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)
-};
 
-// ----------------------------------------------------------------------------
-// wxNotebook
-// ----------------------------------------------------------------------------
+WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
 
-// @@@ 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
@@ -90,34 +64,30 @@ public:
              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,
-              const wxString& name = "notebook");
-    // dtor
-  ~wxNotebook();
+              const wxString& name = wxNOTEBOOK_NAME);
 
   // 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
-  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; }
 
     // 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
@@ -126,12 +96,10 @@ public:
   // 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;
-  bool SetPageImage(int nPage, int nImage);
+  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
@@ -143,83 +111,85 @@ public:
     // 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
   // ----------
-    // remove one page from the notebook
-  bool DeletePage(int nPage);
-    // remove one page from the notebook, without deleting
-  bool RemovePage(int nPage);
     // 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.
-  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,
+  bool InsertPage(size_t 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]; }
+
+  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);
 
+    // Windows only: attempts to apply the UX theme page background to this page
+  void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
+
+    // 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 OnWindowCreate(wxWindowCreateEvent& event);
+  void OnSize(wxSizeEvent& event);
   void OnSelChange(wxNotebookEvent& event);
-  void OnSetFocus(wxFocusEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals
   // -------------------
+
   virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
+  virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
+                           WXWORD pos, WXHWND control);
+  virtual bool MSWTranslateMessage(WXMSG *wxmsg);
+
+#if wxUSE_CONSTRAINTS
   virtual void SetConstraintSizes(bool recurse = TRUE);
   virtual bool DoPhase(int nPhase);
+#endif // wxUSE_CONSTRAINTS
 
 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;
 
-  wxImageList  *m_pImageList; // we can have an associated image list
-  wxArrayPages  m_aPages;     // array of pages
+  // remove one page from the notebook, without deleting
+  virtual wxNotebookPage *DoRemovePage(size_t nPage);
 
-  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)
+    // override WndProc.
+#if wxUSE_UXTHEME
+    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
+#endif
+
+  // the current selection (-1 if none)
+  int m_nSelection;
+
+  wxNotebookPageInfoList m_pageInfos ;
+
+
+  DECLARE_DYNAMIC_CLASS_NO_COPY(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