]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/gtk1/notebook.h
Document wxKill(wxSIGTERM) reliance on having an open window in wxMSW.
[wxWidgets.git] / include / wx / gtk1 / notebook.h
index 4b297ddf323b6e5c697da75d4b1aeb4333b7f247..5be3df0b5b16465d6e72a88bfcd50d9c0f0632b5 100644 (file)
@@ -1,48 +1,30 @@
 /////////////////////////////////////////////////////////////////////////////
-// 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
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __GTKNOTEBOOKH__
 #define __GTKNOTEBOOKH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-
-#if wxUSE_NOTEBOOK
-
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/control.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxImageList;
-class wxNotebook;
-
-typedef wxWindow wxNotebookPage;  // so far, any window can be a page
-
 //-----------------------------------------------------------------------------
 // internal class
 //-----------------------------------------------------------------------------
 
-class wxGtkNotebookPage;
+class WXDLLIMPEXP_FWD_CORE wxGtkNotebookPage;
+
+#include "wx/list.h"
+WX_DECLARE_LIST(wxGtkNotebookPage, wxGtkNotebookPagesList);
 
 //-----------------------------------------------------------------------------
 // wxNotebook
 //-----------------------------------------------------------------------------
 
-class wxNotebook : public wxControl
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
 {
 public:
       // default for dynamic class
@@ -53,53 +35,37 @@ public:
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& size = wxDefaultSize,
              long style = 0,
-             const wxString& name = "notebook");
+             const wxString& name = wxNotebookNameStr);
       // Create() function
     bool Create(wxWindow *parent,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& size = wxDefaultSize,
               long style = 0,
-              const wxString& name = "notebook");
+              const wxString& name = wxNotebookNameStr);
       // dtor
-    ~wxNotebook();
+    virtual ~wxNotebook();
 
   // 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)
+    // selected one (or wxNOT_FOUND 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
-  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
-  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);
-  void AssignImageList(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
-  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)
@@ -109,35 +75,30 @@ public:
     // 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
   // ----------
-    // 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,
+
+    // 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.
-    bool AddPage( wxNotebookPage *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,
+    bool InsertPage( size_t position,
                      wxNotebookPage *win,
                      const wxString& strText,
-                     bool bSelect = FALSE,
-                     int imageId = -1 );
-
-    // get the panel which represents the given page
-    wxNotebookPage *GetPage(int nPage) const;
+                     bool bSelect = false,
+                     int imageId = NO_IMAGE );
 
     // handler for tab navigation
     // --------------------------
     void OnNavigationKey(wxNavigationKeyEvent& event);
 
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
     // implementation
     // --------------
 
@@ -146,9 +107,10 @@ public:
     bool DoPhase(int phase);
 #endif
 
-    void ApplyWidgetStyle();
+    // set all page's attributes
+    void DoApplyWidgetStyle(GtkRcStyle *style);
 
-    // report if window belongs to notebook  
+    // report if window belongs to notebook
     bool IsOwnGtkWindow( GdkWindow *window );
 
     // common part of all ctors
@@ -157,17 +119,32 @@ public:
     // helper function
     wxGtkNotebookPage* GetNotebookPage(int page) const;
 
-    wxImageList*    m_imageList;
-    bool            m_ownsImageList;
-    wxList          m_pages;
-    int             m_lastSelection;  /* hack */
+    // 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 programmatically 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
-
 #endif
     // __GTKNOTEBOOKH__