]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/aui/auibook.h
changed wxFDIODispatcher::UnregisterFD() to take only fd, without flags, and unregist...
[wxWidgets.git] / include / wx / aui / auibook.h
index 1859a296da7defb81c178481e6dfb1b5717978f6..b06ca41e9bc6fcb564c67c530a9a825252ba8e75 100644 (file)
@@ -45,13 +45,14 @@ 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_MIDDLE_CLICK_CLOSE  = 1 << 13,
+
     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
+                             wxAUI_NB_CLOSE_ON_ACTIVE_TAB |
+                             wxAUI_NB_MIDDLE_CLICK_CLOSE
 };
 
 
@@ -82,10 +83,10 @@ public:
 
     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; }
 
@@ -138,13 +139,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;
@@ -156,15 +157,13 @@ public:
 
     virtual void DrawTab(wxDC& dc,
                          wxWindow* wnd,
+                         const wxAuiNotebookPage& pane,
                          const wxRect& in_rect,
-                         const wxString& caption,
-                         const wxBitmap& bitmap,
-                         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,
@@ -172,11 +171,8 @@ 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,
@@ -185,15 +181,18 @@ public:
                          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,
-                                   wxAuiNotebookPageArray& pages,
-                                   const wxSize& required_bmp_size) = 0;    
+
+    virtual int GetIndentSize() = 0;
+
+    virtual int GetBestTabCtrlSize(
+                         wxWindow* wnd,
+                         const wxAuiNotebookPageArray& pages,
+                         const wxSize& required_bmp_size) = 0;
 };
 
 
@@ -204,7 +203,7 @@ public:
 
     wxAuiDefaultTabArt();
     virtual ~wxAuiDefaultTabArt();
-    
+
     wxAuiTabArt* Clone();
     void SetFlags(unsigned int flags);
     void SetSizingInfo(const wxSize& tab_ctrl_size,
@@ -218,18 +217,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,
-                 const wxBitmap& bitmap,
-                 bool active,
                  int close_button_state,
                  wxRect* out_tab_rect,
                  wxRect* out_button_rect,
                  int* x_extent);
-    
+
     void DrawButton(
                  wxDC& dc,
                  wxWindow* wnd,
@@ -237,11 +234,10 @@ public:
                  int bitmap_id,
                  int button_state,
                  int orientation,
-                 const wxBitmap& bitmap_override,
                  wxRect* out_rect);
-    
+
     int GetIndentSize();
-                 
+
     wxSize GetTabSize(
                  wxDC& dc,
                  wxWindow* wnd,
@@ -250,15 +246,15 @@ public:
                  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,
-                 wxAuiNotebookPageArray& pages,
-                 const wxSize& required_bmp_size);  
+                 const wxAuiNotebookPageArray& pages,
+                 const wxSize& required_bmp_size);
 
 protected:
 
@@ -277,7 +273,7 @@ protected:
     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;
@@ -291,7 +287,7 @@ public:
 
     wxAuiSimpleTabArt();
     virtual ~wxAuiSimpleTabArt();
-    
+
     wxAuiTabArt* Clone();
     void SetFlags(unsigned int flags);
 
@@ -306,18 +302,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,
-                 const wxBitmap& bitmap,
-                 bool active,
                  int close_button_state,
                  wxRect* out_tab_rect,
                  wxRect* out_button_rect,
                  int* x_extent);
-    
+
     void DrawButton(
                  wxDC& dc,
                  wxWindow* wnd,
@@ -325,11 +319,10 @@ public:
                  int bitmap_id,
                  int button_state,
                  int orientation,
-                 const wxBitmap& bitmap_override,
                  wxRect* out_rect);
-             
+
     int GetIndentSize();
-    
+
     wxSize GetTabSize(
                  wxDC& dc,
                  wxWindow* wnd,
@@ -338,15 +331,15 @@ public:
                  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,
-                 wxAuiNotebookPageArray& pages,
-                 const wxSize& required_bmp_size);  
+                 const wxAuiNotebookPageArray& pages,
+                 const wxSize& required_bmp_size);
 
 protected:
 
@@ -366,7 +359,7 @@ protected:
     wxBitmap m_disabled_right_bmp;
     wxBitmap m_active_windowlist_bmp;
     wxBitmap m_disabled_windowlist_bmp;
-    
+
     int m_fixed_tab_width;
     unsigned int m_flags;
 };
@@ -406,13 +399,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,
@@ -421,7 +415,7 @@ public:
 
     size_t GetTabOffset() const;
     void SetTabOffset(size_t offset);
-    
+
 protected:
 
     virtual void Render(wxDC* dc, wxWindow* wnd);
@@ -451,7 +445,11 @@ public:
                  long style = 0);
 
     ~wxAuiTabCtrl();
-    
+
+#if wxABI_VERSION >= 20805
+    bool IsDragging() const { return m_is_dragging; }
+#endif
+
 protected:
 
     void OnPaint(wxPaintEvent& evt);
@@ -459,11 +457,15 @@ protected:
     void OnSize(wxSizeEvent& evt);
     void OnLeftDown(wxMouseEvent& evt);
     void OnLeftUp(wxMouseEvent& evt);
+    void OnMiddleDown(wxMouseEvent& evt);
+    void OnMiddleUp(wxMouseEvent& evt);
+    void OnRightDown(wxMouseEvent& evt);
+    void OnRightUp(wxMouseEvent& evt);
     void OnMotion(wxMouseEvent& evt);
     void OnLeaveWindow(wxMouseEvent& evt);
     void OnButton(wxAuiNotebookEvent& evt);
 
-    
+
 protected:
 
     wxPoint m_click_pt;
@@ -502,6 +504,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,
@@ -515,31 +524,49 @@ 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;
 
-    int GetPageIndex(wxWindow* page_wnd) const;
+    virtual void Split(size_t page, int direction);
+
+    const wxAuiManager& GetAuiManager() const { return m_mgr; }
+
+    // Sets the normal font
+    void SetNormalFont(const wxFont& font);
+
+    // Sets the selected tab font
+    void SetSelectedFont(const wxFont& font);
+
+    // Sets the measuring font
+    void SetMeasuringFont(const wxFont& font);
+
+    // Sets the tab font
+    virtual bool SetFont(const wxFont& font);
+
+    // Gets the tab control height
+    int GetTabCtrlHeight() const;
+
+    // Gets the height of the notebook for a given page height
+    int GetHeightForPageHeight(int pageHeight);
 
-    void SetArtProvider(wxAuiTabArt* art);
-    wxAuiTabArt* GetArtProvider() const;
-    
-    virtual void SetUniformBitmapSize(const wxSize& size);
-    virtual void SetTabCtrlHeight(int height);
-    
 protected:
 
     // these can be overridden
     virtual void UpdateTabCtrlHeight();
     virtual int CalculateTabCtrlHeight();
     virtual wxSize CalculateNewSplitSize();
-    
+
 protected:
 
     void DoSizing();
@@ -550,19 +577,30 @@ protected:
     bool FindTab(wxWindow* page, wxAuiTabCtrl** ctrl, int* idx);
     void RemoveEmptyTabFrames();
     void UpdateHintWindowSize();
-    
+
 protected:
 
     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);
-    
+    void OnTabMiddleDown(wxCommandEvent& evt);
+    void OnTabMiddleUp(wxCommandEvent& evt);
+    void OnTabRightDown(wxCommandEvent& evt);
+    void OnTabRightUp(wxCommandEvent& evt);
+
+    // set selection to the given window (which must be non-NULL and be one of
+    // our pages, otherwise an assert is raised)
+    void SetSelectionToWindow(wxWindow *win);
+    void SetSelectionToPage(const wxAuiNotebookPage& page)
+    {
+        SetSelectionToWindow(page.window);
+    }
+
 protected:
 
     wxAuiManager m_mgr;
@@ -576,7 +614,7 @@ protected:
     wxFont m_selected_font;
     wxFont m_normal_font;
     int m_tab_ctrl_height;
-        
+
     int m_last_drag_x;
     unsigned int m_flags;
 
@@ -602,13 +640,17 @@ BEGIN_DECLARE_EVENT_TYPES()
     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_END_DRAG, 0)
     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, 0)
     DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND, 0)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_DOWN, 0)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_UP, 0)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_DOWN, 0)
+    DECLARE_EXPORTED_EVENT_TYPE(WXDLLIMPEXP_AUI, wxEVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_UP, 0)
 END_DECLARE_EVENT_TYPES()
 
 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) \
@@ -625,6 +667,14 @@ typedef void (wxEvtHandler::*wxAuiNotebookEventFunction)(wxAuiNotebookEvent&);
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_DRAG_MOTION, winid, wxAuiNotebookEventHandler(fn))
 #define EVT_AUINOTEBOOK_ALLOW_DND(winid, fn) \
     wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_ALLOW_DND, winid, wxAuiNotebookEventHandler(fn))
+#define EVT_AUINOTEBOOK_TAB_MIDDLE_DOWN(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_DOWN, winid, wxAuiNotebookEventHandler(fn))
+#define EVT_AUINOTEBOOK_TAB_MIDDLE_UP(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_TAB_MIDDLE_UP, winid, wxAuiNotebookEventHandler(fn))
+#define EVT_AUINOTEBOOK_TAB_RIGHT_DOWN(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_DOWN, winid, wxAuiNotebookEventHandler(fn))
+#define EVT_AUINOTEBOOK_TAB_RIGHT_UP(winid, fn) \
+    wx__DECLARE_EVT1(wxEVT_COMMAND_AUINOTEBOOK_TAB_RIGHT_UP, winid, wxAuiNotebookEventHandler(fn))
 
 #else