fix the incoherence pointed out by ifacecheck between wx docs, that documents usage...

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

diff --git a/include/wx/msw/notebook.h b/include/wx/msw/notebook.h
index 97a3141c54dbb30067f96259bfeed5c6e4479452..969e7321452c8e16145d0800824316fa39d06336 100644 (file)
--- a/include/wx/msw/notebook.h
+++ b/include/wx/msw/notebook.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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
@@ -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
 
 // ----------------------------------------------------------------------------
@@ -27,7 +23,7 @@
 // wxNotebook
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxNotebookPageInfo : public wxObject
+class WXDLLIMPEXP_CORE wxNotebookPageInfo : public wxObject
 {
 public :
     wxNotebookPageInfo() { m_page = NULL; m_imageId = -1; m_selected = false; }
@@ -61,7 +57,7 @@ private:
 
 WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
 
-class WXDLLEXPORT wxNotebook : public wxNotebookBase
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
 {
 public:
   // ctors
@@ -96,6 +92,9 @@ public:
     // 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
   bool SetPageText(size_t nPage, const wxString& strText);
   wxString GetPageText(size_t nPage) const;
@@ -151,7 +150,7 @@ public:
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);
-  void OnSelChange(wxNotebookEvent& event);
+  void OnSelChange(wxBookCtrlEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals
@@ -160,13 +159,14 @@ public:
   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
 
+  // Attempts to get colour for UX theme page background
+  wxColour GetThemeBackgroundColour() const;
 
   // implementation only
   // -------------------
@@ -182,36 +182,58 @@ public:
       return true;
   }
 
-  virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, wxWindow *win);
-  virtual wxColour MSWGetBgColourForChild(wxWindow *win);
+  // 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();
 
-  // translate wxWin styles to the Windows ones
-  virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
+  // 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);
 
+  // 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);
 
 #if wxUSE_UXTHEME
-  // this is a slightly ugly function which gets the bitmap of notebook
-  // background and either returns the colour under the specified window in it
-  // or creates a brush from it
-  //
-  // so if win == NULL, a brush is created and returned
-  //       win != NULL, returns COLORREF of the pixel under its top left corner
-  WXHANDLE QueryBgBitmap(wxWindow *win = NULL);
+  // 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;