include/wx/msw/notebook.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msw/notebook.h
   3 // Purpose:     MSW/GTK compatible notebook (a.k.a. property sheet)
   4 // Author:      Robert Roebling
   5 // Modified by: Vadim Zeitlin for Windows version
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _NOTEBOOK_H
  12 #define _NOTEBOOK_H
  13
  14 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  15   #pragma interface "notebook.h"
  16 #endif
  17
  18 #if wxUSE_NOTEBOOK
  19
  20 // ----------------------------------------------------------------------------
  21 // headers
  22 // ----------------------------------------------------------------------------
  23
  24 #include "wx/control.h"
  25
  26 // ----------------------------------------------------------------------------
  27 // wxNotebook
  28 // ----------------------------------------------------------------------------
  29
  30 class WXDLLEXPORT wxNotebook : public wxNotebookBase
  31 {
  32 public:
  33   // ctors
  34   // -----
  35     // default for dynamic class
  36   wxNotebook();
  37     // the same arguments as for wxControl (@@@ any special styles?)
  38   wxNotebook(wxWindow *parent,
  39              wxWindowID id,
  40              const wxPoint& pos = wxDefaultPosition,
  41              const wxSize& size = wxDefaultSize,
  42              long style = 0,
  43              const wxString& name = wxNOTEBOOK_NAME);
  44     // Create() function
  45   bool Create(wxWindow *parent,
  46               wxWindowID id,
  47               const wxPoint& pos = wxDefaultPosition,
  48               const wxSize& size = wxDefaultSize,
  49               long style = 0,
  50               const wxString& name = wxNOTEBOOK_NAME);
  51
  52   // accessors
  53   // ---------
  54     // get number of pages in the dialog
  55   int GetPageCount() const;
  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(int 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(int nPage, const wxString& strText);
  66   wxString GetPageText(int nPage) const;
  67
  68   // image list stuff: each page may have an image associated with it. All
  69   // the images belong to an image list, so you have to
  70   // 1) create an image list
  71   // 2) associate it with the notebook
  72   // 3) set for each page it's image
  73     // associate image list with a control
  74   void SetImageList(wxImageList* imageList);
  75
  76     // sets/returns item's image index in the current image list
  77   int  GetPageImage(int nPage) const;
  78   bool SetPageImage(int nPage, int nImage);
  79
  80     // currently it's always 1 because wxGTK doesn't support multi-row
  81     // tab controls
  82   int GetRowCount() const;
  83
  84   // control the appearance of the notebook pages
  85     // set the size (the same for all pages)
  86   void SetPageSize(const wxSize& size);
  87     // set the padding between tabs (in pixels)
  88   void SetPadding(const wxSize& padding);
  89
  90     // Windows only: attempts to get colour for UX theme page background
  91   wxColour GetThemeBackgroundColour();
  92
  93   // operations
  94   // ----------
  95     // remove all pages
  96   bool DeleteAllPages();
  97
  98     // inserts a new page to the notebook (it will be deleted ny the notebook,
  99     // don't delete it yourself). If bSelect, this page becomes active.
 100   bool InsertPage(int nPage,
 101                   wxNotebookPage *pPage,
 102                   const wxString& strText,
 103                   bool bSelect = FALSE,
 104                   int imageId = -1);
 105
 106     // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 107     // style.
 108   void SetTabSize(const wxSize& sz);
 109
 110     // Windows only: attempts to apply the UX theme page background to this page
 111   void ApplyThemeBackground(wxWindow* window, const wxColour& colour);
 112
 113     // hit test
 114   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
 115
 116     // calculate the size of the notebook from the size of its page
 117   virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
 118
 119   // callbacks
 120   // ---------
 121   void OnSize(wxSizeEvent& event);
 122   void OnSelChange(wxNotebookEvent& event);
 123   void OnSetFocus(wxFocusEvent& event);
 124   void OnNavigationKey(wxNavigationKeyEvent& event);
 125
 126   // base class virtuals
 127   // -------------------
 128
 129   virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 130   virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
 131                            WXWORD pos, WXHWND control);
 132
 133 #if wxUSE_CONSTRAINTS
 134   virtual void SetConstraintSizes(bool recurse = TRUE);
 135   virtual bool DoPhase(int nPhase);
 136 #endif // wxUSE_CONSTRAINTS
 137
 138 protected:
 139   // common part of all ctors
 140   void Init();
 141
 142   // translate wxWin styles to the Windows ones
 143   virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
 144
 145   // remove one page from the notebook, without deleting
 146   virtual wxNotebookPage *DoRemovePage(int nPage);
 147
 148   // set the size of the given page to fit in the notebook
 149   void AdjustPageSize(wxNotebookPage *page);
 150
 151   // override WndProc
 152   virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 153
 154   // the current selection (-1 if none)
 155   int m_nSelection;
 156
 157
 158   DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebook)
 159   DECLARE_EVENT_TABLE()
 160 };
 161
 162 #endif // wxUSE_NOTEBOOK
 163
 164 #endif // _NOTEBOOK_H