include/wx/motif/mdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        mdi.h
   3 // Purpose:     MDI (Multiple Document Interface) classes.
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MDI_H_
  13 #define _WX_MDI_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "mdi.h"
  17 #endif
  18
  19 /*
  20 New MDI scheme using tabs. We can use a wxNotebook to implement the client
  21 window. wxMDIChildFrame can be implemented as an XmMainWindow widget
  22 as before, and is a child of the notebook _and_ of the parent frame...
  23 but wxMDIChildFrame::GetParent should return the parent frame.
  24
  25 */
  26
  27 #include "wx/frame.h"
  28 #include "wx/notebook.h"
  29
  30 WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
  31 WXDLLEXPORT_DATA(extern const char*) wxStatusLineNameStr;
  32
  33 class WXDLLEXPORT wxMDIClientWindow;
  34 class WXDLLEXPORT wxMDIChildFrame;
  35
  36 class WXDLLEXPORT wxMDIParentFrame: public wxFrame
  37 {
  38 DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
  39
  40   friend class WXDLLEXPORT wxMDIChildFrame;
  41 public:
  42
  43   wxMDIParentFrame();
  44   inline wxMDIParentFrame(wxWindow *parent,
  45            wxWindowID id,
  46            const wxString& title,
  47            const wxPoint& pos = wxDefaultPosition,
  48            const wxSize& size = wxDefaultSize,
  49            long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,  // Scrolling refers to client window
  50            const wxString& name = wxFrameNameStr)
  51   {
  52       Create(parent, id, title, pos, size, style, name);
  53   }
  54
  55   ~wxMDIParentFrame();
  56
  57   bool Create(wxWindow *parent,
  58            wxWindowID id,
  59            const wxString& title,
  60            const wxPoint& pos = wxDefaultPosition,
  61            const wxSize& size = wxDefaultSize,
  62            long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  63            const wxString& name = wxFrameNameStr);
  64
  65   void OnSize(wxSizeEvent& event);
  66   void OnActivate(wxActivateEvent& event);
  67   void OnSysColourChanged(wxSysColourChangedEvent& event);
  68
  69   void SetMenuBar(wxMenuBar *menu_bar);
  70
  71   // Gets the size available for subwindows after menu size, toolbar size
  72   // and status bar size have been subtracted. If you want to manage your own
  73   // toolbar(s), don't call SetToolBar.
  74   void GetClientSize(int *width, int *height) const;
  75   wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
  76
  77   // Get the active MDI child window
  78   wxMDIChildFrame *GetActiveChild() const ;
  79
  80   // Get the client window
  81   wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; };
  82
  83   // Create the client window class (don't Create the window,
  84   // just return a new class)
  85   virtual wxMDIClientWindow *OnCreateClient() ;
  86
  87   // MDI operations
  88   virtual void Cascade();
  89   virtual void Tile();
  90   virtual void ArrangeIcons();
  91   virtual void ActivateNext();
  92   virtual void ActivatePrevious();
  93
  94 // Implementation
  95
  96   // Set the active child
  97   inline void SetActiveChild(wxMDIChildFrame* child) { m_activeChild = child; }
  98
  99   // Set the child's menubar into the parent frame
 100   void SetChildMenuBar(wxMDIChildFrame* frame);
 101
 102   inline wxMenuBar* GetActiveMenuBar() const { return m_activeMenuBar; }
 103
 104   // Redirect events to active child first
 105   virtual bool ProcessEvent(wxEvent& event);
 106
 107 protected:
 108   virtual void DoSetSize(int x, int y,
 109                            int width, int height,
 110                            int sizeFlags = wxSIZE_AUTO);
 111   virtual void DoSetClientSize(int width, int height);
 112
 113
 114 protected:
 115
 116   wxMDIClientWindow*    m_clientWindow;
 117   wxMDIChildFrame*      m_activeChild;
 118   wxMenuBar*            m_activeMenuBar;
 119
 120 DECLARE_EVENT_TABLE()
 121 };
 122
 123 class WXDLLEXPORT wxMDIChildFrame: public wxFrame
 124 {
 125 DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 126
 127 public:
 128     wxMDIChildFrame();
 129     wxMDIChildFrame(wxMDIParentFrame *parent,
 130             wxWindowID id,
 131             const wxString& title,
 132             const wxPoint& pos = wxDefaultPosition,
 133             const wxSize& size = wxDefaultSize,
 134             long style = wxDEFAULT_FRAME_STYLE,
 135             const wxString& name = wxFrameNameStr)
 136     {
 137         Create(parent, id, title, pos, size, style, name);
 138     }
 139
 140     ~wxMDIChildFrame();
 141
 142     bool Create(wxMDIParentFrame *parent,
 143             wxWindowID id,
 144             const wxString& title,
 145             const wxPoint& pos = wxDefaultPosition,
 146             const wxSize& size = wxDefaultSize,
 147             long style = wxDEFAULT_FRAME_STYLE,
 148             const wxString& name = wxFrameNameStr);
 149
 150     // Set menu bar
 151     void SetMenuBar(wxMenuBar *menu_bar);
 152     void SetTitle(const wxString& title);
 153
 154     void SetClientSize(int width, int height);
 155     void GetClientSize(int *width, int *height) const;
 156     void GetSize(int *width, int *height) const;
 157     void GetPosition(int *x, int *y) const ;
 158
 159     // Set icon
 160     virtual void SetIcon(const wxIcon& icon);
 161
 162     // Override wxFrame operations
 163     void CaptureMouse();
 164     void ReleaseMouse();
 165     void Raise();
 166     void Lower(void);
 167     void SetSizeHints(int minW = -1, int minH = -1, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1);
 168
 169     // MDI operations
 170     virtual void Maximize();
 171     virtual void Maximize(bool WXUNUSED(maximize)) { };
 172     inline void Minimize() { Iconize(TRUE); };
 173     virtual void Iconize(bool iconize);
 174     virtual void Restore();
 175     virtual void Activate();
 176     virtual bool IsIconized() const ;
 177
 178     // Is the frame maximized? Returns TRUE for
 179     // wxMDIChildFrame due to the tabbed implementation.
 180     virtual bool IsMaximized(void) const ;
 181
 182     bool Show(bool show);
 183
 184     WXWidget GetMainWidget() const { return m_mainWidget; };
 185     WXWidget GetTopWidget() const { return m_mainWidget; };
 186     WXWidget GetClientWidget() const { return m_mainWidget; };
 187
 188     /*
 189        virtual void OnRaise();
 190        virtual void OnLower();
 191      */
 192
 193     void SetMDIParentFrame(wxMDIParentFrame* parentFrame) { m_mdiParentFrame = parentFrame; }
 194     wxMDIParentFrame* GetMDIParentFrame() const { return m_mdiParentFrame; }
 195
 196 protected:
 197     wxMDIParentFrame* m_mdiParentFrame;
 198
 199     virtual void DoSetSize(int x, int y,
 200                            int width, int height,
 201                            int sizeFlags = wxSIZE_AUTO);
 202     virtual void DoSetClientSize(int width, int height);
 203 };
 204
 205 /* The client window is a child of the parent MDI frame, and itself
 206  * contains the child MDI frames.
 207  * However, you create the MDI children as children of the MDI parent:
 208  * only in the implementation does the client window become the parent
 209  * of the children. Phew! So the children are sort of 'adopted'...
 210  */
 211
 212 class WXDLLEXPORT wxMDIClientWindow: public wxNotebook
 213 {
 214 DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 215
 216 public:
 217     wxMDIClientWindow() ;
 218     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 219     {
 220         CreateClient(parent, style);
 221     }
 222
 223     ~wxMDIClientWindow();
 224
 225     void GetClientSize(int *width, int *height) const;
 226     void GetSize(int *width, int *height) const ;
 227     void GetPosition(int *x, int *y) const ;
 228
 229     // Note: this is virtual, to allow overridden behaviour.
 230     virtual bool CreateClient(wxMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL);
 231
 232     // Explicitly call default scroll behaviour
 233     void OnScroll(wxScrollEvent& event);
 234
 235     // Implementation
 236     void OnPageChanged(wxNotebookEvent& event);
 237
 238 protected:
 239     virtual void DoSetSize(int x, int y,
 240                            int width, int height,
 241                            int sizeFlags = wxSIZE_AUTO);
 242     virtual void DoSetClientSize(int width, int height);
 243
 244 private:
 245     DECLARE_EVENT_TABLE()
 246 };
 247
 248 #endif
 249     // _WX_MDI_H_