Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/notebook.h b/include/wx/gtk/notebook.h
index d58bbdf345a817ee7111fafc342b4984b99291a3..878bbc4dd33fd39c13ad3f0585311f50dfba8a42 100644 (file)
--- a/include/wx/gtk/notebook.h
+++ b/include/wx/gtk/notebook.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        notebook.h
+// Name:        wx/gtk/notebook.h

 // Purpose:     wxNotebook class
 // Author:      Robert Roebling
 // Modified by:
 // Purpose:     wxNotebook class
 // Author:      Robert Roebling
 // Modified by:


@@ -8,14 +8,14 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKNOTEBOOKH__
-#define __GTKNOTEBOOKH__
+#ifndef _WX_GTKNOTEBOOK_H_
+#define _WX_GTKNOTEBOOK_H_

 
 //-----------------------------------------------------------------------------
 // internal class
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // internal class
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxGtkNotebookPage;
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;

 
 #include "wx/list.h"
 WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
 
 #include "wx/list.h"
 WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);


@@ -50,7 +50,7 @@ public:
   // ---------
 
     // set the currently selected page, return the index of the previously
   // ---------
 
     // set the currently selected page, return the index of the previously

-    // selected one (or -1 on error)
+    // selected one (or wxNOT_FOUND on error)

     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
     int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }
     // get the currently selected page
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
     int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }
     // get the currently selected page


@@ -68,13 +68,13 @@ public:
   bool SetPageImage(size_t nPage, int nImage);
 
   // control the appearance of the notebook pages
   bool SetPageImage(size_t nPage, int nImage);
 
   // control the appearance of the notebook pages

-    // set the size (the same for all pages)
-  void SetPageSize(const wxSize& size);

     // set the padding between tabs (in pixels)
   void SetPadding(const wxSize& padding);
     // sets the size of the tabs (assumes all tabs are the same size)
   void SetTabSize(const wxSize& sz);
 
     // set the padding between tabs (in pixels)
   void SetPadding(const wxSize& padding);
     // sets the size of the tabs (assumes all tabs are the same size)
   void SetTabSize(const wxSize& sz);
 

+  // geometry
+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;

   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
 
   // operations
   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
 
   // operations


@@ -89,7 +89,7 @@ public:
                      wxNotebookPage *win,
                      const wxString& strText,
                      bool bSelect = false,
                      wxNotebookPage *win,
                      const wxString& strText,
                      bool bSelect = false,

-                     int imageId = -1 );
+                     int imageId = NO_IMAGE );

 
     // handler for tab navigation
     // --------------------------
 
     // handler for tab navigation
     // --------------------------


@@ -107,8 +107,8 @@ public:
     bool DoPhase(int phase);
 #endif
 
     bool DoPhase(int phase);
 #endif
 

-    // common part of all ctors
-    void Init();
+    // Called by GTK event handler when the current page is definitely changed.
+    void GTKOnPageChanged();

 
     // helper function
     wxGtkNotebookPage* GetNotebookPage(int page) const;
 
     // helper function
     wxGtkNotebookPage* GetNotebookPage(int page) const;


@@ -116,15 +116,10 @@ public:
     // the additional page data (the pages themselves are in m_pages array)
     wxGtkNotebookPagesList m_pagesData;
 
     // the additional page data (the pages themselves are in m_pages array)
     wxGtkNotebookPagesList m_pagesData;
 

-    // for reasons explained in gtk/notebook.cpp we store the current
-    // selection internally instead of querying the notebook for it
-    int m_selection;
-
-    // flag set to true while we're inside "switch_page" callback
-    bool m_inSwitchPage;
-
-    // flag set to true when the switch-page signal has been programatically generated
-    bool m_skipNextPageChangeEvent;
+    // we need to store the old selection since there
+    // is no other way to know about it at the time
+    // of the change selection event
+    int m_oldSelection;

 
 protected:
     // set all page's attributes
 
 protected:
     // set all page's attributes


@@ -140,9 +135,11 @@ private:
     // the padding set by SetPadding()
     int m_padding;
 
     // the padding set by SetPadding()
     int m_padding;
 

+    void Init();
+    virtual void AddChildGTK(wxWindowGTK* child);
+

     DECLARE_DYNAMIC_CLASS(wxNotebook)
     DECLARE_EVENT_TABLE()
 };
 
     DECLARE_DYNAMIC_CLASS(wxNotebook)
     DECLARE_EVENT_TABLE()
 };
 

-#endif
-    // __GTKNOTEBOOKH__
+#endif // _WX_GTKNOTEBOOK_H_