synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/aui/tabmdi.h b/include/wx/aui/tabmdi.h
index a0ce4eced0fec4929f69accc16bb5013836960be..f24a2d22ce327aad496392bd03ca1a30eb1921fe 100644 (file)
--- a/include/wx/aui/tabmdi.h
+++ b/include/wx/aui/tabmdi.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        wx/generic/tabmdi.h
+// Name:        wx/aui/tabmdi.h

 // Purpose:     Generic MDI (Multiple Document Interface) classes
 // Author:      Hans Van Leemputten
 // Modified by: Benjamin I. Williams / Kirix Corporation
 // Purpose:     Generic MDI (Multiple Document Interface) classes
 // Author:      Hans Van Leemputten
 // Modified by: Benjamin I. Williams / Kirix Corporation


@@ -12,6 +12,8 @@
 #ifndef _WX_AUITABMDI_H_
 #define _WX_AUITABMDI_H_
 
 #ifndef _WX_AUITABMDI_H_
 #define _WX_AUITABMDI_H_
 

+#if wxUSE_AUI
+

 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------


@@ -19,25 +21,26 @@
 #include "wx/frame.h"
 #include "wx/panel.h"
 #include "wx/notebook.h"
 #include "wx/frame.h"
 #include "wx/panel.h"
 #include "wx/notebook.h"

+#include "wx/icon.h"

 #include "wx/aui/auibook.h"
 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 
 #include "wx/aui/auibook.h"
 
 //-----------------------------------------------------------------------------
 // classes
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_AUI wxTabMDIParentFrame;
-class WXDLLIMPEXP_AUI wxTabMDIClientWindow;
-class WXDLLIMPEXP_AUI wxTabMDIChildFrame;
+class WXDLLIMPEXP_FWD_AUI wxAuiMDIParentFrame;
+class WXDLLIMPEXP_FWD_AUI wxAuiMDIClientWindow;
+class WXDLLIMPEXP_FWD_AUI wxAuiMDIChildFrame;

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// wxTabMDIParentFrame
+// wxAuiMDIParentFrame

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_AUI wxTabMDIParentFrame : public wxFrame
+class WXDLLIMPEXP_AUI wxAuiMDIParentFrame : public wxFrame

 {
 public:
 {
 public:

-    wxTabMDIParentFrame();
-    wxTabMDIParentFrame(wxWindow *parent,
+    wxAuiMDIParentFrame();
+    wxAuiMDIParentFrame(wxWindow *parent,

                         wxWindowID winid,
                         const wxString& title,
                         const wxPoint& pos = wxDefaultPosition,
                         wxWindowID winid,
                         const wxString& title,
                         const wxPoint& pos = wxDefaultPosition,


@@ -45,7 +48,7 @@ public:
                         long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                         const wxString& name = wxFrameNameStr);
 
                         long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                         const wxString& name = wxFrameNameStr);
 

-    ~wxTabMDIParentFrame();
+    ~wxAuiMDIParentFrame();

 
     bool Create(wxWindow *parent,
                 wxWindowID winid,
 
     bool Create(wxWindow *parent,
                 wxWindowID winid,


@@ -55,32 +58,35 @@ public:
                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                 const wxString& name = wxFrameNameStr );
 
                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
                 const wxString& name = wxFrameNameStr );
 

+    void SetArtProvider(wxAuiTabArt* provider);
+    wxAuiTabArt* GetArtProvider();
+    wxAuiNotebook* GetNotebook() const;
+

 #if wxUSE_MENUS
 #if wxUSE_MENUS

-    wxMenu* GetWindowMenu() const { return m_pWindowMenu; };
+    wxMenu* GetWindowMenu() const { return m_pWindowMenu; }

     void SetWindowMenu(wxMenu* pMenu);
 
     virtual void SetMenuBar(wxMenuBar *pMenuBar);
 #endif // wxUSE_MENUS
 
     void SetWindowMenu(wxMenu* pMenu);
 
     virtual void SetMenuBar(wxMenuBar *pMenuBar);
 #endif // wxUSE_MENUS
 

-    void SetChildMenuBar(wxTabMDIChildFrame *pChild);
-
-    virtual bool ProcessEvent(wxEvent& event);
+    void SetChildMenuBar(wxAuiMDIChildFrame *pChild);

 
 

-    wxTabMDIChildFrame *GetActiveChild() const;
-    inline void SetActiveChild(wxTabMDIChildFrame* pChildFrame);
+    wxAuiMDIChildFrame *GetActiveChild() const;
+    void SetActiveChild(wxAuiMDIChildFrame* pChildFrame);

 
 

-    wxTabMDIClientWindow *GetClientWindow() const;
-    virtual wxTabMDIClientWindow *OnCreateClient();
+    wxAuiMDIClientWindow *GetClientWindow() const;
+    virtual wxAuiMDIClientWindow *OnCreateClient();

 
     virtual void Cascade() { /* Has no effect */ }
 
     virtual void Cascade() { /* Has no effect */ }

-    virtual void Tile(wxOrientation WXUNUSED(orient) = wxHORIZONTAL) { }
+    virtual void Tile(wxOrientation orient = wxHORIZONTAL);

     virtual void ArrangeIcons() { /* Has no effect */ }
     virtual void ActivateNext();
     virtual void ActivatePrevious();
 
 protected:
     virtual void ArrangeIcons() { /* Has no effect */ }
     virtual void ActivateNext();
     virtual void ActivatePrevious();
 
 protected:

-    wxTabMDIClientWindow   *m_pClientWindow;
-    wxTabMDIChildFrame     *m_pActiveChild;
+    wxAuiMDIClientWindow*   m_pClientWindow;
+    wxAuiMDIChildFrame*     m_pActiveChild;
+    wxEvent*                m_pLastEvt;

 
 #if wxUSE_MENUS
     wxMenu              *m_pWindowMenu;
 
 #if wxUSE_MENUS
     wxMenu              *m_pWindowMenu;


@@ -95,24 +101,27 @@ protected:
     void AddWindowMenu(wxMenuBar *pMenuBar);
 
     void DoHandleMenu(wxCommandEvent &event);
     void AddWindowMenu(wxMenuBar *pMenuBar);
 
     void DoHandleMenu(wxCommandEvent &event);

+    void DoHandleUpdateUI(wxUpdateUIEvent &event);

 #endif // wxUSE_MENUS
 
 #endif // wxUSE_MENUS
 

+    virtual bool ProcessEvent(wxEvent& event);
+

     virtual void DoGetClientSize(int *width, int *height) const;
 
 private:
     DECLARE_EVENT_TABLE()
     virtual void DoGetClientSize(int *width, int *height) const;
 
 private:
     DECLARE_EVENT_TABLE()

-    DECLARE_DYNAMIC_CLASS(wxTabMDIParentFrame)
+    DECLARE_DYNAMIC_CLASS(wxAuiMDIParentFrame)

 };
 
 //-----------------------------------------------------------------------------
 };
 
 //-----------------------------------------------------------------------------

-// wxTabMDIChildFrame
+// wxAuiMDIChildFrame

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_AUI wxTabMDIChildFrame : public wxPanel
+class WXDLLIMPEXP_AUI wxAuiMDIChildFrame : public wxPanel

 {
 public:
 {
 public:

-    wxTabMDIChildFrame();
-    wxTabMDIChildFrame(wxTabMDIParentFrame *parent,
+    wxAuiMDIChildFrame();
+    wxAuiMDIChildFrame(wxAuiMDIParentFrame *parent,

                        wxWindowID winid,
                        const wxString& title,
                        const wxPoint& pos = wxDefaultPosition,
                        wxWindowID winid,
                        const wxString& title,
                        const wxPoint& pos = wxDefaultPosition,


@@ -120,8 +129,8 @@ public:
                        long style = wxDEFAULT_FRAME_STYLE,
                        const wxString& name = wxFrameNameStr);
 
                        long style = wxDEFAULT_FRAME_STYLE,
                        const wxString& name = wxFrameNameStr);
 

-    virtual ~wxTabMDIChildFrame();
-    bool Create(wxTabMDIParentFrame *parent,
+    virtual ~wxAuiMDIChildFrame();
+    bool Create(wxAuiMDIParentFrame *parent,

                 wxWindowID winid,
                 const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,
                 wxWindowID winid,
                 const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,


@@ -130,48 +139,46 @@ public:
                 const wxString& name = wxFrameNameStr);
 
 #if wxUSE_MENUS
                 const wxString& name = wxFrameNameStr);
 
 #if wxUSE_MENUS

-    virtual void SetMenuBar(wxMenuBar *menu_bar);
+    virtual void SetMenuBar(wxMenuBar *menuBar);

     virtual wxMenuBar *GetMenuBar() const;
 #endif // wxUSE_MENUS
 
     virtual void SetTitle(const wxString& title);
     virtual wxString GetTitle() const;
 
     virtual wxMenuBar *GetMenuBar() const;
 #endif // wxUSE_MENUS
 
     virtual void SetTitle(const wxString& title);
     virtual wxString GetTitle() const;
 

+    virtual void SetIcons(const wxIconBundle& icons);
+    virtual const wxIconBundle& GetIcons() const;
+
+    virtual void SetIcon(const wxIcon& icon);
+    virtual const wxIcon& GetIcon() const;
+

     virtual void Activate();
     virtual bool Destroy();
 
     virtual void Activate();
     virtual bool Destroy();
 

+    virtual bool Show(bool show = true);
+

 #if wxUSE_STATUSBAR
     // no status bars
     virtual wxStatusBar* CreateStatusBar(int WXUNUSED(number) = 1,
                                          long WXUNUSED(style) = 1,
                                          wxWindowID WXUNUSED(winid) = 1,
                                          const wxString& WXUNUSED(name) = wxEmptyString)
 #if wxUSE_STATUSBAR
     // no status bars
     virtual wxStatusBar* CreateStatusBar(int WXUNUSED(number) = 1,
                                          long WXUNUSED(style) = 1,
                                          wxWindowID WXUNUSED(winid) = 1,
                                          const wxString& WXUNUSED(name) = wxEmptyString)

-      { return (wxStatusBar*)NULL; }
+      { return NULL; }

 
 

-    virtual wxStatusBar *GetStatusBar() const { return (wxStatusBar*)NULL; }
+    virtual wxStatusBar *GetStatusBar() const { return NULL; }

     virtual void SetStatusText( const wxString &WXUNUSED(text), int WXUNUSED(number)=0 ) {}
     virtual void SetStatusWidths( int WXUNUSED(n), const int WXUNUSED(widths_field)[] ) {}
 #endif
 
     virtual void SetStatusText( const wxString &WXUNUSED(text), int WXUNUSED(number)=0 ) {}
     virtual void SetStatusWidths( int WXUNUSED(n), const int WXUNUSED(widths_field)[] ) {}
 #endif
 

-    // no size hints
-    virtual void DoSetSizeHints(int WXUNUSED(minW),
-                                int WXUNUSED(minH),
-                                int WXUNUSED(maxW) = wxDefaultCoord,
-                                int WXUNUSED(maxH) = wxDefaultCoord,
-                                int WXUNUSED(incW) = wxDefaultCoord,
-                                int WXUNUSED(incH) = wxDefaultCoord) {}

 #if wxUSE_TOOLBAR
     // no toolbar bars
     virtual wxToolBar* CreateToolBar(long WXUNUSED(style),
                                      wxWindowID WXUNUSED(winid),
                                      const wxString& WXUNUSED(name))
 #if wxUSE_TOOLBAR
     // no toolbar bars
     virtual wxToolBar* CreateToolBar(long WXUNUSED(style),
                                      wxWindowID WXUNUSED(winid),
                                      const wxString& WXUNUSED(name))

-        { return (wxToolBar*)NULL; }
-    virtual wxToolBar *GetToolBar() const { return (wxToolBar*)NULL; }
+        { return NULL; }
+    virtual wxToolBar *GetToolBar() const { return NULL; }

 #endif
 
 #endif
 

-    // no icon
-    void SetIcon(const wxIcon& WXUNUSED(icon)) { }
-    void SetIcons(const wxIconBundle& WXUNUSED(icons)) { }

 
     // no maximize etc
     virtual void Maximize(bool WXUNUSED(maximize) = true) { /* Has no effect */ }
 
     // no maximize etc
     virtual void Maximize(bool WXUNUSED(maximize) = true) { /* Has no effect */ }


@@ -188,26 +195,18 @@ public:
     void OnActivate(wxActivateEvent& evt);
     void OnCloseWindow(wxCloseEvent& evt);
 
     void OnActivate(wxActivateEvent& evt);
     void OnCloseWindow(wxCloseEvent& evt);
 

-    void SetMDIParentFrame(wxTabMDIParentFrame* parent);
-    wxTabMDIParentFrame* GetMDIParentFrame() const;
-
-protected:
-    wxTabMDIParentFrame *m_pMDIParentFrame;
-    wxRect            m_mdi_newrect;
-    wxRect            m_mdi_currect;
-    wxString          m_title;
-
-#if wxUSE_MENUS
-    wxMenuBar        *m_pMenuBar;
-#endif // wxUSE_MENUS
+    void SetMDIParentFrame(wxAuiMDIParentFrame* parent);
+    wxAuiMDIParentFrame* GetMDIParentFrame() const;

 
 protected:
     void Init();
 
 protected:
     void Init();

-
-    virtual bool Show(bool show = true);
-    virtual void DoSetSize(int x, int y, int width, int height, int size_flags);
+    virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);

     virtual void DoMoveWindow(int x, int y, int width, int height);
 
     virtual void DoMoveWindow(int x, int y, int width, int height);
 

+    // no size hints
+    virtual void DoSetSizeHints(int WXUNUSED(minW), int WXUNUSED(minH),
+                                int WXUNUSED(maxW), int WXUNUSED(maxH),
+                                int WXUNUSED(incW), int WXUNUSED(incH)) {}

 public:
     // This function needs to be called when a size change is confirmed,
     // we needed this function to prevent anybody from the outside
 public:
     // This function needs to be called when a size change is confirmed,
     // we needed this function to prevent anybody from the outside


@@ -215,38 +214,54 @@ public:
     void ApplyMDIChildFrameRect();
     void DoShow(bool show);
 
     void ApplyMDIChildFrameRect();
     void DoShow(bool show);
 

+protected:
+    wxAuiMDIParentFrame* m_pMDIParentFrame;
+    wxRect m_mdiNewRect;
+    wxRect m_mdiCurRect;
+    wxString m_title;
+    wxIcon m_icon;
+    wxIconBundle m_iconBundle;
+    bool m_activateOnCreate;
+
+#if wxUSE_MENUS
+    wxMenuBar* m_pMenuBar;
+#endif // wxUSE_MENUS
+
+
+

 private:
 private:

-    DECLARE_DYNAMIC_CLASS(wxTabMDIChildFrame)
+    DECLARE_DYNAMIC_CLASS(wxAuiMDIChildFrame)

     DECLARE_EVENT_TABLE()
 
     DECLARE_EVENT_TABLE()
 

-    friend class wxTabMDIClientWindow;
+    friend class wxAuiMDIClientWindow;

 };
 
 //-----------------------------------------------------------------------------
 };
 
 //-----------------------------------------------------------------------------

-// wxTabMDIClientWindow
+// wxAuiMDIClientWindow

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_AUI wxTabMDIClientWindow : public wxAuiMultiNotebook
+class WXDLLIMPEXP_AUI wxAuiMDIClientWindow : public wxAuiNotebook

 {
 public:
 {
 public:

-    wxTabMDIClientWindow();
-    wxTabMDIClientWindow(wxTabMDIParentFrame *parent, long style = 0);
-    ~wxTabMDIClientWindow();
+    wxAuiMDIClientWindow();
+    wxAuiMDIClientWindow(wxAuiMDIParentFrame *parent, long style = 0);

 
 

-    virtual bool CreateClient(wxTabMDIParentFrame *parent,
+    virtual bool CreateClient(wxAuiMDIParentFrame *parent,

                               long style = wxVSCROLL | wxHSCROLL);
 
     virtual int SetSelection(size_t page);
 
 protected:
 
                               long style = wxVSCROLL | wxHSCROLL);
 
     virtual int SetSelection(size_t page);
 
 protected:
 

-    void PageChanged(int old_selection, int new_selection);
-    void OnPageChanged(wxAuiNotebookEvent& event);
+    void PageChanged(int oldSelection, int newSelection);
+    void OnPageClose(wxAuiNotebookEvent& evt);
+    void OnPageChanged(wxAuiNotebookEvent& evt);

     void OnSize(wxSizeEvent& evt);
 
 private:
     void OnSize(wxSizeEvent& evt);
 
 private:

-    DECLARE_DYNAMIC_CLASS(wxTabMDIClientWindow)
+    DECLARE_DYNAMIC_CLASS(wxAuiMDIClientWindow)

     DECLARE_EVENT_TABLE()
 };
     DECLARE_EVENT_TABLE()
 };

+#endif // wxUSE_AUI

 
 #endif // _WX_AUITABMDI_H_
 
 #endif // _WX_AUITABMDI_H_