]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/aui/auibook.h
include wx/object.h now that wxConfigBase derives from wxObject
[wxWidgets.git] / include / wx / aui / auibook.h
index 0dd02f4644f85e654300b5ee8aff1757189110bb..05ebfdacf25ac11afe49f9882c6d22dd455834e7 100644 (file)
@@ -45,8 +45,8 @@ enum wxAuiNotebookOption
     wxAUI_NB_CLOSE_BUTTON        = 1 << 10,
     wxAUI_NB_CLOSE_ON_ACTIVE_TAB = 1 << 11,
     wxAUI_NB_CLOSE_ON_ALL_TABS   = 1 << 12,
-    
-    
+
+
     wxAUI_NB_DEFAULT_STYLE = wxAUI_NB_TOP |
                              wxAUI_NB_TAB_SPLIT |
                              wxAUI_NB_TAB_MOVE |
@@ -57,6 +57,79 @@ enum wxAuiNotebookOption
 
 
 
+// aui notebook event class
+
+class WXDLLIMPEXP_AUI wxAuiNotebookEvent : public wxNotifyEvent
+{
+public:
+    wxAuiNotebookEvent(wxEventType command_type = wxEVT_NULL,
+                       int win_id = 0)
+          : wxNotifyEvent(command_type, win_id)
+    {
+        old_selection = -1;
+        selection = -1;
+        drag_source = NULL;
+    }
+#ifndef SWIG
+    wxAuiNotebookEvent(const wxAuiNotebookEvent& c) : wxNotifyEvent(c)
+    {
+        old_selection = c.old_selection;
+        selection = c.selection;
+        drag_source = c.drag_source;
+    }
+#endif
+    wxEvent *Clone() const { return new wxAuiNotebookEvent(*this); }
+
+    void SetSelection(int s) { selection = s; m_commandInt = s; }
+    int GetSelection() const { return selection; }
+
+    void SetOldSelection(int s) { old_selection = s; }
+    int GetOldSelection() const { return old_selection; }
+
+    void SetDragSource(wxAuiNotebook* s) { drag_source = s; }
+    wxAuiNotebook* GetDragSource() const { return drag_source; }
+
+public:
+    int old_selection;
+    int selection;
+    wxAuiNotebook* drag_source;
+
+#ifndef SWIG
+private:
+    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent)
+#endif
+};
+
+
+class WXDLLIMPEXP_AUI wxAuiNotebookPage
+{
+public:
+    wxWindow* window;     // page's associated window
+    wxString caption;     // caption displayed on the tab
+    wxBitmap bitmap;      // tab's bitmap
+    wxRect rect;          // tab's hit rectangle
+    bool active;          // true if the page is currently active
+};
+
+class WXDLLIMPEXP_AUI wxAuiTabContainerButton
+{
+public:
+
+    int id;               // button's id
+    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
+};
+
+
+#ifndef SWIG
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage, wxAuiNotebookPageArray, WXDLLIMPEXP_AUI);
+WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton, wxAuiTabContainerButtonArray, WXDLLIMPEXP_AUI);
+#endif
+
+
 // tab art class
 
 class WXDLLIMPEXP_AUI wxAuiTabArt
@@ -65,13 +138,13 @@ public:
 
     wxAuiTabArt() { }
     virtual ~wxAuiTabArt() { }
-    
+
     virtual wxAuiTabArt* Clone() = 0;
     virtual void SetFlags(unsigned int flags) = 0;
 
     virtual void SetSizingInfo(const wxSize& tab_ctrl_size,
                                size_t tab_count) = 0;
-                               
+
     virtual void SetNormalFont(const wxFont& font) = 0;
     virtual void SetSelectedFont(const wxFont& font) = 0;
     virtual void SetMeasuringFont(const wxFont& font) = 0;
@@ -83,14 +156,13 @@ public:
 
     virtual void DrawTab(wxDC& dc,
                          wxWindow* wnd,
+                         const wxAuiNotebookPage& pane,
                          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;     
-    
+                         int* x_extent) = 0;
+
     virtual void DrawButton(
                          wxDC& dc,
                          wxWindow* wnd,
@@ -98,39 +170,41 @@ public:
                          int bitmap_id,
                          int button_state,
                          int orientation,
-                         const wxBitmap& bitmap_override,
                          wxRect* out_rect) = 0;
-               
-    virtual int GetIndentSize() = 0;
-  
+
     virtual wxSize GetTabSize(
                          wxDC& dc,
                          wxWindow* wnd,
                          const wxString& caption,
+                         const wxBitmap& bitmap,
                          bool active,
                          int close_button_state,
                          int* x_extent) = 0;
-                         
-    virtual int ShowWindowList(
+
+    virtual int ShowDropDown(
                          wxWindow* wnd,
-                         const wxArrayString& items,
+                         const wxAuiNotebookPageArray& items,
                          int active_idx) = 0;
-    
-    virtual int GetBestTabCtrlSize(wxWindow* wnd) = 0;    
+
+    virtual int GetIndentSize() = 0;
+
+    virtual int GetBestTabCtrlSize(
+                         wxWindow* wnd,
+                         const wxAuiNotebookPageArray& pages,
+                         const wxSize& required_bmp_size) = 0;
 };
 
 
-class WXDLLIMPEXP_AUI wxAuiSimpleTabArt : public wxAuiTabArt
+class WXDLLIMPEXP_AUI wxAuiDefaultTabArt : public wxAuiTabArt
 {
 
 public:
 
-    wxAuiSimpleTabArt();
-    virtual ~wxAuiSimpleTabArt();
-    
+    wxAuiDefaultTabArt();
+    virtual ~wxAuiDefaultTabArt();
+
     wxAuiTabArt* Clone();
     void SetFlags(unsigned int flags);
-
     void SetSizingInfo(const wxSize& tab_ctrl_size,
                        size_t tab_count);
 
@@ -142,17 +216,16 @@ public:
                  wxDC& dc,
                  wxWindow* wnd,
                  const wxRect& rect);
-                                          
+
     void DrawTab(wxDC& dc,
                  wxWindow* wnd,
+                 const wxAuiNotebookPage& pane,
                  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,
@@ -160,36 +233,37 @@ public:
                  int bitmap_id,
                  int button_state,
                  int orientation,
-                 const wxBitmap& bitmap_override,
                  wxRect* out_rect);
-             
+
     int GetIndentSize();
-    
+
     wxSize GetTabSize(
                  wxDC& dc,
                  wxWindow* wnd,
                  const wxString& caption,
+                 const wxBitmap& bitmap,
                  bool active,
                  int close_button_state,
                  int* x_extent);
-                  
-    int ShowWindowList(
+
+    int ShowDropDown(
                  wxWindow* wnd,
-                 const wxArrayString& items,
+                 const wxAuiNotebookPageArray& items,
                  int active_idx);
 
-    int GetBestTabCtrlSize(wxWindow* wnd);    
+    int GetBestTabCtrlSize(wxWindow* wnd,
+                 const wxAuiNotebookPageArray& pages,
+                 const wxSize& required_bmp_size);
 
-private:
+protected:
 
     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;
+    wxColour m_base_colour;
+    wxPen m_base_colour_pen;
+    wxPen m_border_pen;
+    wxBrush m_base_colour_brush;
     wxBitmap m_active_close_bmp;
     wxBitmap m_disabled_close_bmp;
     wxBitmap m_active_left_bmp;
@@ -198,22 +272,24 @@ private:
     wxBitmap m_disabled_right_bmp;
     wxBitmap m_active_windowlist_bmp;
     wxBitmap m_disabled_windowlist_bmp;
-    
+
     int m_fixed_tab_width;
+    int m_tab_ctrl_height;
     unsigned int m_flags;
 };
 
 
-class WXDLLIMPEXP_AUI wxAuiDefaultTabArt : public wxAuiTabArt
+class WXDLLIMPEXP_AUI wxAuiSimpleTabArt : public wxAuiTabArt
 {
 
 public:
 
-    wxAuiDefaultTabArt();
-    virtual ~wxAuiDefaultTabArt();
-    
+    wxAuiSimpleTabArt();
+    virtual ~wxAuiSimpleTabArt();
+
     wxAuiTabArt* Clone();
     void SetFlags(unsigned int flags);
+
     void SetSizingInfo(const wxSize& tab_ctrl_size,
                        size_t tab_count);
 
@@ -225,17 +301,16 @@ public:
                  wxDC& dc,
                  wxWindow* wnd,
                  const wxRect& rect);
-                     
+
     void DrawTab(wxDC& dc,
                  wxWindow* wnd,
+                 const wxAuiNotebookPage& pane,
                  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,
@@ -243,27 +318,29 @@ public:
                  int bitmap_id,
                  int button_state,
                  int orientation,
-                 const wxBitmap& bitmap_override,
                  wxRect* out_rect);
-    
+
     int GetIndentSize();
-                 
+
     wxSize GetTabSize(
                  wxDC& dc,
                  wxWindow* wnd,
                  const wxString& caption,
+                 const wxBitmap& bitmap,
                  bool active,
                  int close_button_state,
                  int* x_extent);
-                  
-    int ShowWindowList(
+
+    int ShowDropDown(
                  wxWindow* wnd,
-                 const wxArrayString& items,
+                 const wxAuiNotebookPageArray& items,
                  int active_idx);
 
-    int GetBestTabCtrlSize(wxWindow* wnd);    
+    int GetBestTabCtrlSize(wxWindow* wnd,
+                 const wxAuiNotebookPageArray& pages,
+                 const wxSize& required_bmp_size);
 
-private:
+protected:
 
     wxFont m_normal_font;
     wxFont m_selected_font;
@@ -281,7 +358,7 @@ private:
     wxBitmap m_disabled_right_bmp;
     wxBitmap m_active_windowlist_bmp;
     wxBitmap m_disabled_windowlist_bmp;
-    
+
     int m_fixed_tab_width;
     unsigned int m_flags;
 };
@@ -289,82 +366,11 @@ private:
 
 
 
-// event declarations/classes
 
-class WXDLLIMPEXP_AUI wxAuiNotebookEvent : public wxNotifyEvent
-{
-public:
-    wxAuiNotebookEvent(wxEventType command_type = wxEVT_NULL,
-                       int win_id = 0)
-          : wxNotifyEvent(command_type, win_id)
-    {
-        old_selection = -1;
-        selection = -1;
-        drag_source = NULL;
-    }
-#ifndef SWIG
-    wxAuiNotebookEvent(const wxAuiNotebookEvent& c) : wxNotifyEvent(c)
-    {
-        old_selection = c.old_selection;
-        selection = c.selection;
-        drag_source = c.drag_source;
-    }
-#endif
-    wxEvent *Clone() const { return new wxAuiNotebookEvent(*this); }
-
-    void SetSelection(int s) { selection = s; m_commandInt = s; }
-    int GetSelection() const { return selection; }
-    
-    void SetOldSelection(int s) { old_selection = s; }
-    int GetOldSelection() const { return old_selection; }
-    
-    void SetDragSource(wxAuiNotebook* s) { drag_source = s; }
-    wxAuiNotebook* GetDragSource() const { return drag_source; }
-
-public:
-    int old_selection;
-    int selection;
-    wxAuiNotebook* drag_source;
-
-#ifndef SWIG
-private:
-    DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxAuiNotebookEvent)
-#endif
-};
 
 
 
 
-
-class WXDLLIMPEXP_AUI wxAuiNotebookPage
-{
-public:
-    wxWindow* window;     // page's associated window
-    wxString caption;     // caption displayed on the tab
-    wxBitmap bitmap;      // tab's bitmap
-    wxRect rect;          // tab's hit rectangle
-    bool active;          // true if the page is currently active
-};
-
-class WXDLLIMPEXP_AUI wxAuiTabContainerButton
-{
-public:
-
-    int id;               // button's id
-    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
-};
-
-
-#ifndef SWIG
-WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiNotebookPage, wxAuiNotebookPageArray, WXDLLIMPEXP_AUI);
-WX_DECLARE_USER_EXPORTED_OBJARRAY(wxAuiTabContainerButton, wxAuiTabContainerButtonArray, WXDLLIMPEXP_AUI);
-#endif
-
-
 class WXDLLIMPEXP_AUI wxAuiTabContainer
 {
 public:
@@ -373,7 +379,7 @@ public:
     virtual ~wxAuiTabContainer();
 
     void SetArtProvider(wxAuiTabArt* art);
-    wxAuiTabArt* GetArtProvider();
+    wxAuiTabArt* GetArtProvider() const;
 
     void SetFlags(unsigned int flags);
     unsigned int GetFlags() const;
@@ -392,13 +398,14 @@ public:
     int GetIdxFromWindow(wxWindow* page) const;
     size_t GetPageCount() const;
     wxAuiNotebookPage& GetPage(size_t idx);
+    const wxAuiNotebookPage& GetPage(size_t idx) const;
     wxAuiNotebookPageArray& GetPages();
     void SetNormalFont(const wxFont& normal_font);
     void SetSelectedFont(const wxFont& selected_font);
     void SetMeasuringFont(const wxFont& measuring_font);
     void DoShowHide();
     void SetRect(const wxRect& rect);
-    
+
     void RemoveButton(int id);
     void AddButton(int id,
                    int location,
@@ -407,7 +414,7 @@ public:
 
     size_t GetTabOffset() const;
     void SetTabOffset(size_t offset);
-    
+
 protected:
 
     virtual void Render(wxDC* dc, wxWindow* wnd);
@@ -437,7 +444,7 @@ public:
                  long style = 0);
 
     ~wxAuiTabCtrl();
-    
+
 protected:
 
     void OnPaint(wxPaintEvent& evt);
@@ -449,13 +456,14 @@ protected:
     void OnLeaveWindow(wxMouseEvent& evt);
     void OnButton(wxAuiNotebookEvent& evt);
 
-    
+
 protected:
 
     wxPoint m_click_pt;
     wxWindow* m_click_tab;
     bool m_is_dragging;
     wxAuiTabContainerButton* m_hover_button;
+    wxAuiTabContainerButton* m_pressed_button;
 
 #ifndef SWIG
     DECLARE_CLASS(wxAuiTabCtrl)
@@ -487,6 +495,13 @@ public:
                 const wxSize& size = wxDefaultSize,
                 long style = 0);
 
+    void SetWindowStyleFlag(long style);
+    void SetArtProvider(wxAuiTabArt* art);
+    wxAuiTabArt* GetArtProvider() const;
+
+    virtual void SetUniformBitmapSize(const wxSize& size);
+    virtual void SetTabCtrlHeight(int height);
+
     bool AddPage(wxWindow* page,
                  const wxString& caption,
                  bool select = false,
@@ -500,42 +515,53 @@ public:
 
     bool DeletePage(size_t page);
     bool RemovePage(size_t page);
-    
-    void SetWindowStyleFlag(long style);
+
+    size_t GetPageCount() const;
+    wxWindow* GetPage(size_t page_idx) const;
+    int GetPageIndex(wxWindow* page_wnd) const;
 
     bool SetPageText(size_t page, const wxString& text);
+    wxString GetPageText(size_t page_idx) const;
+
+    bool SetPageBitmap(size_t page, const wxBitmap& bitmap);
+    wxBitmap GetPageBitmap(size_t page_idx) const;
+
     size_t SetSelection(size_t new_page);
     int GetSelection() const;
-    size_t GetPageCount() const;
-    wxWindow* GetPage(size_t page_idx) const;
 
+    virtual void Split(size_t page, int direction);
 
-    void SetArtProvider(wxAuiTabArt* art);
-    wxAuiTabArt* GetArtProvider();
+    const wxAuiManager& GetAuiManager() const { return m_mgr; }
 
 protected:
 
+    // these can be overridden
+    virtual void UpdateTabCtrlHeight();
+    virtual int CalculateTabCtrlHeight();
+    virtual wxSize CalculateNewSplitSize();
+
+protected:
+
+    void DoSizing();
+    void InitNotebook(long style);
     wxAuiTabCtrl* GetTabCtrlFromPoint(const wxPoint& pt);
     wxWindow* GetTabFrameFromTabCtrl(wxWindow* tab_ctrl);
     wxAuiTabCtrl* GetActiveTabCtrl();
     bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx);
     void RemoveEmptyTabFrames();
+    void UpdateHintWindowSize();
 
 protected:
 
-    void DoSizing();
-    void InitNotebook(long style);
-
     void OnChildFocus(wxChildFocusEvent& evt);
     void OnRender(wxAuiManagerEvent& evt);
-    void OnEraseBackground(wxEraseEvent& evt);
     void OnSize(wxSizeEvent& evt);
     void OnTabClicked(wxCommandEvent& evt);
     void OnTabBeginDrag(wxCommandEvent& evt);
     void OnTabDragMotion(wxCommandEvent& evt);
     void OnTabEndDrag(wxCommandEvent& evt);
     void OnTabButton(wxCommandEvent& evt);
-    
+
 protected:
 
     wxAuiManager m_mgr;
@@ -544,10 +570,12 @@ protected:
     int m_tab_id_counter;
     wxWindow* m_dummy_wnd;
 
+    wxSize m_requested_bmp_size;
+    int m_requested_tabctrl_height;
     wxFont m_selected_font;
     wxFont m_normal_font;
     int m_tab_ctrl_height;
-    
+
     int m_last_drag_x;
     unsigned int m_flags;
 
@@ -579,7 +607,7 @@ typedef void (wxEvtHandler::*wxAuiNotebookEventFunction)(wxAuiNotebookEvent&);
 
 #define wxAuiNotebookEventHandler(func) \
     (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent(wxAuiNotebookEventFunction, &func)
-    
+
 #define EVT_AUINOTEBOOK_PAGE_CLOSE(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_PAGE_CLOSE, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_PAGE_CHANGED(winid, fn) \