synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/gtk/notebook.h b/include/wx/gtk/notebook.h
index b046c6526136a1f7f903e616a6b75003496f82cf..2d116acdd08afd39db8e6b95350634f501482fcc 100644 (file)
--- a/include/wx/gtk/notebook.h
+++ b/include/wx/gtk/notebook.h
@@ -1,25 +1,21 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxNotebook class
 // Author:      Robert Roebling
 // Modified by:
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Robert Roebling
 // Purpose:     wxNotebook class
 // Author:      Robert Roebling
 // Modified by:
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Robert Roebling

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKNOTEBOOKH__
-#define __GTKNOTEBOOKH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#ifndef _WX_GTKNOTEBOOK_H_
+#define _WX_GTKNOTEBOOK_H_

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

-class wxGtkNotebookPage;
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;

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


@@ -28,7 +24,7 @@ WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
 // wxNotebook
 //-----------------------------------------------------------------------------
 
 // wxNotebook
 //-----------------------------------------------------------------------------
 

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

 {
 public:
       // default for dynamic class
 {
 public:
       // default for dynamic class


@@ -39,14 +35,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 = wxT("notebook"));
+             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 = wxT("notebook"));
+              const wxString& name = wxNotebookNameStr);

       // dtor
     virtual ~wxNotebook();
 
       // dtor
     virtual ~wxNotebook();
 


@@ -54,48 +50,55 @@ 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
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events

-  int SetSelection(int nPage);
+    int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }

     // get the currently selected page
   int GetSelection() const;
 
     // get the currently selected page
   int GetSelection() const;
 

+  // changes selected page without sending events
+  int ChangeSelection(size_t nPage) { return DoSetSelection(nPage); }
+

     // set/get the title of a page
     // 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;

 
     // sets/returns item's image index in the current image list
 
     // 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);

 
   // control the appearance of the notebook pages
 
   // 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
   // ----------
   // operations
   // ----------

-    // remove one page from the notebook
-  bool DeletePage(int nPage);

     // remove all pages
   bool DeleteAllPages();
 
     // remove all pages
   bool DeleteAllPages();
 

-    // adds a new page to the notebook (it will be deleted ny the notebook,
+    // adds a new page to the notebook (it will be deleted by the notebook,

     // don't delete it yourself). If bSelect, this page becomes active.
     // the same as AddPage(), but adds it at the specified position
     // don't delete it yourself). If bSelect, this page becomes active.
     // the same as AddPage(), but adds it at the specified position

-    bool InsertPage( int position,
+    bool InsertPage( size_t position,

                      wxNotebookPage *win,
                      const wxString& strText,
                      wxNotebookPage *win,
                      const wxString& strText,

-                     bool bSelect = FALSE,
-                     int imageId = -1 );
+                     bool bSelect = false,
+                     int imageId = NO_IMAGE );

 
     // handler for tab navigation
     // --------------------------
     void OnNavigationKey(wxNavigationKeyEvent& event);
 
 
     // handler for tab navigation
     // --------------------------
     void OnNavigationKey(wxNavigationKeyEvent& event);
 

+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+

     // implementation
     // --------------
 
     // implementation
     // --------------
 


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

-    void ApplyWidgetStyle();
-
-    // report if window belongs to notebook
-    bool IsOwnGtkWindow( GdkWindow *window );
-

     // common part of all ctors
     void Init();
 
     // 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;
 
     // the additional page data (the pages themselves are in m_pages array)
     wxGtkNotebookPagesList m_pagesData;
 
     // helper function
     wxGtkNotebookPage* GetNotebookPage(int page) const;
 
     // 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;
+    // 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:
 
 protected:

+    // set all page's attributes
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+

     // remove one page from the notebook but do not destroy it
     // remove one page from the notebook but do not destroy it

-    virtual wxNotebookPage *DoRemovePage(int nPage);
+    virtual wxNotebookPage *DoRemovePage(size_t nPage);

 
 

-private:
+    int DoSetSelection(size_t nPage, int flags = 0);

 
 

+private:
+    // the padding set by SetPadding()

     int m_padding;
 
     int m_padding;
 

+    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_