include/wx/mac/carbon/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        notebook.h
   3 // Purpose:     MSW/GTK compatible notebook (a.k.a. property sheet)
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Stefan Csomor
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_NOTEBOOK_H_
  12 #define _WX_NOTEBOOK_H_
  13
  14 // ----------------------------------------------------------------------------
  15 // headers
  16 // ----------------------------------------------------------------------------
  17 #include "wx/event.h"
  18
  19 // ----------------------------------------------------------------------------
  20 // types
  21 // ----------------------------------------------------------------------------
  22
  23 // fwd declarations
  24 class WXDLLEXPORT wxImageList;
  25 class WXDLLEXPORT wxWindow;
  26
  27 // ----------------------------------------------------------------------------
  28 // wxNotebook
  29 // ----------------------------------------------------------------------------
  30
  31 class wxNotebook : public wxNotebookBase
  32 {
  33 public:
  34   // ctors
  35   // -----
  36     // default for dynamic class
  37   wxNotebook();
  38     // the same arguments as for wxControl (@@@ any special styles?)
  39   wxNotebook(wxWindow *parent,
  40              wxWindowID id,
  41              const wxPoint& pos = wxDefaultPosition,
  42              const wxSize& size = wxDefaultSize,
  43              long style = 0,
  44              const wxString& name = wxNotebookNameStr);
  45     // Create() function
  46   bool Create(wxWindow *parent,
  47               wxWindowID id,
  48               const wxPoint& pos = wxDefaultPosition,
  49               const wxSize& size = wxDefaultSize,
  50               long style = 0,
  51               const wxString& name = wxNotebookNameStr);
  52     // dtor
  53   ~wxNotebook();
  54
  55   // accessors
  56   // ---------
  57     // set the currently selected page, return the index of the previously
  58     // selected one (or -1 on error)
  59     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
  60   int SetSelection(size_t nPage);
  61     // get the currently selected page
  62   int GetSelection() const { return m_nSelection; }
  63
  64     // set/get the title of a page
  65   bool SetPageText(size_t nPage, const wxString& strText);
  66   wxString GetPageText(size_t nPage) const;
  67
  68     // sets/returns item's image index in the current image list
  69   int  GetPageImage(size_t nPage) const;
  70   bool SetPageImage(size_t nPage, int nImage);
  71
  72   // control the appearance of the notebook pages
  73     // set the size (the same for all pages)
  74   virtual void SetPageSize(const wxSize& size);
  75     // set the padding between tabs (in pixels)
  76   virtual void SetPadding(const wxSize& padding);
  77     // sets the size of the tabs (assumes all tabs are the same size)
  78   virtual void SetTabSize(const wxSize& sz);
  79
  80   // hit test
  81   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
  82
  83   // calculate size for wxNotebookSizer
  84   wxSize CalcSizeFromPage(const wxSize& sizePage) const;
  85   wxRect GetPageRect() const ;
  86
  87   // operations
  88   // ----------
  89     // remove all pages
  90   bool DeleteAllPages();
  91     // the same as AddPage(), but adds it at the specified position
  92   bool InsertPage(size_t nPage,
  93                   wxNotebookPage *pPage,
  94                   const wxString& strText,
  95                   bool bSelect = false,
  96                   int imageId = -1);
  97
  98   // callbacks
  99   // ---------
 100   void OnSize(wxSizeEvent& event);
 101   void OnSelChange(wxNotebookEvent& event);
 102   void OnSetFocus(wxFocusEvent& event);
 103   void OnNavigationKey(wxNavigationKeyEvent& event);
 104
 105     // implementation
 106     // --------------
 107
 108 #if wxUSE_CONSTRAINTS
 109   virtual void SetConstraintSizes(bool recurse = true);
 110   virtual bool DoPhase(int nPhase);
 111
 112 #endif
 113
 114   // base class virtuals
 115   // -------------------
 116   virtual void Command(wxCommandEvent& event);
 117     virtual wxInt32 MacControlHit(WXEVENTHANDLERREF handler, WXEVENTREF event);
 118
 119 protected:
 120   virtual wxNotebookPage *DoRemovePage(size_t page) ;
 121   // common part of all ctors
 122   void Init();
 123
 124   // helper functions
 125   void ChangePage(int nOldSel, int nSel); // change pages
 126   void MacSetupTabs();
 127
 128   // the icon indices
 129   wxArrayInt m_images;
 130
 131   int m_nSelection;           // the current selection (-1 if none)
 132
 133   DECLARE_DYNAMIC_CLASS(wxNotebook)
 134   DECLARE_EVENT_TABLE()
 135 };
 136
 137
 138 #endif // _WX_NOTEBOOK_H_