add a header placeholder

[wxWidgets.git] / include / wx / aui / auibook.h

diff --git a/include/wx/aui/auibook.h b/include/wx/aui/auibook.h
index 93a4bd082c6cb4233047660d1efe25d0902d44cc..bbe5b596a5f3cc3d7467d3452df7dd449de9aecf 100644 (file)
--- a/include/wx/aui/auibook.h
+++ b/include/wx/aui/auibook.h
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        wx/aui/notebook.h
+// Name:        wx/aui/auibook.h

 // Purpose:     wxaui: wx advanced user interface - notebook
 // Author:      Benjamin I. Williams
 // Modified by:
 // Purpose:     wxaui: wx advanced user interface - notebook
 // Author:      Benjamin I. Williams
 // Modified by:


@@ -18,12 +18,168 @@
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"
 // ----------------------------------------------------------------------------
 
 #include "wx/defs.h"

+
+#if wxUSE_AUI
+

 #include "wx/aui/framemanager.h"
 #include "wx/aui/dockart.h"
 #include "wx/aui/floatpane.h"
 #include "wx/aui/framemanager.h"
 #include "wx/aui/dockart.h"
 #include "wx/aui/floatpane.h"

+#include "wx/control.h"

 
 
 
 

-#if wxUSE_AUI
+
+enum wxAuiNotebookOption
+{
+    wxAUI_NB_TOP                 = 1 << 0,
+    wxAUI_NB_LEFT                = 1 << 1,  // not implemented yet
+    wxAUI_NB_RIGHT               = 1 << 2,  // not implemented yet
+    wxAUI_NB_BOTTOM              = 1 << 3,  // not implemented yet
+    wxAUI_NB_TAB_SPLIT           = 1 << 4,
+    wxAUI_NB_TAB_MOVE            = 1 << 5,
+    wxAUI_NB_SCROLL_BUTTONS      = 1 << 6,
+    wxAUI_NB_WINDOWLIST_BUTTON   = 1 << 7,
+    wxAUI_NB_CLOSE_BUTTON        = 1 << 8,
+    wxAUI_NB_CLOSE_ON_ACTIVE_TAB = 1 << 9,
+    wxAUI_NB_CLOSE_ON_ALL_TABS   = 1 << 10,
+    
+    wxAUI_NB_DEFAULT_STYLE = wxAUI_NB_TOP |
+                             wxAUI_NB_TAB_SPLIT |
+                             wxAUI_NB_TAB_MOVE |
+                             wxAUI_NB_SCROLL_BUTTONS |
+                             wxAUI_NB_CLOSE_ON_ACTIVE_TAB
+};
+
+
+
+
+
+// tab art class
+
+class WXDLLIMPEXP_AUI wxAuiTabArt
+{
+public:
+
+    wxAuiTabArt() { }
+    virtual ~wxAuiTabArt() { }
+    
+    virtual void SetNormalFont(const wxFont& font) = 0;
+    virtual void SetSelectedFont(const wxFont& font) = 0;
+    virtual void SetMeasuringFont(const wxFont& font) = 0;
+
+    virtual void DrawBackground(
+                         wxDC& dc,
+                         wxWindow* wnd,
+                         const wxRect& rect) = 0;
+
+    virtual void DrawTab(wxDC& dc,
+                         wxWindow* wnd,
+                         const wxRect& in_rect,
+                         const wxString& caption,
+                         bool active,
+                         int close_button_state,
+                         wxRect* out_tab_rect,
+                         wxRect* out_button_rect,
+                         int* x_extent) = 0;     
+    
+    virtual void DrawButton(
+                         wxDC& dc,
+                         wxWindow* wnd,
+                         const wxRect& in_rect,
+                         int bitmap_id,
+                         int button_state,
+                         int orientation,
+                         const wxBitmap& bitmap_override,
+                         wxRect* out_rect) = 0;
+                 
+    virtual wxSize GetTabSize(
+                         wxDC& dc,
+                         wxWindow* wnd,
+                         const wxString& caption,
+                         bool active,
+                         int close_button_state,
+                         int* x_extent) = 0;
+                         
+    virtual int ShowWindowList(
+                         wxWindow* wnd,
+                         const wxArrayString& items,
+                         int active_idx) = 0;
+    
+    virtual int GetBestTabCtrlSize(wxWindow* wnd) = 0;    
+};
+
+
+class WXDLLIMPEXP_AUI wxAuiDefaultTabArt : public wxAuiTabArt
+{
+
+public:
+
+    wxAuiDefaultTabArt();
+    virtual ~wxAuiDefaultTabArt();
+    
+    void SetWindow(wxWindow* wnd);
+    void SetNormalFont(const wxFont& font);
+    void SetSelectedFont(const wxFont& font);
+    void SetMeasuringFont(const wxFont& font);
+    
+    void DrawBackground(
+                 wxDC& dc,
+                 wxWindow* wnd,
+                 const wxRect& rect);
+
+    void DrawTab(wxDC& dc,
+                 wxWindow* wnd,
+                 const wxRect& in_rect,
+                 const wxString& caption,
+                 bool active,
+                 int close_button_state,
+                 wxRect* out_tab_rect,
+                 wxRect* out_button_rect,
+                 int* x_extent);
+    
+    void DrawButton(
+                 wxDC& dc,
+                 wxWindow* wnd,
+                 const wxRect& in_rect,
+                 int bitmap_id,
+                 int button_state,
+                 int orientation,
+                 const wxBitmap& bitmap_override,
+                 wxRect* out_rect);
+                 
+    wxSize GetTabSize(
+                 wxDC& dc,
+                 wxWindow* wnd,
+                 const wxString& caption,
+                 bool active,
+                 int close_button_state,
+                 int* x_extent);
+                  
+    int ShowWindowList(
+                 wxWindow* wnd,
+                 const wxArrayString& items,
+                 int active_idx);
+
+    int GetBestTabCtrlSize(wxWindow* wnd);    
+
+private:
+
+    wxFont m_normal_font;
+    wxFont m_selected_font;
+    wxFont m_measuring_font;
+    wxPen m_normal_bkpen;
+    wxPen m_selected_bkpen;
+    wxBrush m_normal_bkbrush;
+    wxBrush m_selected_bkbrush;
+    wxBrush m_bkbrush;
+    wxBitmap m_active_close_bmp;
+    wxBitmap m_disabled_close_bmp;
+    wxBitmap m_active_left_bmp;
+    wxBitmap m_disabled_left_bmp;
+    wxBitmap m_active_right_bmp;
+    wxBitmap m_disabled_right_bmp;
+    wxBitmap m_active_windowlist_bmp;
+    wxBitmap m_disabled_windowlist_bmp;
+};

 
 
 
 
 
 


@@ -46,15 +202,15 @@ public:
 #endif
     wxEvent *Clone() const { return new wxAuiNotebookEvent(*this); }
 
 #endif
     wxEvent *Clone() const { return new wxAuiNotebookEvent(*this); }
 

-    void SetSelection(int s) { selection = s; }
+    void SetSelection(int s) { selection = s; m_commandInt = s; }

     void SetOldSelection(int s) { old_selection = s; }
     int GetSelection() const { return selection; }
     int GetOldSelection() const { return old_selection; }
     void SetOldSelection(int s) { old_selection = s; }
     int GetSelection() const { return selection; }
     int GetOldSelection() const { return old_selection; }

-    
+

 public:
     int old_selection;
     int selection;
 public:
     int old_selection;
     int selection;

-    
+

 #ifndef SWIG
 private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent)
 #ifndef SWIG
 private:
     DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent)


@@ -78,16 +234,20 @@ public:
 class WXDLLIMPEXP_AUI wxAuiTabContainerButton
 {
 public:
 class WXDLLIMPEXP_AUI wxAuiTabContainerButton
 {
 public:

+

     int id;               // button's id
     int id;               // button's id

-    int cur_state;        // current state (normal, hover, pressed)
-    wxBitmap bitmap;      // button's bitmap
+    int cur_state;        // current state (normal, hover, pressed, etc.)
+    int location;         // buttons location (wxLEFT, wxRIGHT, or wxCENTER)
+    wxBitmap bitmap;      // button's hover bitmap
+    wxBitmap dis_bitmap;  // button's disabled bitmap

     wxRect rect;          // button's hit rectangle
 };
 
 
     wxRect rect;          // button's hit rectangle
 };
 
 

+#ifndef SWIG

 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage, wxAuiNotebookPageArray, WXDLLIMPEXP_AUI);
 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton, wxAuiTabContainerButtonArray, WXDLLIMPEXP_AUI);
 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage, wxAuiNotebookPageArray, WXDLLIMPEXP_AUI);
 WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton, wxAuiTabContainerButtonArray, WXDLLIMPEXP_AUI);

-
+#endif

 
 
 class WXDLLIMPEXP_AUI wxAuiTabContainer
 
 
 class WXDLLIMPEXP_AUI wxAuiTabContainer


@@ -95,9 +255,17 @@ class WXDLLIMPEXP_AUI wxAuiTabContainer
 public:
 
     wxAuiTabContainer();
 public:
 
     wxAuiTabContainer();

+    virtual ~wxAuiTabContainer();
+
+    void SetArtProvider(wxAuiTabArt* art);
+    wxAuiTabArt* GetArtProvider();
+
+    void SetFlags(unsigned int flags);
+    unsigned int GetFlags() const;

 
     bool AddPage(wxWindow* page, const wxAuiNotebookPage& info);
     bool InsertPage(wxWindow* page, const wxAuiNotebookPage& info, size_t idx);
 
     bool AddPage(wxWindow* page, const wxAuiNotebookPage& info);
     bool InsertPage(wxWindow* page, const wxAuiNotebookPage& info, size_t idx);

+    bool MovePage(wxWindow* page, size_t new_idx);

     bool RemovePage(wxWindow* page);
     bool SetActivePage(wxWindow* page);
     bool SetActivePage(size_t page);
     bool RemovePage(wxWindow* page);
     bool SetActivePage(wxWindow* page);
     bool SetActivePage(size_t page);


@@ -115,31 +283,29 @@ public:
     void SetMeasuringFont(const wxFont& measuring_font);
     void DoShowHide();
     void SetRect(const wxRect& rect);
     void SetMeasuringFont(const wxFont& measuring_font);
     void DoShowHide();
     void SetRect(const wxRect& rect);

-    void AddButton(int id, const wxBitmap& bmp);
+    
+    void RemoveButton(int id);
+    void AddButton(int id,
+                   int location,
+                   const wxBitmap& normal_bitmap = wxNullBitmap,
+                   const wxBitmap& disabled_bitmap = wxNullBitmap);
+
+    size_t GetTabOffset() const;
+    void SetTabOffset(size_t offset);

     
 protected:
 
     
 protected:
 

-    virtual void Render(wxDC* dc);   
+    virtual void Render(wxDC* dc, wxWindow* wnd);

 
 

-    virtual void DrawTab(wxDC* dc,
-                         const wxRect& in_rect,
-                         const wxString& caption,
-                         bool active,
-                         wxRect* out_rect,
-                         int* x_extent); 
-private:
+protected:

 
 

+    wxAuiTabArt* m_art;

     wxAuiNotebookPageArray m_pages;
     wxAuiTabContainerButtonArray m_buttons;
     wxAuiNotebookPageArray m_pages;
     wxAuiTabContainerButtonArray m_buttons;

+    wxAuiTabContainerButtonArray m_tab_close_buttons;

     wxRect m_rect;
     wxRect m_rect;

-    wxFont m_normal_font;
-    wxFont m_selected_font;
-    wxFont m_measuring_font;
-    wxPen m_normal_bkpen;
-    wxPen m_selected_bkpen;
-    wxBrush m_normal_bkbrush;
-    wxBrush m_selected_bkbrush;
-    wxBrush m_bkbrush;
+    size_t m_tab_offset;
+    unsigned int m_flags;

 };
 
 
 };
 
 


@@ -150,11 +316,13 @@ class WXDLLIMPEXP_AUI wxAuiTabCtrl : public wxControl,
 public:
 
     wxAuiTabCtrl(wxWindow* parent,
 public:
 
     wxAuiTabCtrl(wxWindow* parent,

-                 wxWindowID id,
+                 wxWindowID id = wxID_ANY,

                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0);
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
                  long style = 0);

-                 
+
+    ~wxAuiTabCtrl();
+    

 protected:
 
     void OnPaint(wxPaintEvent& evt);
 protected:
 
     void OnPaint(wxPaintEvent& evt);


@@ -164,76 +332,86 @@ protected:
     void OnLeftUp(wxMouseEvent& evt);
     void OnMotion(wxMouseEvent& evt);
     void OnLeaveWindow(wxMouseEvent& evt);
     void OnLeftUp(wxMouseEvent& evt);
     void OnMotion(wxMouseEvent& evt);
     void OnLeaveWindow(wxMouseEvent& evt);

+    void OnButton(wxAuiNotebookEvent& evt);
+

     
 protected:
     
 protected:

-    
+

     wxPoint m_click_pt;
     wxPoint m_click_pt;

-    int m_click_tab;
+    wxWindow* m_click_tab;

     bool m_is_dragging;
     wxAuiTabContainerButton* m_hover_button;
 
     bool m_is_dragging;
     wxAuiTabContainerButton* m_hover_button;
 

+#ifndef SWIG

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+#endif

 };
 
 
 
 
 };
 
 
 
 

-class WXDLLIMPEXP_AUI wxAuiMultiNotebook : public wxControl
+class WXDLLIMPEXP_AUI wxAuiNotebook : public wxControl

 {
 
 public:
 
 {
 
 public:
 

-    wxAuiMultiNotebook();
-    
-    wxAuiMultiNotebook(wxWindow* parent,
-                       wxWindowID id,
-                       const wxPoint& pos = wxDefaultPosition,
-                       const wxSize& size = wxDefaultSize,
-                       long style = 0);
-                       
-    virtual ~wxAuiMultiNotebook();
+    wxAuiNotebook();
+
+    wxAuiNotebook(wxWindow* parent,
+                  wxWindowID id = wxID_ANY,
+                  const wxPoint& pos = wxDefaultPosition,
+                  const wxSize& size = wxDefaultSize,
+                  long style = wxAUI_NB_DEFAULT_STYLE);
+
+    virtual ~wxAuiNotebook();

 
     bool Create(wxWindow* parent,
 
     bool Create(wxWindow* parent,

-                wxWindowID id,
+                wxWindowID id = wxID_ANY,

                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                long style = 0);            
+                long style = 0);

 
     bool AddPage(wxWindow* page,
                  const wxString& caption,
                  bool select = false,
                  const wxBitmap& bitmap = wxNullBitmap);
 
     bool AddPage(wxWindow* page,
                  const wxString& caption,
                  bool select = false,
                  const wxBitmap& bitmap = wxNullBitmap);

-                
+

     bool InsertPage(size_t page_idx,
                     wxWindow* page,
                     const wxString& caption,
                     bool select = false,
                     const wxBitmap& bitmap = wxNullBitmap);
     bool InsertPage(size_t page_idx,
                     wxWindow* page,
                     const wxString& caption,
                     bool select = false,
                     const wxBitmap& bitmap = wxNullBitmap);

-                    
+

     bool DeletePage(size_t page);
     bool RemovePage(size_t page);
     
     bool DeletePage(size_t page);
     bool RemovePage(size_t page);
     

+    void SetWindowStyleFlag(long style);
+

     bool SetPageText(size_t page, const wxString& text);
     size_t SetSelection(size_t new_page);
     int GetSelection() const;
     size_t GetPageCount() const;
     wxWindow* GetPage(size_t page_idx) const;
     bool SetPageText(size_t page, const wxString& text);
     size_t SetSelection(size_t new_page);
     int GetSelection() const;
     size_t GetPageCount() const;
     wxWindow* GetPage(size_t page_idx) const;

-    
+
+
+    void SetArtProvider(wxAuiTabArt* art);
+    wxAuiTabArt* GetArtProvider();
+

 protected:
 protected:

-    
+

     wxAuiTabCtrl* GetTabCtrlFromPoint(const wxPoint& pt);
     wxWindow* GetTabFrameFromTabCtrl(wxWindow* tab_ctrl);
     wxAuiTabCtrl* GetActiveTabCtrl();
     bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx);
     void RemoveEmptyTabFrames();
     wxAuiTabCtrl* GetTabCtrlFromPoint(const wxPoint& pt);
     wxWindow* GetTabFrameFromTabCtrl(wxWindow* tab_ctrl);
     wxAuiTabCtrl* GetActiveTabCtrl();
     bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx);
     void RemoveEmptyTabFrames();

-    
+

 protected:
 
     void DoSizing();
 protected:
 
     void DoSizing();

-    void InitNotebook();
-    
+    void InitNotebook(long style);
+

     void OnChildFocus(wxChildFocusEvent& evt);
     void OnChildFocus(wxChildFocusEvent& evt);

-    void OnRender(wxFrameManagerEvent& evt);
+    void OnRender(wxAuiManagerEvent& evt);

     void OnEraseBackground(wxEraseEvent& evt);
     void OnSize(wxSizeEvent& evt);
     void OnTabClicked(wxCommandEvent& evt);
     void OnEraseBackground(wxEraseEvent& evt);
     void OnSize(wxSizeEvent& evt);
     void OnTabClicked(wxCommandEvent& evt);


@@ -241,19 +419,26 @@ protected:
     void OnTabDragMotion(wxCommandEvent& evt);
     void OnTabEndDrag(wxCommandEvent& evt);
     void OnTabButton(wxCommandEvent& evt);
     void OnTabDragMotion(wxCommandEvent& evt);
     void OnTabEndDrag(wxCommandEvent& evt);
     void OnTabButton(wxCommandEvent& evt);

-
+    

 protected:
 
 protected:
 

-    wxFrameManager m_mgr;
+    wxAuiManager m_mgr;

     wxAuiTabContainer m_tabs;
     int m_curpage;
     int m_tab_id_counter;
     wxWindow* m_dummy_wnd;
     wxAuiTabContainer m_tabs;
     int m_curpage;
     int m_tab_id_counter;
     wxWindow* m_dummy_wnd;

-    
+

     wxFont m_selected_font;
     wxFont m_normal_font;
     wxFont m_selected_font;
     wxFont m_normal_font;

+    int m_tab_ctrl_height;

     
     

+    int m_last_drag_x;
+    unsigned int m_flags;
+
+#ifndef SWIG
+    DECLARE_CLASS(wxAuiNotebook)

     DECLARE_EVENT_TABLE()
     DECLARE_EVENT_TABLE()

+#endif

 };
 
 
 };
 
 


@@ -281,7 +466,7 @@ typedef void (wxEvtHandler::*wxAuiNotebookEventFunction)(wxAuiNotebookEvent&);
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_PAGE_CHANGING(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, winid, wxAuiNotebookEventHandler(fn))
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_PAGE_CHANGING(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, winid, wxAuiNotebookEventHandler(fn))

-#define EVT_AUINOTEBOOK_PAGE_BUTTON(winid, fn) \
+#define EVT_AUINOTEBOOK_BUTTON(winid, fn) \

     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BUTTON, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_BEGIN_DRAG(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, winid, wxAuiNotebookEventHandler(fn))
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BUTTON, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_BEGIN_DRAG(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, winid, wxAuiNotebookEventHandler(fn))


@@ -289,12 +474,25 @@ typedef void (wxEvtHandler::*wxAuiNotebookEventFunction)(wxAuiNotebookEvent&);
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_DRAG_MOTION(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_DRAG_MOTION(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))

-    
+

 #else
 
 // wxpython/swig event work
 #else
 
 // wxpython/swig event work

-
-
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED;
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING;
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BUTTON;
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG;
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_END_DRAG;
+%constant wxEventType wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION;
+
+%pythoncode {
+    EVT_AUINOTEBOOK_PAGE_CHANGED = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGED, 1 )
+    EVT_AUINOTEBOOK_PAGE_CHANGING = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_PAGE_CHANGING, 1 )
+    EVT_AUINOTEBOOK_BUTTON = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BUTTON, 1 )
+    EVT_AUINOTEBOOK_BEGIN_DRAG = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_BEGIN_DRAG, 1 )
+    EVT_AUINOTEBOOK_END_DRAG = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, 1 )
+    EVT_AUINOTEBOOK_DRAG_MOTION = wx.PyEventBinder( wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, 1 )
+}

 #endif
 
 
 #endif