fixed docs to accomodate more strict wxHTML Help controller

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

diff --git a/include/wx/gtk1/notebook.h b/include/wx/gtk1/notebook.h
index 2d10456907b19da7d0f62d856c8cc26f4ee9afb4..b2111426999e137501bd139545c164fd4d5cc423 100644 (file)
--- a/include/wx/gtk1/notebook.h
+++ b/include/wx/gtk1/notebook.h
@@ -15,58 +15,48 @@
 #pragma interface
 #endif
 
 #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;
+class wxGtkNotebookPage;
+
+#include "wx/list.h"
+WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);

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

-class wxNotebook : public wxControl
+class 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,
              const wxString& name = "notebook");
              wxWindowID id,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
              const wxString& name = "notebook");

-    // Create() function
-  bool Create(wxWindow *parent,
+      // Create() function
+    bool Create(wxWindow *parent,

               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
               const wxString& name = "notebook");
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
               const wxString& name = "notebook");

-    // dtor
-  ~wxNotebook();
+      // 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
   int SetSelection(int nPage);
 
     // 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);

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


@@ -74,24 +64,10 @@ public:
   bool SetPageText(int nPage, const wxString& strText);
   wxString GetPageText(int nPage) const;
 
   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; }
-

     // sets/returns item's image index in the current image list
   int  GetPageImage(int nPage) const;
   bool SetPageImage(int nPage, int nImage);
 
     // 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;
-

   // control the appearance of the notebook pages
     // set the size (the same for all pages)
   void SetPageSize(const wxSize& size);
   // control the appearance of the notebook pages
     // set the size (the same for all pages)
   void SetPageSize(const wxSize& size);


@@ -102,52 +78,57 @@ public:
 
   // 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 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.
     // 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 *win,
-                const wxString& strText,
-                bool select = FALSE,
-                int imageId = -1 );

     // the same as AddPage(), but adds it at the specified position
     // 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;
+    bool InsertPage( int position,
+                     wxNotebookPage *win,
+                     const wxString& strText,
+                     bool bSelect = FALSE,
+                     int imageId = -1 );
+
+    // handler for tab navigation
+    // --------------------------
+    void OnNavigationKey(wxNavigationKeyEvent& event);
+
+    // implementation
+    // --------------
+
+#if wxUSE_CONSTRAINTS
+    void SetConstraintSizes(bool recurse);
+    bool DoPhase(int phase);
+#endif

 
 

-  void OnNavigationKey(wxNavigationKeyEvent& event);
+    void ApplyWidgetStyle();

 
 

-  // implementation
+    // report if window belongs to notebook
+    bool IsOwnGtkWindow( GdkWindow *window );

 
 

-  void SetConstraintSizes(bool recurse);
-  bool DoPhase(int phase);
-  void ApplyWidgetStyle();
+    // common part of all ctors
+    void Init();

 
 

-  // report if window belongs to notebook  
-  bool IsOwnGtkWindow( GdkWindow *window );
+    // helper function
+    wxGtkNotebookPage* GetNotebookPage(int page) const;

 
 

-  // common part of all ctors
-  void Init();
+    // the additional page data (the pages themselves are in m_pages array)
+    wxGtkNotebookPagesList m_pagesData;

 
 

-  // helper function
-  wxNotebookPage* GetNotebookPage(int page) const;
+    // for reasons explained in gtk/notebook.cpp we store the current
+    // selection internally instead of querying the notebook for it
+    int m_selection;

 
 

-  wxImageList*    m_imageList;
-  wxList          m_pages;
-  int             m_lastSelection;  /* hack */
+protected:
+    // remove one page from the notebook but do not destroy it
+    virtual wxNotebookPage *DoRemovePage(int nPage);

 
 

-  DECLARE_DYNAMIC_CLASS(wxNotebook)
-  DECLARE_EVENT_TABLE()
+private:
+    DECLARE_DYNAMIC_CLASS(wxNotebook)
+    DECLARE_EVENT_TABLE()

 };
 
 #endif
 };
 
 #endif