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 ccb9227047cc9ed3ac47c1c18247c67b101ddd34..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:
@@ -11,10 +11,6 @@
 #ifndef _WX_NOTEBOOK_H_
 #define _WX_NOTEBOOK_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "notebook.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
@@ -26,15 +22,15 @@
 // ----------------------------------------------------------------------------
 
 // fwd declarations
-class WXDLLEXPORT wxImageList;
-class WXDLLEXPORT wxWindow;
-class WXDLLEXPORT wxTabView;
+class WXDLLIMPEXP_FWD_CORE wxImageList;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxTabView;
 
 // ----------------------------------------------------------------------------
 // wxNotebook
 // ----------------------------------------------------------------------------
 
-class wxNotebook : public wxNotebookBase
+class WXDLLIMPEXP_CORE wxNotebook : public wxNotebookBase
 {
 public:
   // ctors
@@ -47,42 +43,43 @@ 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
   // ---------
-  // 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
-    // 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);
+  int SetSelection(size_t nPage);
     // 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
-  bool SetPageText(int nPage, const wxString& strText);
-  wxString GetPageText(int nPage) const;
+  bool SetPageText(size_t nPage, const wxString& strText);
+  wxString GetPageText(size_t nPage) const;
 
   // 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 ;
 
     // sets/returns item's image index in the current image list
-  int  GetPageImage(int nPage) const;
-  bool SetPageImage(int nPage, int nImage);
+  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)
@@ -96,34 +93,38 @@ public:
   // 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 RemovePage(int nPage);
+  bool RemovePage(size_t nPage);
   bool RemovePage(wxNotebookPage* page);
+  virtual wxWindow* DoRemovePage(size_t nPage);
+
     // remove all pages
   bool DeleteAllPages();
     // 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,
-                  bool bSelect = FALSE,
-                  int imageId = -1);
+                  bool bSelect = false,
+                  int imageId = NO_IMAGE);
 
   // 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);
-  virtual void SetConstraintSizes(bool recurse = TRUE);
+  virtual void SetConstraintSizes(bool recurse = true);
   virtual bool DoPhase(int nPhase);
 
+  virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
+
   // Implementation
 
   // wxNotebook on Motif uses a generic wxTabView to implement itself.
@@ -137,7 +138,7 @@ public:
 
   // 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
@@ -146,8 +147,6 @@ protected:
   // helper functions
   void ChangePage(int nOldSel, int nSel); // change pages
 
-  int m_nSelection;           // the current selection (-1 if none)
-
   wxTabView*   m_tabView;
 
   DECLARE_DYNAMIC_CLASS(wxNotebook)