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