1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/aui/auibook.h
3 // Purpose: wxaui: wx advanced user interface - notebook
4 // Author: Benjamin I. Williams
7 // Copyright: (C) Copyright 2006, Kirix Corporation, All Rights Reserved.
8 // Licence: wxWindows Library Licence, Version 3.1
9 ///////////////////////////////////////////////////////////////////////////////
13 #ifndef _WX_AUINOTEBOOK_H_
14 #define _WX_AUINOTEBOOK_H_
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
24 #include "wx/aui/framemanager.h"
25 #include "wx/aui/dockart.h"
26 #include "wx/aui/floatpane.h"
27 #include "wx/control.h"
33 enum wxAuiNotebookOption
35 wxAUI_NB_TOP
= 1 << 0,
36 wxAUI_NB_LEFT
= 1 << 1, // not implemented yet
37 wxAUI_NB_RIGHT
= 1 << 2, // not implemented yet
38 wxAUI_NB_BOTTOM
= 1 << 3, // not implemented yet
39 wxAUI_NB_TAB_SPLIT
= 1 << 4,
40 wxAUI_NB_TAB_MOVE
= 1 << 5,
41 wxAUI_NB_TAB_EXTERNAL_MOVE
= 1 << 6,
42 wxAUI_NB_TAB_FIXED_WIDTH
= 1 << 7,
43 wxAUI_NB_SCROLL_BUTTONS
= 1 << 8,
44 wxAUI_NB_WINDOWLIST_BUTTON
= 1 << 9,
45 wxAUI_NB_CLOSE_BUTTON
= 1 << 10,
46 wxAUI_NB_CLOSE_ON_ACTIVE_TAB
= 1 << 11,
47 wxAUI_NB_CLOSE_ON_ALL_TABS
= 1 << 12,
50 wxAUI_NB_DEFAULT_STYLE
= wxAUI_NB_TOP
|
53 wxAUI_NB_SCROLL_BUTTONS
|
54 wxAUI_NB_CLOSE_ON_ACTIVE_TAB
60 // aui notebook event class
62 class WXDLLIMPEXP_AUI wxAuiNotebookEvent
: public wxNotifyEvent
65 wxAuiNotebookEvent(wxEventType command_type
= wxEVT_NULL
,
67 : wxNotifyEvent(command_type
, win_id
)
74 wxAuiNotebookEvent(const wxAuiNotebookEvent
& c
) : wxNotifyEvent(c
)
76 old_selection
= c
.old_selection
;
77 selection
= c
.selection
;
78 drag_source
= c
.drag_source
;
81 wxEvent
*Clone() const { return new wxAuiNotebookEvent(*this); }
83 void SetSelection(int s
) { selection
= s
; m_commandInt
= s
; }
84 int GetSelection() const { return selection
; }
86 void SetOldSelection(int s
) { old_selection
= s
; }
87 int GetOldSelection() const { return old_selection
; }
89 void SetDragSource(wxAuiNotebook
* s
) { drag_source
= s
; }
90 wxAuiNotebook
* GetDragSource() const { return drag_source
; }
95 wxAuiNotebook
* drag_source
;
99 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent
)
104 class WXDLLIMPEXP_AUI wxAuiNotebookPage
107 wxWindow
* window
; // page's associated window
108 wxString caption
; // caption displayed on the tab
109 wxBitmap bitmap
; // tab's bitmap
110 wxRect rect
; // tab's hit rectangle
111 bool active
; // true if the page is currently active
114 class WXDLLIMPEXP_AUI wxAuiTabContainerButton
118 int id
; // button's id
119 int cur_state
; // current state (normal, hover, pressed, etc.)
120 int location
; // buttons location (wxLEFT, wxRIGHT, or wxCENTER)
121 wxBitmap bitmap
; // button's hover bitmap
122 wxBitmap dis_bitmap
; // button's disabled bitmap
123 wxRect rect
; // button's hit rectangle
128 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage
, wxAuiNotebookPageArray
, WXDLLIMPEXP_AUI
);
129 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton
, wxAuiTabContainerButtonArray
, WXDLLIMPEXP_AUI
);
135 class WXDLLIMPEXP_AUI wxAuiTabArt
140 virtual ~wxAuiTabArt() { }
142 virtual wxAuiTabArt
* Clone() = 0;
143 virtual void SetFlags(unsigned int flags
) = 0;
145 virtual void SetSizingInfo(const wxSize
& tab_ctrl_size
,
146 size_t tab_count
) = 0;
148 virtual void SetNormalFont(const wxFont
& font
) = 0;
149 virtual void SetSelectedFont(const wxFont
& font
) = 0;
150 virtual void SetMeasuringFont(const wxFont
& font
) = 0;
152 virtual void DrawBackground(
155 const wxRect
& rect
) = 0;
157 virtual void DrawTab(wxDC
& dc
,
159 const wxRect
& in_rect
,
160 const wxString
& caption
,
161 const wxBitmap
& bitmap
,
163 int close_button_state
,
164 wxRect
* out_tab_rect
,
165 wxRect
* out_button_rect
,
168 virtual void DrawButton(
171 const wxRect
& in_rect
,
175 const wxBitmap
& bitmap_override
,
176 wxRect
* out_rect
) = 0;
178 virtual int GetIndentSize() = 0;
180 virtual wxSize
GetTabSize(
183 const wxString
& caption
,
184 const wxBitmap
& bitmap
,
186 int close_button_state
,
189 virtual int ShowWindowList(
191 const wxArrayString
& items
,
194 virtual int GetBestTabCtrlSize(wxWindow
* wnd
,
195 wxAuiNotebookPageArray
& pages
) = 0;
199 class WXDLLIMPEXP_AUI wxAuiDefaultTabArt
: public wxAuiTabArt
204 wxAuiDefaultTabArt();
205 virtual ~wxAuiDefaultTabArt();
207 wxAuiTabArt
* Clone();
208 void SetFlags(unsigned int flags
);
209 void SetSizingInfo(const wxSize
& tab_ctrl_size
,
212 void SetNormalFont(const wxFont
& font
);
213 void SetSelectedFont(const wxFont
& font
);
214 void SetMeasuringFont(const wxFont
& font
);
221 void DrawTab(wxDC
& dc
,
223 const wxRect
& in_rect
,
224 const wxString
& caption
,
225 const wxBitmap
& bitmap
,
227 int close_button_state
,
228 wxRect
* out_tab_rect
,
229 wxRect
* out_button_rect
,
235 const wxRect
& in_rect
,
239 const wxBitmap
& bitmap_override
,
247 const wxString
& caption
,
248 const wxBitmap
& bitmap
,
250 int close_button_state
,
255 const wxArrayString
& items
,
258 int GetBestTabCtrlSize(wxWindow
* wnd
,
259 wxAuiNotebookPageArray
& pages
);
263 wxFont m_normal_font
;
264 wxFont m_selected_font
;
265 wxFont m_measuring_font
;
266 wxColour m_base_colour
;
267 wxPen m_base_colour_pen
;
268 wxBrush m_base_colour_brush
;
269 wxBitmap m_active_close_bmp
;
270 wxBitmap m_disabled_close_bmp
;
271 wxBitmap m_active_left_bmp
;
272 wxBitmap m_disabled_left_bmp
;
273 wxBitmap m_active_right_bmp
;
274 wxBitmap m_disabled_right_bmp
;
275 wxBitmap m_active_windowlist_bmp
;
276 wxBitmap m_disabled_windowlist_bmp
;
278 int m_fixed_tab_width
;
279 int m_tab_ctrl_height
;
280 unsigned int m_flags
;
284 class WXDLLIMPEXP_AUI wxAuiSimpleTabArt
: public wxAuiTabArt
290 virtual ~wxAuiSimpleTabArt();
292 wxAuiTabArt
* Clone();
293 void SetFlags(unsigned int flags
);
295 void SetSizingInfo(const wxSize
& tab_ctrl_size
,
298 void SetNormalFont(const wxFont
& font
);
299 void SetSelectedFont(const wxFont
& font
);
300 void SetMeasuringFont(const wxFont
& font
);
307 void DrawTab(wxDC
& dc
,
309 const wxRect
& in_rect
,
310 const wxString
& caption
,
311 const wxBitmap
& bitmap
,
313 int close_button_state
,
314 wxRect
* out_tab_rect
,
315 wxRect
* out_button_rect
,
321 const wxRect
& in_rect
,
325 const wxBitmap
& bitmap_override
,
333 const wxString
& caption
,
334 const wxBitmap
& bitmap
,
336 int close_button_state
,
341 const wxArrayString
& items
,
344 int GetBestTabCtrlSize(wxWindow
* wnd
,
345 wxAuiNotebookPageArray
& pages
);
349 wxFont m_normal_font
;
350 wxFont m_selected_font
;
351 wxFont m_measuring_font
;
352 wxPen m_normal_bkpen
;
353 wxPen m_selected_bkpen
;
354 wxBrush m_normal_bkbrush
;
355 wxBrush m_selected_bkbrush
;
357 wxBitmap m_active_close_bmp
;
358 wxBitmap m_disabled_close_bmp
;
359 wxBitmap m_active_left_bmp
;
360 wxBitmap m_disabled_left_bmp
;
361 wxBitmap m_active_right_bmp
;
362 wxBitmap m_disabled_right_bmp
;
363 wxBitmap m_active_windowlist_bmp
;
364 wxBitmap m_disabled_windowlist_bmp
;
366 int m_fixed_tab_width
;
367 unsigned int m_flags
;
378 class WXDLLIMPEXP_AUI wxAuiTabContainer
383 virtual ~wxAuiTabContainer();
385 void SetArtProvider(wxAuiTabArt
* art
);
386 wxAuiTabArt
* GetArtProvider() const;
388 void SetFlags(unsigned int flags
);
389 unsigned int GetFlags() const;
391 bool AddPage(wxWindow
* page
, const wxAuiNotebookPage
& info
);
392 bool InsertPage(wxWindow
* page
, const wxAuiNotebookPage
& info
, size_t idx
);
393 bool MovePage(wxWindow
* page
, size_t new_idx
);
394 bool RemovePage(wxWindow
* page
);
395 bool SetActivePage(wxWindow
* page
);
396 bool SetActivePage(size_t page
);
397 void SetNoneActive();
398 int GetActivePage() const;
399 bool TabHitTest(int x
, int y
, wxWindow
** hit
) const;
400 bool ButtonHitTest(int x
, int y
, wxAuiTabContainerButton
** hit
) const;
401 wxWindow
* GetWindowFromIdx(size_t idx
) const;
402 int GetIdxFromWindow(wxWindow
* page
) const;
403 size_t GetPageCount() const;
404 wxAuiNotebookPage
& GetPage(size_t idx
);
405 wxAuiNotebookPageArray
& GetPages();
406 void SetNormalFont(const wxFont
& normal_font
);
407 void SetSelectedFont(const wxFont
& selected_font
);
408 void SetMeasuringFont(const wxFont
& measuring_font
);
410 void SetRect(const wxRect
& rect
);
412 void RemoveButton(int id
);
413 void AddButton(int id
,
415 const wxBitmap
& normal_bitmap
= wxNullBitmap
,
416 const wxBitmap
& disabled_bitmap
= wxNullBitmap
);
418 size_t GetTabOffset() const;
419 void SetTabOffset(size_t offset
);
423 virtual void Render(wxDC
* dc
, wxWindow
* wnd
);
428 wxAuiNotebookPageArray m_pages
;
429 wxAuiTabContainerButtonArray m_buttons
;
430 wxAuiTabContainerButtonArray m_tab_close_buttons
;
433 unsigned int m_flags
;
438 class WXDLLIMPEXP_AUI wxAuiTabCtrl
: public wxControl
,
439 public wxAuiTabContainer
443 wxAuiTabCtrl(wxWindow
* parent
,
444 wxWindowID id
= wxID_ANY
,
445 const wxPoint
& pos
= wxDefaultPosition
,
446 const wxSize
& size
= wxDefaultSize
,
453 void OnPaint(wxPaintEvent
& evt
);
454 void OnEraseBackground(wxEraseEvent
& evt
);
455 void OnSize(wxSizeEvent
& evt
);
456 void OnLeftDown(wxMouseEvent
& evt
);
457 void OnLeftUp(wxMouseEvent
& evt
);
458 void OnMotion(wxMouseEvent
& evt
);
459 void OnLeaveWindow(wxMouseEvent
& evt
);
460 void OnButton(wxAuiNotebookEvent
& evt
);
466 wxWindow
* m_click_tab
;
468 wxAuiTabContainerButton
* m_hover_button
;
469 wxAuiTabContainerButton
* m_pressed_button
;
472 DECLARE_CLASS(wxAuiTabCtrl
)
473 DECLARE_EVENT_TABLE()
480 class WXDLLIMPEXP_AUI wxAuiNotebook
: public wxControl
487 wxAuiNotebook(wxWindow
* parent
,
488 wxWindowID id
= wxID_ANY
,
489 const wxPoint
& pos
= wxDefaultPosition
,
490 const wxSize
& size
= wxDefaultSize
,
491 long style
= wxAUI_NB_DEFAULT_STYLE
);
493 virtual ~wxAuiNotebook();
495 bool Create(wxWindow
* parent
,
496 wxWindowID id
= wxID_ANY
,
497 const wxPoint
& pos
= wxDefaultPosition
,
498 const wxSize
& size
= wxDefaultSize
,
501 bool AddPage(wxWindow
* page
,
502 const wxString
& caption
,
504 const wxBitmap
& bitmap
= wxNullBitmap
);
506 bool InsertPage(size_t page_idx
,
508 const wxString
& caption
,
510 const wxBitmap
& bitmap
= wxNullBitmap
);
512 bool DeletePage(size_t page
);
513 bool RemovePage(size_t page
);
515 void SetWindowStyleFlag(long style
);
517 bool SetPageText(size_t page
, const wxString
& text
);
518 bool SetPageBitmap(size_t page
, const wxBitmap
& bitmap
);
519 size_t SetSelection(size_t new_page
);
520 int GetSelection() const;
521 size_t GetPageCount() const;
522 wxWindow
* GetPage(size_t page_idx
) const;
524 int GetPageIndex(wxWindow
* page_wnd
) const;
526 void SetArtProvider(wxAuiTabArt
* art
);
527 wxAuiTabArt
* GetArtProvider() const;
531 // these can be overridden
532 virtual void SetTabCtrlHeight(int height
);
533 virtual int CalculateTabCtrlHeight();
538 void InitNotebook(long style
);
539 wxAuiTabCtrl
* GetTabCtrlFromPoint(const wxPoint
& pt
);
540 wxWindow
* GetTabFrameFromTabCtrl(wxWindow
* tab_ctrl
);
541 wxAuiTabCtrl
* GetActiveTabCtrl();
542 bool FindTab(wxWindow
* page
, wxAuiTabCtrl
** ctrl
, int* idx
);
543 void RemoveEmptyTabFrames();
548 void OnChildFocus(wxChildFocusEvent
& evt
);
549 void OnRender(wxAuiManagerEvent
& evt
);
550 void OnEraseBackground(wxEraseEvent
& evt
);
551 void OnSize(wxSizeEvent
& evt
);
552 void OnTabClicked(wxCommandEvent
& evt
);
553 void OnTabBeginDrag(wxCommandEvent
& evt
);
554 void OnTabDragMotion(wxCommandEvent
& evt
);
555 void OnTabEndDrag(wxCommandEvent
& evt
);
556 void OnTabButton(wxCommandEvent
& evt
);
561 wxAuiTabContainer m_tabs
;
563 int m_tab_id_counter
;
564 wxWindow
* m_dummy_wnd
;
566 wxFont m_selected_font
;
567 wxFont m_normal_font
;
568 int m_tab_ctrl_height
;
571 unsigned int m_flags
;
574 DECLARE_CLASS(wxAuiNotebook
)
575 DECLARE_EVENT_TABLE()
582 // wx event machinery
586 BEGIN_DECLARE_EVENT_TYPES()
587 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
, 0)
588 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 0)
589 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 0)
590 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 0)
591 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 0)
592 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 0)
593 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 0)
594 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
, 0)
595 END_DECLARE_EVENT_TYPES()
597 typedef void (wxEvtHandler
::*wxAuiNotebookEventFunction
)(wxAuiNotebookEvent
&);
599 #define wxAuiNotebookEventHandler(func) \
600 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiNotebookEventFunction, &func)
602 #define EVT_AUINOTEBOOK_PAGE_CLOSE(winid, fn) \
603 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE, winid, wxAuiNotebookEventHandler(fn))
604 #define EVT_AUINOTEBOOK_PAGE_CHANGED(winid, fn) \
605 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, winid, wxAuiNotebookEventHandler(fn))
606 #define EVT_AUINOTEBOOK_PAGE_CHANGING(winid, fn) \
607 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, winid, wxAuiNotebookEventHandler(fn))
608 #define EVT_AUINOTEBOOK_BUTTON(winid, fn) \
609 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BUTTON, winid, wxAuiNotebookEventHandler(fn))
610 #define EVT_AUINOTEBOOK_BEGIN_DRAG(winid, fn) \
611 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, winid, wxAuiNotebookEventHandler(fn))
612 #define EVT_AUINOTEBOOK_END_DRAG(winid, fn) \
613 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, winid, wxAuiNotebookEventHandler(fn))
614 #define EVT_AUINOTEBOOK_DRAG_MOTION(winid, fn) \
615 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))
616 #define EVT_AUINOTEBOOK_ALLOW_DND(winid, fn) \
617 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND, winid, wxAuiNotebookEventHandler(fn))
621 // wxpython/swig event work
622 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
;
623 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
;
624 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
;
625 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BUTTON
;
626 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
;
627 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
;
628 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
;
629 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
;
632 EVT_AUINOTEBOOK_PAGE_CLOSE
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
, 1 )
633 EVT_AUINOTEBOOK_PAGE_CHANGED
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 1 )
634 EVT_AUINOTEBOOK_PAGE_CHANGING
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 1 )
635 EVT_AUINOTEBOOK_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 1 )
636 EVT_AUINOTEBOOK_BEGIN_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 1 )
637 EVT_AUINOTEBOOK_END_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 1 )
638 EVT_AUINOTEBOOK_DRAG_MOTION
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 1 )
639 EVT_AUINOTEBOOK_ALLOW_DND
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
, 1 )
645 #endif // _WX_AUINOTEBOOK_H_