add an assert indicating that old code overriding OnExecute() must be updated with 2.9

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

diff --git a/include/wx/gtk1/notebook.h b/include/wx/gtk1/notebook.h
index 086aed01756ec5353470b74a00ee7e7917809433..112171e148040f130a4730fe50d62b8f24aa66d9 100644 (file)
--- a/include/wx/gtk1/notebook.h
+++ b/include/wx/gtk1/notebook.h
@@ -1,200 +1,150 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        notebook.h
+// Name:        wx/gtk1/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__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKNOTEBOOKH__
 #define __GTKNOTEBOOKH__
 

-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/control.h"
-

 //-----------------------------------------------------------------------------
 //-----------------------------------------------------------------------------

-// classes
+// internal class

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxImageList;
-class wxNotebook;
-class wxNotebookPage;
-
-// ----------------------------------------------------------------------------
-// notebook events
-// ----------------------------------------------------------------------------
-
-class wxNotebookEvent : public wxNotifyEvent
-{
-public:
-  wxNotebookEvent(wxEventType commandType = wxEVT_NULL, int id = 0,
-                  int nSel = -1, int nOldSel = -1)
-  : 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; }
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;

 
 

-private:
-  bool m_bAllow;
-
-  int m_nSel,     // currently selected page
-      m_nOldSel;  // previously selected page
-
-  DECLARE_DYNAMIC_CLASS(wxNotebookEvent)
-};
+#include "wx/list.h"
+WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);

 
 //-----------------------------------------------------------------------------
 // wxNotebook
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxNotebook
 //-----------------------------------------------------------------------------
 

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

 {
 public:
 {
 public:

-  // ctors
-  // -----
-    // default for dynamic class
-  wxNotebook();
-    // the same arguments as for wxControl (@@@ any special styles?)
-  wxNotebook(wxWindow *parent,
+      // default for dynamic class
+    wxNotebook();
+      // the same arguments as for wxControl
+    wxNotebook(wxWindow *parent,

              wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,

-             const wxString& name = "notebook");
-    // Create() function
-  bool Create(wxWindow *parent,
+             const wxString& name = wxNotebookNameStr);
+      // Create() function
+    bool Create(wxWindow *parent,

               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,

-              const wxString& name = "notebook");
-    // dtor
-  ~wxNotebook();
+              const wxString& name = wxNotebookNameStr);
+      // dtor
+    virtual ~wxNotebook();

 
   // accessors
   // ---------
 
   // accessors
   // ---------

-    // get number of pages in the dialog
-  int GetPageCount() const;

 
     // set the currently selected page, return the index of the previously
     // selected one (or -1 on error)
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
 
     // set the currently selected page, return the index of the previously
     // selected one (or -1 on error)
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events

-  int SetSelection(int nPage);
-    // cycle thru the tabs
-  void AdvanceSelection(bool bForward = TRUE);
+    int SetSelection(size_t nPage) { return DoSetSelection(nPage, SetSelection_SendEvent); }

     // get the currently selected page
     // get the currently selected page

-  int GetSelection() const;
+    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;
-
-  // image list stuff: each page may have an image associated with it. All
-  // the images belong to an image list, so you have to
-  // 1) create an image list
-  // 2) associate it with the notebook
-  // 3) set for each page it's image
-    // 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; }
+  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);
-
-    // currently it's always 1 because wxGTK doesn't support multi-row
-    // tab controls
-  int GetRowCount() const;
+  int  GetPageImage(size_t nPage) const;
+  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);
 
   // 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);
+
+  virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;

 
   // operations
   // ----------
 
   // 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();
     // 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.
     // 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()
+    // the same as AddPage(), but adds it at the specified position
+    bool InsertPage( size_t position,
+                     wxNotebookPage *win,
+                     const wxString& strText,
+                     bool bSelect = false,
+                     int imageId = -1 );

 
 

-    // get the panel which represents the given page
-  wxWindow *GetPage(int nPage) const;
+    // handler for tab navigation
+    // --------------------------
+    void OnNavigationKey(wxNavigationKeyEvent& event);

 
 

-  
-  // implementation
-  
-  void SetConstraintSizes(bool recurse);
-  bool DoPhase(int phase);
-  void ApplyWidgetStyle();

 
 

-  // common part of all ctors
-  void Init();
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 
 

-  // helper function
-  wxNotebookPage* GetNotebookPage(int page) const;
+    // implementation
+    // --------------

 
 

-  wxImageList*    m_imageList;
-  wxList          m_pages;
-  size_t            m_idHandler; // the change page handler id
+#if wxUSE_CONSTRAINTS
+    void SetConstraintSizes(bool recurse);
+    bool DoPhase(int phase);
+#endif

 
 

-  DECLARE_DYNAMIC_CLASS(wxNotebook)
-};
+    // set all page's attributes
+    void DoApplyWidgetStyle(GtkRcStyle *style);
+
+    // report if window belongs to notebook
+    bool IsOwnGtkWindow( GdkWindow *window );
+
+    // common part of all ctors
+    void Init();
+
+    // 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;

 
 

-// ----------------------------------------------------------------------------
-// event macros
-// ----------------------------------------------------------------------------
-typedef void (wxEvtHandler::*wxNotebookEventFunction)(wxNotebookEvent&);
-
-#define EVT_NOTEBOOK_PAGE_CHANGED(id, fn)                                   \
-  {                                                                         \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED,                                    \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  },
-
-#define EVT_NOTEBOOK_PAGE_CHANGING(id, fn)                                  \
-  {                                                                         \
-    wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING,                                   \
-    id,                                                                     \
-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxNotebookEventFunction) &fn,  \
-    NULL                                                                    \
-  },
+    // 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;
+
+protected:
+    // remove one page from the notebook but do not destroy it
+    virtual wxNotebookPage *DoRemovePage(size_t nPage);
+
+    int DoSetSelection(size_t nPage, int flags = 0);
+
+private:
+    // the padding set by SetPadding()
+    int m_padding;
+
+    DECLARE_DYNAMIC_CLASS(wxNotebook)
+    DECLARE_EVENT_TABLE()
+};

 
 #endif
     // __GTKNOTEBOOKH__
 
 #endif
     // __GTKNOTEBOOKH__