added SetHoverBitmap() and implemented it under wxMSW; extended the docs

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

diff --git a/include/wx/msw/notebook.h b/include/wx/msw/notebook.h
index 6e19b04fa3aadfb85bf9c36fe15de2afa6fe795c..291c681ea9040ec496119b8e019ec1ba644c8ce5 100644 (file)
--- a/include/wx/msw/notebook.h
+++ b/include/wx/msw/notebook.h
@@ -11,10 +11,6 @@
 #ifndef _NOTEBOOK_H
 #define _NOTEBOOK_H
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-  #pragma interface "notebook.h"
-#endif
-
 #if wxUSE_NOTEBOOK
 
 // ----------------------------------------------------------------------------
@@ -30,23 +26,33 @@
 class WXDLLEXPORT wxNotebookPageInfo : public wxObject
 {
 public :
-    wxNotebookPageInfo() { m_page = NULL ; m_imageId = -1 ; m_selected = false ; }
+    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 ; }
+    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 ;
 
-    DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo) ;
-} ;
+private:
+    wxNotebookPage *m_page;
+    wxString m_text;
+    bool m_selected;
+    int m_imageId;
+
+    DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo)
+};
 
 
 WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
@@ -64,14 +70,15 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
-             const wxString& name = wxNOTEBOOK_NAME);
+             const wxString& name = wxNotebookNameStr);
     // Create() function
   bool Create(wxWindow *parent,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
-              const wxString& name = wxNOTEBOOK_NAME);
+              const wxString& name = wxNotebookNameStr);
+  virtual ~wxNotebook();
 
   // accessors
   // ---------
@@ -111,9 +118,6 @@ 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 all pages
@@ -124,19 +128,16 @@ public:
   bool InsertPage(size_t nPage,
                   wxNotebookPage *pPage,
                   const wxString& strText,
-                  bool bSelect = FALSE,
+                  bool bSelect = false,
                   int imageId = -1);
 
-  void AddPageInfo( wxNotebookPageInfo* info ) { AddPage( info->GetPage() , info->GetText() , info->GetSelected() , info->GetImageId() ) ; }
-  const wxNotebookPageInfoList& GetPageInfos() const ;
+  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;
 
@@ -158,10 +159,28 @@ public:
   virtual bool MSWTranslateMessage(WXMSG *wxmsg);
 
 #if wxUSE_CONSTRAINTS
-  virtual void SetConstraintSizes(bool recurse = TRUE);
+  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;
+  }
+#endif // wxUSE_UXTHEME
+
 protected:
   // common part of all ctors
   void Init();
@@ -172,18 +191,52 @@ protected:
   // remove one page from the notebook, without deleting
   virtual wxNotebookPage *DoRemovePage(size_t nPage);
 
+  // get the page rectangle for the current notebook size
+  //
+  // returns empty rectangle if an error occurs, do test for it
+  wxRect GetPageSize() const;
+
   // set the size of the given page to fit in the notebook
   void AdjustPageSize(wxNotebookPage *page);
 
-    // override WndProc.
 #if wxUSE_UXTHEME
-    virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
-#endif
+  // 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();
+
+  // 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);
+
+  // 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 ;
+  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)