supporting clang memory management annotations

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

diff --git a/include/wx/generic/notebook.h b/include/wx/generic/notebook.h
index 4b3ed0980c741ca1a7b3c5268c4e5153dd7ef8d8..1bd34877be4e339944e4b989087332ed272dd12c 100644 (file)
--- a/include/wx/generic/notebook.h
+++ b/include/wx/generic/notebook.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxNotebook class (a.k.a. property sheet, tabbed dialog)
 // Author:      Julian Smart
 // Modified by:
 // Purpose:     wxNotebook class (a.k.a. property sheet, tabbed dialog)
 // Author:      Julian Smart
 // Modified by:


@@ -11,52 +11,26 @@
 #ifndef _WX_NOTEBOOK_H_
 #define _WX_NOTEBOOK_H_
 
 #ifndef _WX_NOTEBOOK_H_
 #define _WX_NOTEBOOK_H_
 

-#ifdef __GNUG__
-#pragma interface "notebook.h"
-#endif
-

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------

-#include "wx/dynarray.h"

 #include "wx/event.h"
 #include "wx/control.h"
 #include "wx/event.h"
 #include "wx/control.h"

-#include "wx/generic/tabg.h"

 
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 
 // fwd declarations
 
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 
 // fwd declarations

-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxWindow;
-
-// array of notebook pages
-typedef wxWindow wxNotebookPage;  // so far, any window can be a page
-WX_DEFINE_ARRAY(wxNotebookPage *, wxArrayPages);
+class WXDLLIMPEXP_FWD_CORE wxImageList;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxTabView;

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

-class WXDLLEXPORT wxNotebook;
-
-// This reuses wxTabView to draw the tabs.
-class WXDLLEXPORT wxNotebookTabView: public wxTabView
-{
-DECLARE_DYNAMIC_CLASS(wxNotebookTabView)
-public:
-  wxNotebookTabView(wxNotebook* notebook, long style = wxTAB_STYLE_DRAW_BOX | wxTAB_STYLE_COLOUR_INTERIOR);
-  ~wxNotebookTabView(void);
-
-  // Called when a tab is activated
-  virtual void OnTabActivate(int activateId, int deactivateId);
-
-protected:
-   wxNotebook*      m_notebook;
-};
-
-class wxNotebook : public wxControl
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase

 {
 public:
   // ctors
 {
 public:
   // ctors


@@ -69,55 +43,43 @@ 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 = "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 = "notebook");
+              const wxString& name = wxNotebookNameStr);

     // dtor
     // dtor

-  ~wxNotebook();
+  virtual ~wxNotebook();

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

-    // get number of pages in the dialog
-  int GetPageCount() const;
-
-  // Find the position of the wxNotebookPage, -1 if not found.
+  // Find the position of the wxNotebookPage, wxNOT_FOUND if not found.

   int FindPagePosition(wxNotebookPage* page) const;
 
     // set the currently selected page, return the index of the previously
   int FindPagePosition(wxNotebookPage* page) 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
     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events

-  int SetSelection(int nPage);
+  int SetSelection(size_t nPage);

     // cycle thru the tabs
     // cycle thru the tabs

-  void AdvanceSelection(bool bForward = TRUE);
-    // get the currently selected page
-  int GetSelection() const { return m_nSelection; }
+  //  void AdvanceSelection(bool bForward = true);
+
+    // changes selected page without sending events
+  int ChangeSelection(size_t 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_pImageList; }
+  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);
+  // get the number of rows for a control with wxNB_MULTILINE style (not all
+  // versions support it - they will always return 1 then)
+  virtual int GetRowCount() const ;

 
 

-    // currently it's always 1 because wxGTK doesn't support multi-row
-    // tab controls
-  int GetRowCount() const;
+    // sets/returns item's image index in the current image list
+  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)
 
   // control the appearance of the notebook pages
     // set the size (the same for all pages)


@@ -131,42 +93,38 @@ public:
   // operations
   // ----------
     // remove one page from the notebook, and delete the page.
   // operations
   // ----------
     // remove one page from the notebook, and delete the page.

-  bool DeletePage(int nPage);
+  bool DeletePage(size_t nPage);

   bool DeletePage(wxNotebookPage* page);
     // remove one page from the notebook, without deleting the page.
   bool DeletePage(wxNotebookPage* page);
     // remove one page from the notebook, without deleting the page.

-  bool RemovePage(int nPage);
+  bool RemovePage(size_t nPage);

   bool RemovePage(wxNotebookPage* page);
   bool RemovePage(wxNotebookPage* page);

+  virtual wxWindow* DoRemovePage(size_t 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,
-    // don't delete it yourself). If bSelect, this page becomes active.
-  bool AddPage(wxNotebookPage *pPage,
-               const wxString& strText,
-               bool bSelect = 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 nPage,
+  bool InsertPage(size_t nPage,

                   wxNotebookPage *pPage,
                   const wxString& strText,
                   wxNotebookPage *pPage,
                   const wxString& strText,

-                  bool bSelect = FALSE,
-                  int imageId = -1);
-    // get the panel which represents the given page
-  wxNotebookPage *GetPage(int nPage) { return m_aPages[nPage]; }
+                  bool bSelect = false,
+                  int imageId = NO_IMAGE);

 
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);
 
   // callbacks
   // ---------
   void OnSize(wxSizeEvent& event);

-  void OnIdle(wxIdleEvent& event);
-  void OnSelChange(wxNotebookEvent& event);
+  void OnInternalIdle();
+  void OnSelChange(wxBookCtrlEvent& event);

   void OnSetFocus(wxFocusEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals
   // -------------------
   virtual void Command(wxCommandEvent& event);
   void OnSetFocus(wxFocusEvent& event);
   void OnNavigationKey(wxNavigationKeyEvent& event);
 
   // base class virtuals
   // -------------------
   virtual void Command(wxCommandEvent& event);

-  virtual void SetConstraintSizes(bool recurse = TRUE);
+  virtual void SetConstraintSizes(bool recurse = true);

   virtual bool DoPhase(int nPhase);
 
   virtual bool DoPhase(int nPhase);
 

+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
+

   // Implementation
 
   // wxNotebook on Motif uses a generic wxTabView to implement itself.
   // Implementation
 
   // wxNotebook on Motif uses a generic wxTabView to implement itself.


@@ -180,7 +138,7 @@ public:
 
   // Implementation: calculate the layout of the view rect
   // and resize the children if required
 
   // Implementation: calculate the layout of the view rect
   // and resize the children if required

-  bool RefreshLayout(bool force = TRUE);
+  bool RefreshLayout(bool force = true);

 
 protected:
   // common part of all ctors
 
 protected:
   // common part of all ctors


@@ -189,11 +147,6 @@ protected:
   // helper functions
   void ChangePage(int nOldSel, int nSel); // change pages
 
   // helper functions
   void ChangePage(int nOldSel, int nSel); // change pages
 

-  wxImageList  *m_pImageList; // we can have an associated image list
-  wxArrayPages  m_aPages;     // array of pages
-
-  int m_nSelection;           // the current selection (-1 if none)
-

   wxTabView*   m_tabView;
 
   DECLARE_DYNAMIC_CLASS(wxNotebook)
   wxTabView*   m_tabView;
 
   DECLARE_DYNAMIC_CLASS(wxNotebook)