include/wx/aui/auibook.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/aui/notebook.h
   3 // Purpose:     wxaui: wx advanced user interface - notebook
   4 // Author:      Benjamin I. Williams
   5 // Modified by:
   6 // Created:     2006-06-28
   7 // Copyright:   (C) Copyright 2006, Kirix Corporation, All Rights Reserved.
   8 // Licence:     wxWindows Library Licence, Version 3.1
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11
  12
  13 #ifndef _WX_AUINOTEBOOK_H_
  14 #define _WX_AUINOTEBOOK_H_
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 #include "wx/defs.h"
  21 #include "wx/aui/framemanager.h"
  22 #include "wx/aui/dockart.h"
  23 #include "wx/aui/floatpane.h"
  24
  25
  26 #if wxUSE_AUI
  27
  28
  29
  30 // event declarations/classes
  31
  32 class WXDLLIMPEXP_AUI wxAuiNotebookEvent : public wxNotifyEvent
  33 {
  34 public:
  35     wxAuiNotebookEvent(wxEventType command_type = wxEVT_NULL,
  36                        int win_id = 0)
  37           : wxNotifyEvent(command_type, win_id)
  38     {
  39     }
  40 #ifndef SWIG
  41     wxAuiNotebookEvent(const wxAuiNotebookEvent& c) : wxNotifyEvent(c)
  42     {
  43         old_selection = c.old_selection;
  44         selection = c.selection;
  45     }
  46 #endif
  47     wxEvent *Clone() const { return new wxAuiNotebookEvent(*this); }
  48
  49     void SetSelection(int s) { selection = s; }
  50     void SetOldSelection(int s) { old_selection = s; }
  51     int GetSelection() const { return selection; }
  52     int GetOldSelection() const { return old_selection; }
  53
  54 public:
  55     int old_selection;
  56     int selection;
  57
  58 #ifndef SWIG
  59 private:
  60     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent)
  61 #endif
  62 };
  63
  64
  65
  66
  67
  68 class WXDLLIMPEXP_AUI wxAuiNotebookPage
  69 {
  70 public:
  71     wxWindow* window;     // page's associated window
  72     wxString caption;     // caption displayed on the tab
  73     wxBitmap bitmap;      // tab's bitmap
  74     wxRect rect;          // tab's hit rectangle
  75     bool active;          // true if the page is currently active
  76 };
  77
  78 class WXDLLIMPEXP_AUI wxAuiTabContainerButton
  79 {
  80 public:
  81     int id;               // button's id
  82     int cur_state;        // current state (normal, hover, pressed)
  83     wxBitmap bitmap;      // button's bitmap
  84     wxRect rect;          // button's hit rectangle
  85 };
  86
  87
  88 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage, wxAuiNotebookPageArray, WXDLLIMPEXP_AUI);
  89 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton, wxAuiTabContainerButtonArray, WXDLLIMPEXP_AUI);
  90
  91
  92
  93 class WXDLLIMPEXP_AUI wxAuiTabContainer
  94 {
  95 public:
  96
  97     wxAuiTabContainer();
  98     virtual ~wxAuiTabContainer();
  99
 100     bool AddPage(wxWindow* page, const wxAuiNotebookPage& info);
 101     bool InsertPage(wxWindow* page, const wxAuiNotebookPage& info, size_t idx);
 102     bool RemovePage(wxWindow* page);
 103     bool SetActivePage(wxWindow* page);
 104     bool SetActivePage(size_t page);
 105     void SetNoneActive();
 106     int GetActivePage() const;
 107     bool TabHitTest(int x, int y, wxWindow** hit) const;
 108     bool ButtonHitTest(int x, int y, wxAuiTabContainerButton** hit) const;
 109     wxWindow* GetWindowFromIdx(size_t idx) const;
 110     int GetIdxFromWindow(wxWindow* page) const;
 111     size_t GetPageCount() const;
 112     wxAuiNotebookPage& GetPage(size_t idx);
 113     wxAuiNotebookPageArray& GetPages();
 114     void SetNormalFont(const wxFont& normal_font);
 115     void SetSelectedFont(const wxFont& selected_font);
 116     void SetMeasuringFont(const wxFont& measuring_font);
 117     void DoShowHide();
 118     void SetRect(const wxRect& rect);
 119     void AddButton(int id, const wxBitmap& bmp);
 120
 121 protected:
 122
 123     virtual void Render(wxDC* dc);
 124
 125     virtual void DrawTab(wxDC* dc,
 126                          const wxRect& in_rect,
 127                          const wxString& caption,
 128                          bool active,
 129                          wxRect* out_rect,
 130                          int* x_extent);
 131 private:
 132
 133     wxAuiNotebookPageArray m_pages;
 134     wxAuiTabContainerButtonArray m_buttons;
 135     wxRect m_rect;
 136     wxFont m_normal_font;
 137     wxFont m_selected_font;
 138     wxFont m_measuring_font;
 139     wxPen m_normal_bkpen;
 140     wxPen m_selected_bkpen;
 141     wxBrush m_normal_bkbrush;
 142     wxBrush m_selected_bkbrush;
 143     wxBrush m_bkbrush;
 144 };
 145
 146
 147
 148 class WXDLLIMPEXP_AUI wxAuiTabCtrl : public wxControl,
 149                                      public wxAuiTabContainer
 150 {
 151 public:
 152
 153     wxAuiTabCtrl(wxWindow* parent,
 154                  wxWindowID id,
 155                  const wxPoint& pos = wxDefaultPosition,
 156                  const wxSize& size = wxDefaultSize,
 157                  long style = 0);
 158
 159 protected:
 160
 161     void OnPaint(wxPaintEvent& evt);
 162     void OnEraseBackground(wxEraseEvent& evt);
 163     void OnSize(wxSizeEvent& evt);
 164     void OnLeftDown(wxMouseEvent& evt);
 165     void OnLeftUp(wxMouseEvent& evt);
 166     void OnMotion(wxMouseEvent& evt);
 167     void OnLeaveWindow(wxMouseEvent& evt);
 168
 169 protected:
 170
 171     wxPoint m_click_pt;
 172     int m_click_tab;
 173     bool m_is_dragging;
 174     wxAuiTabContainerButton* m_hover_button;
 175
 176     DECLARE_EVENT_TABLE()
 177 };
 178
 179
 180
 181
 182 class WXDLLIMPEXP_AUI wxAuiMultiNotebook : public wxControl
 183 {
 184
 185 public:
 186
 187     wxAuiMultiNotebook();
 188
 189     wxAuiMultiNotebook(wxWindow* parent,
 190                        wxWindowID id,
 191                        const wxPoint& pos = wxDefaultPosition,
 192                        const wxSize& size = wxDefaultSize,
 193                        long style = 0);
 194
 195     virtual ~wxAuiMultiNotebook();
 196
 197     bool Create(wxWindow* parent,
 198                 wxWindowID id,
 199                 const wxPoint& pos = wxDefaultPosition,
 200                 const wxSize& size = wxDefaultSize,
 201                 long style = 0);
 202
 203     bool AddPage(wxWindow* page,
 204                  const wxString& caption,
 205                  bool select = false,
 206                  const wxBitmap& bitmap = wxNullBitmap);
 207
 208     bool InsertPage(size_t page_idx,
 209                     wxWindow* page,
 210                     const wxString& caption,
 211                     bool select = false,
 212                     const wxBitmap& bitmap = wxNullBitmap);
 213
 214     bool DeletePage(size_t page);
 215     bool RemovePage(size_t page);
 216
 217     bool SetPageText(size_t page, const wxString& text);
 218     size_t SetSelection(size_t new_page);
 219     int GetSelection() const;
 220     size_t GetPageCount() const;
 221     wxWindow* GetPage(size_t page_idx) const;
 222
 223 protected:
 224
 225     wxAuiTabCtrl* GetTabCtrlFromPoint(const wxPoint& pt);
 226     wxWindow* GetTabFrameFromTabCtrl(wxWindow* tab_ctrl);
 227     wxAuiTabCtrl* GetActiveTabCtrl();
 228     bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx);
 229     void RemoveEmptyTabFrames();
 230
 231 protected:
 232
 233     void DoSizing();
 234     void InitNotebook();
 235
 236     void OnChildFocus(wxChildFocusEvent& evt);
 237     void OnRender(wxFrameManagerEvent& evt);
 238     void OnEraseBackground(wxEraseEvent& evt);
 239     void OnSize(wxSizeEvent& evt);
 240     void OnTabClicked(wxCommandEvent& evt);
 241     void OnTabBeginDrag(wxCommandEvent& evt);
 242     void OnTabDragMotion(wxCommandEvent& evt);
 243     void OnTabEndDrag(wxCommandEvent& evt);
 244     void OnTabButton(wxCommandEvent& evt);
 245
 246 protected:
 247
 248     wxFrameManager m_mgr;
 249     wxAuiTabContainer m_tabs;
 250     int m_curpage;
 251     int m_tab_id_counter;
 252     wxWindow* m_dummy_wnd;
 253
 254     wxFont m_selected_font;
 255     wxFont m_normal_font;
 256
 257     DECLARE_EVENT_TABLE()
 258 };
 259
 260
 261
 262
 263 // wx event machinery
 264
 265 #ifndef SWIG
 266
 267 BEGIN_DECLARE_EVENT_TYPES()
 268     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, 0)
 269     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, 0)
 270     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_BUTTON, 0)
 271     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, 0)
 272     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, 0)
 273     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, 0)
 274 END_DECLARE_EVENT_TYPES()
 275
 276 typedef void (wxEvtHandler::*wxAuiNotebookEventFunction)(wxAuiNotebookEvent&);
 277
 278 #define wxAuiNotebookEventHandler(func) \
 279     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiNotebookEventFunction, &func)
 280
 281 #define EVT_AUINOTEBOOK_PAGE_CHANGED(winid, fn) \
 282     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, winid, wxAuiNotebookEventHandler(fn))
 283 #define EVT_AUINOTEBOOK_PAGE_CHANGING(winid, fn) \
 284     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, winid, wxAuiNotebookEventHandler(fn))
 285 #define EVT_AUINOTEBOOK_PAGE_BUTTON(winid, fn) \
 286     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BUTTON, winid, wxAuiNotebookEventHandler(fn))
 287 #define EVT_AUINOTEBOOK_BEGIN_DRAG(winid, fn) \
 288     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, winid, wxAuiNotebookEventHandler(fn))
 289 #define EVT_AUINOTEBOOK_END_DRAG(winid, fn) \
 290     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, winid, wxAuiNotebookEventHandler(fn))
 291 #define EVT_AUINOTEBOOK_DRAG_MOTION(winid, fn) \
 292     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))
 293
 294 #else
 295
 296 // wxpython/swig event work
 297
 298
 299 #endif
 300
 301
 302 #endif  // wxUSE_AUI
 303 #endif  // _WX_AUINOTEBOOK_H_