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 f732ce9da516468bfb139ab6abe00d743f6b2082..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
 // 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
 
 #ifndef _NOTEBOOK_H
 #define _NOTEBOOK_H
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-  #pragma interface "notebook.h"
-#endif
-

 #if wxUSE_NOTEBOOK
 
 // ----------------------------------------------------------------------------
 #if wxUSE_NOTEBOOK
 
 // ----------------------------------------------------------------------------


@@ -27,31 +23,41 @@
 // wxNotebook
 // ----------------------------------------------------------------------------
 
 // wxNotebook
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxNotebookPageInfo : public wxObject
+class WXDLLIMPEXP_CORE wxNotebookPageInfo : public wxObject

 {
 public :
 {
 public :

-    wxNotebookPageInfo() { m_page = NULL ; m_imageId = -1 ; m_selected = false ; }
+    wxNotebookPageInfo() { m_page = NULL; m_imageId = -1; m_selected = false; }

     virtual ~wxNotebookPageInfo() { }
 
     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; }
     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 );
 
 
 
 WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
 

-class WXDLLEXPORT wxNotebook : public wxNotebookBase
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase

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


@@ -64,14 +70,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 = 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,
     // 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
   virtual ~wxNotebook();
 
   // accessors


@@ -86,6 +92,9 @@ public:
     // 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
   bool SetPageText(size_t nPage, const wxString& strText);
   wxString GetPageText(size_t nPage) const;
     // set/get the title of a page
   bool SetPageText(size_t nPage, const wxString& strText);
   wxString GetPageText(size_t nPage) const;


@@ -125,8 +134,8 @@ public:
                   bool bSelect = false,
                   int imageId = -1);
 
                   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.
 
     // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
     // style.


@@ -141,7 +150,7 @@ public:
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);

-  void OnSelChange(wxNotebookEvent& event);
+  void OnSelChange(wxBookCtrlEvent& event);

   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals
   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals


@@ -150,46 +159,81 @@ public:
   virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
   virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
                            WXWORD pos, WXHWND control);
   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
 
 
 #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
 
   // implementation only
   // -------------------
 
 #if wxUSE_UXTHEME

-  // handler for child pages erase background event
-  void DoEraseBackground(wxEraseEvent& event);
+  virtual bool SetBackgroundColour(const wxColour& colour)
+  {
+      if ( !wxNotebookBase::SetBackgroundColour(colour) )
+          return false;

 
 

-  // get the brush to be used for painting the background for the controls
-  // which need it in their MSWControlColor()
-  //
-  // the brush will be adjusted for use with the given window on this DC
-  WXHBRUSH GetThemeBackgroundBrush(WXHDC hDC, wxWindow *win) const;
+      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
 
 #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();
 

-  // 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);
 
 
   // 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
   // set the size of the given page to fit in the notebook
   void AdjustPageSize(wxNotebookPage *page);
 
 #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();
   // 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
 
 #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;
 
   // the current selection (-1 if none)
   int m_nSelection;