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 wxUSE_NOTEBOOK
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/control.h"
  21
  22 // ----------------------------------------------------------------------------
  23 // wxNotebook
  24 // ----------------------------------------------------------------------------
  25
  26 class WXDLLEXPORT wxNotebookPageInfo : public wxObject
  27 {
  28 public :
  29     wxNotebookPageInfo() { m_page = NULL; m_imageId = -1; m_selected = false; }
  30     virtual ~wxNotebookPageInfo() { }
  31
  32     void Create(wxNotebookPage *page,
  33                 const wxString& text,
  34                 bool selected,
  35                 int imageId)
  36     {
  37         m_page = page;
  38         m_text = text;
  39         m_selected = selected;
  40         m_imageId = imageId;
  41     }
  42
  43     wxNotebookPage* GetPage() const { return m_page; }
  44     wxString GetText() const { return m_text; }
  45     bool GetSelected() const { return m_selected; }
  46     int GetImageId() const { return m_imageId; }
  47
  48 private:
  49     wxNotebookPage *m_page;
  50     wxString m_text;
  51     bool m_selected;
  52     int m_imageId;
  53
  54     DECLARE_DYNAMIC_CLASS(wxNotebookPageInfo)
  55 };
  56
  57
  58 WX_DECLARE_EXPORTED_LIST(wxNotebookPageInfo, wxNotebookPageInfoList );
  59
  60 class WXDLLEXPORT wxNotebook : public wxNotebookBase
  61 {
  62 public:
  63   // ctors
  64   // -----
  65     // default for dynamic class
  66   wxNotebook();
  67     // the same arguments as for wxControl (@@@ any special styles?)
  68   wxNotebook(wxWindow *parent,
  69              wxWindowID id,
  70              const wxPoint& pos = wxDefaultPosition,
  71              const wxSize& size = wxDefaultSize,
  72              long style = 0,
  73              const wxString& name = wxNotebookNameStr);
  74     // Create() function
  75   bool Create(wxWindow *parent,
  76               wxWindowID id,
  77               const wxPoint& pos = wxDefaultPosition,
  78               const wxSize& size = wxDefaultSize,
  79               long style = 0,
  80               const wxString& name = wxNotebookNameStr);
  81   virtual ~wxNotebook();
  82
  83   // accessors
  84   // ---------
  85     // get number of pages in the dialog
  86   virtual size_t GetPageCount() const;
  87
  88     // set the currently selected page, return the index of the previously
  89     // selected one (or -1 on error)
  90     // NB: this function will _not_ generate wxEVT_NOTEBOOK_PAGE_xxx events
  91   int SetSelection(size_t nPage);
  92     // get the currently selected page
  93   int GetSelection() const { return m_nSelection; }
  94
  95     // set/get the title of a page
  96   bool SetPageText(size_t nPage, const wxString& strText);
  97   wxString GetPageText(size_t nPage) const;
  98
  99   // image list stuff: each page may have an image associated with it. All
 100   // the images belong to an image list, so you have to
 101   // 1) create an image list
 102   // 2) associate it with the notebook
 103   // 3) set for each page it's image
 104     // associate image list with a control
 105   void SetImageList(wxImageList* imageList);
 106
 107     // sets/returns item's image index in the current image list
 108   int  GetPageImage(size_t nPage) const;
 109   bool SetPageImage(size_t nPage, int nImage);
 110
 111     // currently it's always 1 because wxGTK doesn't support multi-row
 112     // tab controls
 113   int GetRowCount() const;
 114
 115   // control the appearance of the notebook pages
 116     // set the size (the same for all pages)
 117   void SetPageSize(const wxSize& size);
 118     // set the padding between tabs (in pixels)
 119   void SetPadding(const wxSize& padding);
 120
 121   // operations
 122   // ----------
 123     // remove all pages
 124   bool DeleteAllPages();
 125
 126     // inserts a new page to the notebook (it will be deleted ny the notebook,
 127     // don't delete it yourself). If bSelect, this page becomes active.
 128   bool InsertPage(size_t nPage,
 129                   wxNotebookPage *pPage,
 130                   const wxString& strText,
 131                   bool bSelect = false,
 132                   int imageId = -1);
 133
 134   void AddPageInfo( wxNotebookPageInfo* info ) { AddPage( info->GetPage() , info->GetText() , info->GetSelected() , info->GetImageId() ); }
 135   const wxNotebookPageInfoList& GetPageInfos() const;
 136
 137     // Windows-only at present. Also, you must use the wxNB_FIXEDWIDTH
 138     // style.
 139   void SetTabSize(const wxSize& sz);
 140
 141     // hit test
 142   virtual int HitTest(const wxPoint& pt, long *flags = NULL) const;
 143
 144     // calculate the size of the notebook from the size of its page
 145   virtual wxSize CalcSizeFromPage(const wxSize& sizePage) const;
 146
 147   // callbacks
 148   // ---------
 149   void OnSize(wxSizeEvent& event);
 150   void OnSelChange(wxNotebookEvent& event);
 151   void OnNavigationKey(wxNavigationKeyEvent& event);
 152
 153   // base class virtuals
 154   // -------------------
 155
 156   virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 157   virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
 158                            WXWORD pos, WXHWND control);
 159   virtual bool MSWTranslateMessage(WXMSG *wxmsg);
 160
 161 #if wxUSE_CONSTRAINTS
 162   virtual void SetConstraintSizes(bool recurse = true);
 163   virtual bool DoPhase(int nPhase);
 164 #endif // wxUSE_CONSTRAINTS
 165
 166   // Attempts to get colour for UX theme page background
 167   wxColour GetThemeBackgroundColour() const;
 168
 169   // implementation only
 170   // -------------------
 171
 172 #if wxUSE_UXTHEME
 173   virtual bool SetBackgroundColour(const wxColour& colour)
 174   {
 175       if ( !wxNotebookBase::SetBackgroundColour(colour) )
 176           return false;
 177
 178       UpdateBgBrush();
 179
 180       return true;
 181   }
 182 #endif // wxUSE_UXTHEME
 183
 184 protected:
 185   // common part of all ctors
 186   void Init();
 187
 188   // translate wxWin styles to the Windows ones
 189   virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const;
 190
 191   // remove one page from the notebook, without deleting
 192   virtual wxNotebookPage *DoRemovePage(size_t nPage);
 193
 194   // get the page rectangle for the current notebook size
 195   //
 196   // returns empty rectangle if an error occurs, do test for it
 197   wxRect GetPageSize() const;
 198
 199   // set the size of the given page to fit in the notebook
 200   void AdjustPageSize(wxNotebookPage *page);
 201
 202 #if wxUSE_UXTHEME
 203   // gets the bitmap of notebook background and returns a brush from it
 204   WXHBRUSH QueryBgBitmap();
 205
 206   // creates the brush to be used for drawing the tab control background
 207   void UpdateBgBrush();
 208
 209   // return the themed brush for painting our children
 210   virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd);
 211
 212   // draw child background
 213   virtual bool MSWPrintChild(WXHDC hDC, wxWindow *win);
 214
 215   // common part of QueryBgBitmap() and MSWPrintChild()
 216   //
 217   // if child == NULL, draw background for the entire notebook itself
 218   bool DoDrawBackground(WXHDC hDC, wxWindow *child = NULL);
 219 #endif // wxUSE_UXTHEME
 220
 221   // these function are only used for reducing flicker on notebook resize and
 222   // we don't need to do this for WinCE
 223 #ifndef __WXWINCE__
 224   void OnEraseBackground(wxEraseEvent& event);
 225   void OnPaint(wxPaintEvent& event);
 226
 227   // true if we have already subclassed our updown control
 228   bool m_hasSubclassedUpdown;
 229 #endif // __WXWINCE__
 230
 231   // the current selection (-1 if none)
 232   int m_nSelection;
 233
 234   wxNotebookPageInfoList m_pageInfos;
 235
 236 #if wxUSE_UXTHEME
 237   // background brush used to paint the tab control
 238   WXHBRUSH m_hbrBackground;
 239 #endif // wxUSE_UXTHEME
 240
 241
 242   DECLARE_DYNAMIC_CLASS_NO_COPY(wxNotebook)
 243   DECLARE_EVENT_TABLE()
 244 };
 245
 246 #endif // wxUSE_NOTEBOOK
 247
 248 #endif // _NOTEBOOK_H