Rewrote wxNotebook, incl. PAGE_CHANGING event

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

diff --git a/include/wx/gtk/notebook.h b/include/wx/gtk/notebook.h
index 57d67e6b42d2b75dd3a77ad1871784e1c6c76fcf..13b3f0b00994bbbeb8f0743bf9299061a5ebb9d4 100644 (file)
--- a/include/wx/gtk/notebook.h
+++ b/include/wx/gtk/notebook.h
@@ -1,18 +1,18 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        tabctrl.h
-// Purpose:     wxTabCtrl class
+// Name:        notebook.h
+// Purpose:     wxNotebook class
 // Author:      Robert Roebling
 // Modified by:
 // RCS-ID:      $Id$
-// Copyright:   (c) Julian Smart and Markus Holzem
+// Copyright:   (c) Julian Smart and Robert Roebling
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __TABCTRLH__
-#define __TABCTRLH__
+#ifndef __GTKNOTEBOOKH__
+#define __GTKNOTEBOOKH__
 
 #ifdef __GNUG__
-#pragma interface "notebook.h"
+#pragma interface
 #endif
 
 #include "wx/defs.h"
@@ -31,18 +31,33 @@ class wxNotebookPage;
 // ----------------------------------------------------------------------------
 // notebook events
 // ----------------------------------------------------------------------------
-class wxNotebookEvent : public wxCommandEvent
+
+class wxNotebookEvent : public wxNotifyEvent
 {
 public:
-  wxNotebookEvent(WXTYPE commandType = 0, int id = 0,
+  wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
                   int nSel = -1, int nOldSel = -1)
-    : wxCommandEvent(commandType, id) { m_nSel = nSel; m_nOldSel = nOldSel; }
+  : wxNotifyEvent(commandType, id)
+  {
+      m_bAllow = TRUE;
+      m_nSel = nSel;
+      m_nOldSel = nOldSel;
+  }
 
   // accessors
   int GetSelection() const { return m_nSel; }
   int GetOldSelection() const { return m_nOldSel; }
 
+  // for wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING event this method may be called
+  // to disallow the page change
+  void Veto() { m_bAllow = FALSE; }
+
+  // implementation: for wxNotebook usage only
+  bool Allowed() const { return m_bAllow; }
+
 private:
+  bool m_bAllow;
+
   int m_nSel,     // currently selected page
       m_nOldSel;  // previously selected page
 
@@ -62,17 +77,17 @@ public:
   wxNotebook();
     // the same arguments as for wxControl (@@@ any special styles?)
   wxNotebook(wxWindow *parent,
-             const wxWindowID id,
+             wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
-             const long style = 0,
+             long style = 0,
              const wxString& name = "notebook");
     // Create() function
   bool Create(wxWindow *parent,
-              const wxWindowID id,
+              wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
-              const long style = 0,
+              long style = 0,
               const wxString& name = "notebook");
     // dtor
   ~wxNotebook();
@@ -103,7 +118,7 @@ public:
     // associate image list with a control
   void SetImageList(wxImageList* imageList);
     // get pointer (may be NULL) to the associated image list
-  wxImageList* GetImageList() const { return m_imageList; }
+  wxImageList *GetImageList() const { return m_imageList; }
 
     // sets/returns item's image index in the current image list
   int  GetPageImage(int nPage) const;
@@ -118,32 +133,45 @@ public:
   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);
 
   // operations
   // ----------
+    // remove one page from the notebook but do not destroy it
+  bool RemovePage(int nPage);
     // remove one page from the notebook
   bool DeletePage(int nPage);
     // remove all pages
   bool DeleteAllPages();
+  
     // adds a new page to the notebook (it will be deleted ny the notebook,
     // don't delete it yourself). If bSelect, this page becomes active.
-  bool AddPage(wxWindow *pPage,
-               const wxString& strText,
-               bool bSelect = FALSE,
-               int imageId = -1);
-    // @@@@ VZ: I don't know how to implement InsertPage()
+  bool AddPage( wxWindow *win,
+                const wxString& strText,
+                bool select = FALSE,
+                int imageId = -1 );
+    // the same as AddPage(), but adds it at the specified position
+  bool InsertPage( int position,
+                   wxWindow *win,
+                   const wxString& strText,
+                   bool bSelect = FALSE,
+                   int imageId = -1 );
 
     // get the panel which represents the given page
   wxWindow *GetPage(int nPage) const;
 
-  // base class virtuals
-  virtual void AddChild(wxWindow *child);
+  void OnNavigationKey(wxNavigationKeyEvent& event);
 
-protected:
-  // wxWin callbacks
-  void OnSize(wxSizeEvent& event);
+  // implementation
+
+  void SetConstraintSizes(bool recurse);
+  bool DoPhase(int phase);
+  void ApplyWidgetStyle();
+
+  // report if window belongs to notebook  
+  bool IsOwnGtkWindow( GdkWindow *window );
 
-private:
   // common part of all ctors
   void Init();
 
@@ -152,7 +180,6 @@ private:
 
   wxImageList*    m_imageList;
   wxList          m_pages;
-  uint            m_idHandler; // the change page handler id
 
   DECLARE_DYNAMIC_CLASS(wxNotebook)
   DECLARE_EVENT_TABLE()
@@ -174,7 +201,7 @@ typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
 
 #define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
   {                                                                         \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING, \                                 \
+    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
     id,                                                                     \
     -1,                                                                     \
     (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
@@ -182,4 +209,4 @@ typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
   },
 
 #endif
-    // __TABCTRLH__
+    // __GTKNOTEBOOKH__