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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  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 class WXDLLEXPORT wxMDIClientWindow;
  31 class WXDLLEXPORT wxMDIChildFrame;
  32
  33 class WXDLLEXPORT wxMDIParentFrame: public wxFrame
  34 {
  35     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
  36
  37         friend class WXDLLEXPORT wxMDIChildFrame;
  38 public:
  39
  40     wxMDIParentFrame();
  41     inline wxMDIParentFrame(wxWindow *parent,
  42         wxWindowID id,
  43         const wxString& title,
  44         const wxPoint& pos = wxDefaultPosition,
  45         const wxSize& size = wxDefaultSize,
  46         long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,  // Scrolling refers to client window
  47         const wxString& name = wxFrameNameStr)
  48     {
  49         Create(parent, id, title, pos, size, style, name);
  50     }
  51
  52     ~wxMDIParentFrame();
  53
  54     bool Create(wxWindow *parent,
  55         wxWindowID id,
  56         const wxString& title,
  57         const wxPoint& pos = wxDefaultPosition,
  58         const wxSize& size = wxDefaultSize,
  59         long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  60         const wxString& name = wxFrameNameStr);
  61
  62     void OnSize(wxSizeEvent& event);
  63     void OnActivate(wxActivateEvent& event);
  64     void OnSysColourChanged(wxSysColourChangedEvent& event);
  65     void OnMenuHighlight(wxMenuEvent& event);
  66
  67     void SetMenuBar(wxMenuBar *menu_bar);
  68
  69     // Get the active MDI child window
  70     wxMDIChildFrame *GetActiveChild() const ;
  71
  72     // Get the client window
  73     wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; };
  74
  75     // Create the client window class (don't Create the window,
  76     // just return a new class)
  77     virtual wxMDIClientWindow *OnCreateClient() ;
  78
  79     // MDI operations
  80     virtual void Cascade();
  81     virtual void Tile();
  82     virtual void ArrangeIcons();
  83     virtual void ActivateNext();
  84     virtual void ActivatePrevious();
  85
  86     // Implementation
  87
  88     // Set the active child
  89     inline void SetActiveChild(wxMDIChildFrame* child) { m_activeChild = child; }
  90
  91     // Set the child's menubar into the parent frame
  92     void SetChildMenuBar(wxMDIChildFrame* frame);
  93
  94     inline wxMenuBar* GetActiveMenuBar() const { return m_activeMenuBar; }
  95
  96     // Redirect events to active child first
  97     virtual bool ProcessEvent(wxEvent& event);
  98
  99 protected:
 100     virtual void DoSetSize(int x, int y,
 101         int width, int height,
 102         int sizeFlags = wxSIZE_AUTO);
 103     virtual void DoSetClientSize(int width, int height);
 104
 105     // Gets the size available for subwindows after menu size, toolbar size
 106     // and status bar size have been subtracted. If you want to manage your own
 107     // toolbar(s), don't call SetToolBar.
 108     void DoGetClientSize(int *width, int *height) const;
 109
 110 protected:
 111
 112     wxMDIClientWindow*    m_clientWindow;
 113     wxMDIChildFrame*      m_activeChild;
 114     wxMenuBar*            m_activeMenuBar;
 115
 116     DECLARE_EVENT_TABLE()
 117 };
 118
 119 class WXDLLEXPORT wxMDIChildFrame: public wxFrame
 120 {
 121     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 122
 123 public:
 124     wxMDIChildFrame();
 125     wxMDIChildFrame(wxMDIParentFrame *parent,
 126         wxWindowID id,
 127         const wxString& title,
 128         const wxPoint& pos = wxDefaultPosition,
 129         const wxSize& size = wxDefaultSize,
 130         long style = wxDEFAULT_FRAME_STYLE,
 131         const wxString& name = wxFrameNameStr)
 132     {
 133         Create(parent, id, title, pos, size, style, name);
 134     }
 135
 136     ~wxMDIChildFrame();
 137
 138     bool Create(wxMDIParentFrame *parent,
 139         wxWindowID id,
 140         const wxString& title,
 141         const wxPoint& pos = wxDefaultPosition,
 142         const wxSize& size = wxDefaultSize,
 143         long style = wxDEFAULT_FRAME_STYLE,
 144         const wxString& name = wxFrameNameStr);
 145
 146     // Set menu bar
 147     void SetMenuBar(wxMenuBar *menu_bar);
 148     void SetTitle(const wxString& title);
 149
 150     // Set icon
 151     virtual void SetIcon(const wxIcon& icon);
 152     virtual void SetIcons(const wxIconBundle& icons );
 153
 154     // Override wxFrame operations
 155     void CaptureMouse();
 156     void ReleaseMouse();
 157     void Raise();
 158     void Lower(void);
 159     void DoSetSizeHints(int minW = -1, int minH = -1, int maxW = -1, int maxH = -1, int incW = -1, int incH = -1);
 160
 161     // MDI operations
 162     virtual void Maximize();
 163     virtual void Maximize(bool WXUNUSED(maximize)) { };
 164     inline void Minimize() { Iconize(true); };
 165     virtual void Iconize(bool iconize);
 166     virtual void Restore();
 167     virtual void Activate();
 168     virtual bool IsIconized() const ;
 169
 170     virtual bool IsTopLevel() const { return false; }
 171
 172     // Is the frame maximized? Returns true for
 173     // wxMDIChildFrame due to the tabbed implementation.
 174     virtual bool IsMaximized(void) const ;
 175
 176     bool Show(bool show);
 177
 178     WXWidget GetMainWidget() const { return m_mainWidget; };
 179     WXWidget GetTopWidget() const { return m_mainWidget; };
 180     WXWidget GetClientWidget() const { return m_mainWidget; };
 181
 182     /*
 183     virtual void OnRaise();
 184     virtual void OnLower();
 185     */
 186
 187     void SetMDIParentFrame(wxMDIParentFrame* parentFrame) { m_mdiParentFrame = parentFrame; }
 188     wxMDIParentFrame* GetMDIParentFrame() const { return m_mdiParentFrame; }
 189
 190 protected:
 191     wxMDIParentFrame* m_mdiParentFrame;
 192
 193     virtual void DoSetSize(int x, int y,
 194         int width, int height,
 195         int sizeFlags = wxSIZE_AUTO);
 196     virtual void DoSetClientSize(int width, int height);
 197
 198     void DoGetClientSize(int *width, int *height) const;
 199     void DoGetSize(int *width, int *height) const;
 200     void DoGetPosition(int *x, int *y) const ;
 201 };
 202
 203 /* The client window is a child of the parent MDI frame, and itself
 204 * contains the child MDI frames.
 205 * However, you create the MDI children as children of the MDI parent:
 206 * only in the implementation does the client window become the parent
 207 * of the children. Phew! So the children are sort of 'adopted'...
 208 */
 209
 210 class WXDLLEXPORT wxMDIClientWindow: public wxNotebook
 211 {
 212     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 213
 214 public:
 215     wxMDIClientWindow() ;
 216     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 217     {
 218         CreateClient(parent, style);
 219     }
 220
 221     ~wxMDIClientWindow();
 222
 223     // Note: this is virtual, to allow overridden behaviour.
 224     virtual bool CreateClient(wxMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL);
 225
 226     // Explicitly call default scroll behaviour
 227     void OnScroll(wxScrollEvent& event);
 228
 229     // Implementation
 230     void OnPageChanged(wxNotebookEvent& event);
 231
 232     int FindPage(const wxNotebookPage* page);
 233
 234 protected:
 235     virtual void DoSetSize(int x, int y,
 236         int width, int height,
 237         int sizeFlags = wxSIZE_AUTO);
 238     virtual void DoSetClientSize(int width, int height);
 239
 240     void DoGetClientSize(int *width, int *height) const;
 241     void DoGetSize(int *width, int *height) const ;
 242     void DoGetPosition(int *x, int *y) const ;
 243
 244 private:
 245     DECLARE_EVENT_TABLE()
 246 };
 247
 248 #endif
 249 // _WX_MDI_H_