include/wx/msw/mdi.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/mdi.h
   3 // Purpose:     MDI (Multiple Document Interface) classes
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   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 #include "wx/frame.h"
  20
  21 WXDLLEXPORT_DATA(extern const wxChar*) wxFrameNameStr;
  22 WXDLLEXPORT_DATA(extern const wxChar*) wxStatusLineNameStr;
  23
  24 class WXDLLEXPORT wxMDIClientWindow;
  25 class WXDLLEXPORT wxMDIChildFrame;
  26
  27 // ---------------------------------------------------------------------------
  28 // wxMDIParentFrame
  29 // ---------------------------------------------------------------------------
  30
  31 class WXDLLEXPORT wxMDIParentFrame : public wxFrame
  32 {
  33     DECLARE_DYNAMIC_CLASS(wxMDIParentFrame)
  34
  35 public:
  36     wxMDIParentFrame();
  37     wxMDIParentFrame(wxWindow *parent,
  38                      wxWindowID id,
  39                      const wxString& title,
  40                      const wxPoint& pos = wxDefaultPosition,
  41                      const wxSize& size = wxDefaultSize,
  42                      long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  43                      const wxString& name = wxFrameNameStr)
  44     {
  45         Create(parent, id, title, pos, size, style, name);
  46     }
  47
  48     ~wxMDIParentFrame();
  49
  50     bool Create(wxWindow *parent,
  51                 wxWindowID id,
  52                 const wxString& title,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 long style = wxDEFAULT_FRAME_STYLE | wxVSCROLL | wxHSCROLL,
  56                 const wxString& name = wxFrameNameStr);
  57
  58     // accessors
  59     // ---------
  60
  61     // Get the active MDI child window (Windows only)
  62     wxMDIChildFrame *GetActiveChild() const;
  63
  64     // Get the client window
  65     wxMDIClientWindow *GetClientWindow() const { return m_clientWindow; }
  66
  67     // Create the client window class (don't Create the window,
  68     // just return a new class)
  69     virtual wxMDIClientWindow *OnCreateClient(void);
  70
  71 //    WXHMENU GetWindowHMENU() const { return m_windowMenu; }
  72     wxMenu* GetWindowMenu() const { return m_windowMenu; };
  73     void SetWindowMenu(wxMenu* menu) ;
  74
  75     // MDI operations
  76     // --------------
  77     virtual void Cascade();
  78     virtual void Tile();
  79     virtual void ArrangeIcons();
  80     virtual void ActivateNext();
  81     virtual void ActivatePrevious();
  82
  83     // handlers
  84     // --------
  85
  86     // Responds to colour changes
  87     void OnSysColourChanged(wxSysColourChangedEvent& event);
  88
  89     void OnSize(wxSizeEvent& event);
  90
  91     bool HandleActivate(int state, bool minimized, WXHWND activate);
  92     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
  93
  94     // override window proc for MDI-specific message processing
  95     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  96
  97     virtual long MSWDefWindowProc(WXUINT, WXWPARAM, WXLPARAM);
  98     virtual bool MSWTranslateMessage(WXMSG* msg);
  99
 100 protected:
 101 #if wxUSE_MENUS_NATIVE
 102     virtual void InternalSetMenuBar();
 103 #endif // wxUSE_MENUS_NATIVE
 104
 105     wxMDIClientWindow *             m_clientWindow;
 106     wxMDIChildFrame *               m_currentChild;
 107     wxMenu*                         m_windowMenu;
 108
 109     // TRUE if MDI Frame is intercepting commands, not child
 110     bool m_parentFrameActive;
 111
 112 private:
 113     friend class WXDLLEXPORT wxMDIChildFrame;
 114
 115     DECLARE_EVENT_TABLE()
 116 };
 117
 118 // ---------------------------------------------------------------------------
 119 // wxMDIChildFrame
 120 // ---------------------------------------------------------------------------
 121
 122 class WXDLLEXPORT wxMDIChildFrame : public wxFrame
 123 {
 124 public:
 125     wxMDIChildFrame() { Init(); }
 126     wxMDIChildFrame(wxMDIParentFrame *parent,
 127                     wxWindowID id,
 128                     const wxString& title,
 129                     const wxPoint& pos = wxDefaultPosition,
 130                     const wxSize& size = wxDefaultSize,
 131                     long style = wxDEFAULT_FRAME_STYLE,
 132                     const wxString& name = wxFrameNameStr)
 133     {
 134         Init();
 135
 136         Create(parent, id, title, pos, size, style, name);
 137     }
 138
 139     ~wxMDIChildFrame();
 140
 141     bool Create(wxMDIParentFrame *parent,
 142                 wxWindowID id,
 143                 const wxString& title,
 144                 const wxPoint& pos = wxDefaultPosition,
 145                 const wxSize& size = wxDefaultSize,
 146                 long style = wxDEFAULT_FRAME_STYLE,
 147                 const wxString& name = wxFrameNameStr);
 148
 149     virtual bool IsTopLevel() const { return FALSE; }
 150
 151     // MDI operations
 152     virtual void Maximize(bool maximize = TRUE);
 153     virtual void Restore();
 154     virtual void Activate();
 155
 156     // Implementation only from now on
 157     // -------------------------------
 158
 159     // Handlers
 160     bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
 161     bool HandleWindowPosChanging(void *lpPos);
 162     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 163     bool HandleGetMinMaxInfo(void *mmInfo);
 164
 165     virtual long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 166     virtual long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 167     virtual bool MSWTranslateMessage(WXMSG *msg);
 168
 169     virtual void MSWDestroyWindow();
 170
 171     bool ResetWindowStyle(void *vrect);
 172
 173     void OnIdle(wxIdleEvent& event);
 174
 175 protected:
 176     virtual void DoGetPosition(int *x, int *y) const;
 177     virtual void DoSetClientSize(int width, int height);
 178     virtual void InternalSetMenuBar();
 179     virtual bool IsMDIChild() const { return TRUE; }
 180
 181     // common part of all ctors
 182     void Init();
 183
 184 private:
 185     bool m_needsResize; // flag which tells us to artificially resize the frame
 186
 187     DECLARE_EVENT_TABLE()
 188     DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
 189 };
 190
 191 // ---------------------------------------------------------------------------
 192 // wxMDIClientWindow
 193 // ---------------------------------------------------------------------------
 194
 195 class WXDLLEXPORT wxMDIClientWindow : public wxWindow
 196 {
 197 public:
 198     wxMDIClientWindow() { Init(); }
 199     wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
 200     {
 201         Init();
 202
 203         CreateClient(parent, style);
 204     }
 205
 206     // Note: this is virtual, to allow overridden behaviour.
 207     virtual bool CreateClient(wxMDIParentFrame *parent,
 208                               long style = wxVSCROLL | wxHSCROLL);
 209
 210     // Explicitly call default scroll behaviour
 211     void OnScroll(wxScrollEvent& event);
 212
 213     virtual void DoSetSize(int x, int y,
 214                            int width, int height,
 215                            int sizeFlags = wxSIZE_AUTO);
 216 protected:
 217     void Init() { m_scrollX = m_scrollY = 0; }
 218
 219     int m_scrollX, m_scrollY;
 220
 221 private:
 222     DECLARE_EVENT_TABLE()
 223     DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
 224 };
 225
 226 #endif
 227     // _WX_MDI_H_