include/wx/mac/mdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        mdi.h
   3 // Purpose:     MDI (Multiple Document Interface) classes.
   4 //              This doesn't have to be implemented just like Windows,
   5 //              it could be a tabbed design as in wxGTK.
   6 // Author:      Stefan Csomor
   7 // Modified by:
   8 // Created:     1998-01-01
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) Stefan Csomor
  11 // Licence:     wxWindows licence
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_MDI_H_
  15 #define _WX_MDI_H_
  16
  17 #if defined(__GNUG__) && !defined(__APPLE__)
  18 #pragma interface "mdi.h"
  19 #endif
  20
  21 #include "wx/frame.h"
  22
  23 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  24 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
  25
  26 class WXDLLEXPORT wxMDIClientWindow;
  27 class WXDLLEXPORT wxMDIChildFrame;
  28
  29 class WXDLLEXPORT wxMDIParentFrame: public wxFrame
  30 {
  31   DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
  32
  33 public:
  34
  35   wxMDIParentFrame();
  36   inline wxMDIParentFrame(wxWindow *parent,
  37            wxWindowID id,
  38            const wxString& title,
  39            const wxPoint& pos = wxDefaultPosition,
  40            const wxSize& size = wxDefaultSize,
  41            long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,  // Scrolling refers to client window
  42            const wxString& name = wxFrameNameStr)
  43   {
  44       Create(parent, id, title, pos, size, style, name);
  45   }
  46
  47   ~wxMDIParentFrame();
  48
  49   bool Create(wxWindow *parent,
  50            wxWindowID id,
  51            const wxString& title,
  52            const wxPoint& pos = wxDefaultPosition,
  53            const wxSize& size = wxDefaultSize,
  54            long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  55            const wxString& name = wxFrameNameStr);
  56
  57   void OnActivate(wxActivateEvent& event);
  58   void OnSysColourChanged(wxSysColourChangedEvent& event);
  59
  60   void SetMenuBar(wxMenuBar *menu_bar);
  61
  62   // Get the active MDI child window (Windows only)
  63   wxMDIChildFrame *GetActiveChild() const ;
  64
  65   // Get the client window
  66   inline wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; };
  67
  68   // Create the client window class (don't Create the window,
  69   // just return a new class)
  70   virtual wxMDIClientWindow *OnCreateClient() ;
  71
  72   // MDI operations
  73   virtual void Cascade();
  74   virtual void Tile();
  75   virtual void ArrangeIcons();
  76   virtual void ActivateNext();
  77   virtual void ActivatePrevious();
  78
  79 protected:
  80
  81   // TODO maybe have this member
  82   wxMDIClientWindow     *m_clientWindow;
  83   wxMDIChildFrame *               m_currentChild;
  84     wxMenu*                         m_windowMenu;
  85
  86     // TRUE if MDI Frame is intercepting commands, not child
  87     bool m_parentFrameActive;
  88
  89 private:
  90     friend class WXDLLEXPORT wxMDIChildFrame;
  91 DECLARE_EVENT_TABLE()
  92 };
  93
  94 class WXDLLEXPORT wxMDIChildFrame: public wxFrame
  95 {
  96 DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
  97 public:
  98
  99   wxMDIChildFrame();
 100   inline wxMDIChildFrame(wxMDIParentFrame *parent,
 101            wxWindowID id,
 102            const wxString& title,
 103            const wxPoint& pos = wxDefaultPosition,
 104            const wxSize& size = wxDefaultSize,
 105            long style = wxDEFAULT_FRAME_STYLE,
 106            const wxString& name = wxFrameNameStr)
 107   {
 108       Init() ;
 109       Create(parent, id, title, pos, size, style, name);
 110   }
 111
 112   ~wxMDIChildFrame();
 113
 114   bool Create(wxMDIParentFrame *parent,
 115            wxWindowID id,
 116            const wxString& title,
 117            const wxPoint& pos = wxDefaultPosition,
 118            const wxSize& size = wxDefaultSize,
 119            long style = wxDEFAULT_FRAME_STYLE,
 120            const wxString& name = wxFrameNameStr);
 121
 122   // Set menu bar
 123   void SetMenuBar(wxMenuBar *menu_bar);
 124
 125   // MDI operations
 126   virtual void Maximize();
 127   virtual void Maximize( bool ){ Maximize() ; } // this one is inherited from wxFrame
 128   virtual void Restore();
 129   virtual void Activate();
 130 protected:
 131
 132     // common part of all ctors
 133     void Init();
 134 };
 135
 136 /* The client window is a child of the parent MDI frame, and itself
 137  * contains the child MDI frames.
 138  * However, you create the MDI children as children of the MDI parent:
 139  * only in the implementation does the client window become the parent
 140  * of the children. Phew! So the children are sort of 'adopted'...
 141  */
 142
 143 class WXDLLEXPORT wxMDIClientWindow: public wxWindow
 144 {
 145   DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 146  public:
 147
 148   wxMDIClientWindow() ;
 149   inline wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 150   {
 151       CreateClient(parent, style);
 152   }
 153
 154   ~wxMDIClientWindow();
 155
 156   // Note: this is virtual, to allow overridden behaviour.
 157   virtual bool CreateClient(wxMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL);
 158
 159   // Gets the size available for subwindows after menu size, toolbar size
 160   // and status bar size have been subtracted. If you want to manage your own
 161   // toolbar(s), don't call SetToolBar.
 162   void DoGetClientSize(int *width, int *height) const;
 163
 164   // Explicitly call default scroll behaviour
 165   void OnScroll(wxScrollEvent& event);
 166
 167 protected:
 168
 169 DECLARE_EVENT_TABLE()
 170 };
 171
 172 #endif
 173     // _WX_MDI_H_