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 wxAuiNotebookPage
& pane
,
160 const wxRect
& in_rect
,
161 int close_button_state
,
162 wxRect
* out_tab_rect
,
163 wxRect
* out_button_rect
,
166 virtual void DrawButton(
169 const wxRect
& in_rect
,
173 wxRect
* out_rect
) = 0;
175 virtual wxSize
GetTabSize(
178 const wxString
& caption
,
179 const wxBitmap
& bitmap
,
181 int close_button_state
,
184 virtual int ShowDropDown(
186 const wxAuiNotebookPageArray
& items
,
189 virtual int GetIndentSize() = 0;
191 virtual int GetBestTabCtrlSize(
193 const wxAuiNotebookPageArray
& pages
,
194 const wxSize
& required_bmp_size
) = 0;
198 class WXDLLIMPEXP_AUI wxAuiDefaultTabArt
: public wxAuiTabArt
203 wxAuiDefaultTabArt();
204 virtual ~wxAuiDefaultTabArt();
206 wxAuiTabArt
* Clone();
207 void SetFlags(unsigned int flags
);
208 void SetSizingInfo(const wxSize
& tab_ctrl_size
,
211 void SetNormalFont(const wxFont
& font
);
212 void SetSelectedFont(const wxFont
& font
);
213 void SetMeasuringFont(const wxFont
& font
);
220 void DrawTab(wxDC
& dc
,
222 const wxAuiNotebookPage
& pane
,
223 const wxRect
& in_rect
,
224 int close_button_state
,
225 wxRect
* out_tab_rect
,
226 wxRect
* out_button_rect
,
232 const wxRect
& in_rect
,
243 const wxString
& caption
,
244 const wxBitmap
& bitmap
,
246 int close_button_state
,
251 const wxAuiNotebookPageArray
& items
,
254 int GetBestTabCtrlSize(wxWindow
* wnd
,
255 const wxAuiNotebookPageArray
& pages
,
256 const wxSize
& required_bmp_size
);
260 wxFont m_normal_font
;
261 wxFont m_selected_font
;
262 wxFont m_measuring_font
;
263 wxColour m_base_colour
;
264 wxPen m_base_colour_pen
;
266 wxBrush m_base_colour_brush
;
267 wxBitmap m_active_close_bmp
;
268 wxBitmap m_disabled_close_bmp
;
269 wxBitmap m_active_left_bmp
;
270 wxBitmap m_disabled_left_bmp
;
271 wxBitmap m_active_right_bmp
;
272 wxBitmap m_disabled_right_bmp
;
273 wxBitmap m_active_windowlist_bmp
;
274 wxBitmap m_disabled_windowlist_bmp
;
276 int m_fixed_tab_width
;
277 int m_tab_ctrl_height
;
278 unsigned int m_flags
;
282 class WXDLLIMPEXP_AUI wxAuiSimpleTabArt
: public wxAuiTabArt
288 virtual ~wxAuiSimpleTabArt();
290 wxAuiTabArt
* Clone();
291 void SetFlags(unsigned int flags
);
293 void SetSizingInfo(const wxSize
& tab_ctrl_size
,
296 void SetNormalFont(const wxFont
& font
);
297 void SetSelectedFont(const wxFont
& font
);
298 void SetMeasuringFont(const wxFont
& font
);
305 void DrawTab(wxDC
& dc
,
307 const wxAuiNotebookPage
& pane
,
308 const wxRect
& in_rect
,
309 int close_button_state
,
310 wxRect
* out_tab_rect
,
311 wxRect
* out_button_rect
,
317 const wxRect
& in_rect
,
328 const wxString
& caption
,
329 const wxBitmap
& bitmap
,
331 int close_button_state
,
336 const wxAuiNotebookPageArray
& items
,
339 int GetBestTabCtrlSize(wxWindow
* wnd
,
340 const wxAuiNotebookPageArray
& pages
,
341 const wxSize
& required_bmp_size
);
345 wxFont m_normal_font
;
346 wxFont m_selected_font
;
347 wxFont m_measuring_font
;
348 wxPen m_normal_bkpen
;
349 wxPen m_selected_bkpen
;
350 wxBrush m_normal_bkbrush
;
351 wxBrush m_selected_bkbrush
;
353 wxBitmap m_active_close_bmp
;
354 wxBitmap m_disabled_close_bmp
;
355 wxBitmap m_active_left_bmp
;
356 wxBitmap m_disabled_left_bmp
;
357 wxBitmap m_active_right_bmp
;
358 wxBitmap m_disabled_right_bmp
;
359 wxBitmap m_active_windowlist_bmp
;
360 wxBitmap m_disabled_windowlist_bmp
;
362 int m_fixed_tab_width
;
363 unsigned int m_flags
;
374 class WXDLLIMPEXP_AUI wxAuiTabContainer
379 virtual ~wxAuiTabContainer();
381 void SetArtProvider(wxAuiTabArt
* art
);
382 wxAuiTabArt
* GetArtProvider() const;
384 void SetFlags(unsigned int flags
);
385 unsigned int GetFlags() const;
387 bool AddPage(wxWindow
* page
, const wxAuiNotebookPage
& info
);
388 bool InsertPage(wxWindow
* page
, const wxAuiNotebookPage
& info
, size_t idx
);
389 bool MovePage(wxWindow
* page
, size_t new_idx
);
390 bool RemovePage(wxWindow
* page
);
391 bool SetActivePage(wxWindow
* page
);
392 bool SetActivePage(size_t page
);
393 void SetNoneActive();
394 int GetActivePage() const;
395 bool TabHitTest(int x
, int y
, wxWindow
** hit
) const;
396 bool ButtonHitTest(int x
, int y
, wxAuiTabContainerButton
** hit
) const;
397 wxWindow
* GetWindowFromIdx(size_t idx
) const;
398 int GetIdxFromWindow(wxWindow
* page
) const;
399 size_t GetPageCount() const;
400 wxAuiNotebookPage
& GetPage(size_t idx
);
401 const wxAuiNotebookPage
& GetPage(size_t idx
) const;
402 wxAuiNotebookPageArray
& GetPages();
403 void SetNormalFont(const wxFont
& normal_font
);
404 void SetSelectedFont(const wxFont
& selected_font
);
405 void SetMeasuringFont(const wxFont
& measuring_font
);
407 void SetRect(const wxRect
& rect
);
409 void RemoveButton(int id
);
410 void AddButton(int id
,
412 const wxBitmap
& normal_bitmap
= wxNullBitmap
,
413 const wxBitmap
& disabled_bitmap
= wxNullBitmap
);
415 size_t GetTabOffset() const;
416 void SetTabOffset(size_t offset
);
420 virtual void Render(wxDC
* dc
, wxWindow
* wnd
);
425 wxAuiNotebookPageArray m_pages
;
426 wxAuiTabContainerButtonArray m_buttons
;
427 wxAuiTabContainerButtonArray m_tab_close_buttons
;
430 unsigned int m_flags
;
435 class WXDLLIMPEXP_AUI wxAuiTabCtrl
: public wxControl
,
436 public wxAuiTabContainer
440 wxAuiTabCtrl(wxWindow
* parent
,
441 wxWindowID id
= wxID_ANY
,
442 const wxPoint
& pos
= wxDefaultPosition
,
443 const wxSize
& size
= wxDefaultSize
,
450 void OnPaint(wxPaintEvent
& evt
);
451 void OnEraseBackground(wxEraseEvent
& evt
);
452 void OnSize(wxSizeEvent
& evt
);
453 void OnLeftDown(wxMouseEvent
& evt
);
454 void OnLeftUp(wxMouseEvent
& evt
);
455 void OnMotion(wxMouseEvent
& evt
);
456 void OnLeaveWindow(wxMouseEvent
& evt
);
457 void OnButton(wxAuiNotebookEvent
& evt
);
463 wxWindow
* m_click_tab
;
465 wxAuiTabContainerButton
* m_hover_button
;
466 wxAuiTabContainerButton
* m_pressed_button
;
469 DECLARE_CLASS(wxAuiTabCtrl
)
470 DECLARE_EVENT_TABLE()
477 class WXDLLIMPEXP_AUI wxAuiNotebook
: public wxControl
484 wxAuiNotebook(wxWindow
* parent
,
485 wxWindowID id
= wxID_ANY
,
486 const wxPoint
& pos
= wxDefaultPosition
,
487 const wxSize
& size
= wxDefaultSize
,
488 long style
= wxAUI_NB_DEFAULT_STYLE
);
490 virtual ~wxAuiNotebook();
492 bool Create(wxWindow
* parent
,
493 wxWindowID id
= wxID_ANY
,
494 const wxPoint
& pos
= wxDefaultPosition
,
495 const wxSize
& size
= wxDefaultSize
,
498 void SetWindowStyleFlag(long style
);
499 void SetArtProvider(wxAuiTabArt
* art
);
500 wxAuiTabArt
* GetArtProvider() const;
502 virtual void SetUniformBitmapSize(const wxSize
& size
);
503 virtual void SetTabCtrlHeight(int height
);
505 bool AddPage(wxWindow
* page
,
506 const wxString
& caption
,
508 const wxBitmap
& bitmap
= wxNullBitmap
);
510 bool InsertPage(size_t page_idx
,
512 const wxString
& caption
,
514 const wxBitmap
& bitmap
= wxNullBitmap
);
516 bool DeletePage(size_t page
);
517 bool RemovePage(size_t page
);
519 size_t GetPageCount() const;
520 wxWindow
* GetPage(size_t page_idx
) const;
521 int GetPageIndex(wxWindow
* page_wnd
) const;
523 bool SetPageText(size_t page
, const wxString
& text
);
524 wxString
GetPageText(size_t page_idx
) const;
526 bool SetPageBitmap(size_t page
, const wxBitmap
& bitmap
);
527 wxBitmap
GetPageBitmap(size_t page_idx
) const;
529 size_t SetSelection(size_t new_page
);
530 int GetSelection() const;
532 virtual void Split(size_t page
, int direction
);
534 #if wxABI_VERSION >= 20801
535 const wxAuiManager
& GetAuiManager() const { return m_mgr
; }
540 // these can be overridden
541 virtual void UpdateTabCtrlHeight();
542 virtual int CalculateTabCtrlHeight();
543 virtual wxSize
CalculateNewSplitSize();
548 void InitNotebook(long style
);
549 wxAuiTabCtrl
* GetTabCtrlFromPoint(const wxPoint
& pt
);
550 wxWindow
* GetTabFrameFromTabCtrl(wxWindow
* tab_ctrl
);
551 wxAuiTabCtrl
* GetActiveTabCtrl();
552 bool FindTab(wxWindow
* page
, wxAuiTabCtrl
** ctrl
, int* idx
);
553 void RemoveEmptyTabFrames();
554 void UpdateHintWindowSize();
558 void OnChildFocus(wxChildFocusEvent
& evt
);
559 void OnRender(wxAuiManagerEvent
& evt
);
560 void OnSize(wxSizeEvent
& evt
);
561 void OnTabClicked(wxCommandEvent
& evt
);
562 void OnTabBeginDrag(wxCommandEvent
& evt
);
563 void OnTabDragMotion(wxCommandEvent
& evt
);
564 void OnTabEndDrag(wxCommandEvent
& evt
);
565 void OnTabButton(wxCommandEvent
& evt
);
570 wxAuiTabContainer m_tabs
;
572 int m_tab_id_counter
;
573 wxWindow
* m_dummy_wnd
;
575 wxSize m_requested_bmp_size
;
576 int m_requested_tabctrl_height
;
577 wxFont m_selected_font
;
578 wxFont m_normal_font
;
579 int m_tab_ctrl_height
;
582 unsigned int m_flags
;
585 DECLARE_CLASS(wxAuiNotebook
)
586 DECLARE_EVENT_TABLE()
593 // wx event machinery
597 BEGIN_DECLARE_EVENT_TYPES()
598 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
, 0)
599 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 0)
600 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 0)
601 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 0)
602 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 0)
603 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 0)
604 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 0)
605 DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI
, wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
, 0)
606 END_DECLARE_EVENT_TYPES()
608 typedef void (wxEvtHandler::*wxAuiNotebookEventFunction
)(wxAuiNotebookEvent
&);
610 #define wxAuiNotebookEventHandler(func) \
611 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiNotebookEventFunction, &func)
613 #define EVT_AUINOTEBOOK_PAGE_CLOSE(winid, fn) \
614 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE, winid, wxAuiNotebookEventHandler(fn))
615 #define EVT_AUINOTEBOOK_PAGE_CHANGED(winid, fn) \
616 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, winid, wxAuiNotebookEventHandler(fn))
617 #define EVT_AUINOTEBOOK_PAGE_CHANGING(winid, fn) \
618 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, winid, wxAuiNotebookEventHandler(fn))
619 #define EVT_AUINOTEBOOK_BUTTON(winid, fn) \
620 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BUTTON, winid, wxAuiNotebookEventHandler(fn))
621 #define EVT_AUINOTEBOOK_BEGIN_DRAG(winid, fn) \
622 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, winid, wxAuiNotebookEventHandler(fn))
623 #define EVT_AUINOTEBOOK_END_DRAG(winid, fn) \
624 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, winid, wxAuiNotebookEventHandler(fn))
625 #define EVT_AUINOTEBOOK_DRAG_MOTION(winid, fn) \
626 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))
627 #define EVT_AUINOTEBOOK_ALLOW_DND(winid, fn) \
628 wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND, winid, wxAuiNotebookEventHandler(fn))
632 // wxpython/swig event work
633 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
;
634 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
;
635 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
;
636 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BUTTON
;
637 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
;
638 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
;
639 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
;
640 %constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
;
643 EVT_AUINOTEBOOK_PAGE_CLOSE
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE
, 1 )
644 EVT_AUINOTEBOOK_PAGE_CHANGED
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED
, 1 )
645 EVT_AUINOTEBOOK_PAGE_CHANGING
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING
, 1 )
646 EVT_AUINOTEBOOK_BUTTON
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON
, 1 )
647 EVT_AUINOTEBOOK_BEGIN_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG
, 1 )
648 EVT_AUINOTEBOOK_END_DRAG
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG
, 1 )
649 EVT_AUINOTEBOOK_DRAG_MOTION
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION
, 1 )
650 EVT_AUINOTEBOOK_ALLOW_DND
= wx
.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND
, 1 )
656 #endif // _WX_AUINOTEBOOK_H_