Set/GetWindowMenu added to MDI parent frame under MSW
[wxWidgets.git] / include / wx / msw / mdi.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: 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 virtual void InternalSetMenuBar();
102
103 wxMDIClientWindow * m_clientWindow;
104 wxMDIChildFrame * m_currentChild;
105 // WXHMENU m_windowMenu;
106 wxMenu* m_windowMenu;
107
108 // TRUE if MDI Frame is intercepting commands, not child
109 bool m_parentFrameActive;
110
111 private:
112 friend class WXDLLEXPORT wxMDIChildFrame;
113
114 DECLARE_EVENT_TABLE()
115 };
116
117 // ---------------------------------------------------------------------------
118 // wxMDIChildFrame
119 // ---------------------------------------------------------------------------
120
121 class WXDLLEXPORT wxMDIChildFrame : public wxFrame
122 {
123 DECLARE_DYNAMIC_CLASS(wxMDIChildFrame)
124
125 public:
126 wxMDIChildFrame();
127 wxMDIChildFrame(wxMDIParentFrame *parent,
128 wxWindowID id,
129 const wxString& title,
130 const wxPoint& pos = wxDefaultPosition,
131 const wxSize& size = wxDefaultSize,
132 long style = wxDEFAULT_FRAME_STYLE,
133 const wxString& name = wxFrameNameStr)
134 {
135 Create(parent, id, title, pos, size, style, name);
136 }
137
138 ~wxMDIChildFrame();
139
140 bool Create(wxMDIParentFrame *parent,
141 wxWindowID id,
142 const wxString& title,
143 const wxPoint& pos = wxDefaultPosition,
144 const wxSize& size = wxDefaultSize,
145 long style = wxDEFAULT_FRAME_STYLE,
146 const wxString& name = wxFrameNameStr);
147
148 virtual bool IsTopLevel() const { return FALSE; }
149
150 // MDI operations
151 virtual void Maximize(bool maximize = TRUE);
152 virtual void Restore();
153 virtual void Activate();
154
155 // Handlers
156
157 bool HandleMDIActivate(long bActivate, WXHWND, WXHWND);
158 bool HandleSize(int x, int y, WXUINT);
159 bool HandleWindowPosChanging(void *lpPos);
160 bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
161
162 virtual long MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
163 virtual long MSWDefWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
164 virtual bool MSWTranslateMessage(WXMSG *msg);
165
166 virtual void MSWDestroyWindow();
167
168 // Implementation
169 bool ResetWindowStyle(void *vrect);
170
171 protected:
172 virtual void DoGetPosition(int *x, int *y) const;
173 virtual void DoSetClientSize(int width, int height);
174 virtual void InternalSetMenuBar();
175 };
176
177 // ---------------------------------------------------------------------------
178 // wxMDIClientWindow
179 // ---------------------------------------------------------------------------
180
181 class WXDLLEXPORT wxMDIClientWindow : public wxWindow
182 {
183 DECLARE_DYNAMIC_CLASS(wxMDIClientWindow)
184
185 public:
186 wxMDIClientWindow() { Init(); }
187 wxMDIClientWindow(wxMDIParentFrame *parent, long style = 0)
188 {
189 Init();
190
191 CreateClient(parent, style);
192 }
193
194 // Note: this is virtual, to allow overridden behaviour.
195 virtual bool CreateClient(wxMDIParentFrame *parent,
196 long style = wxVSCROLL | wxHSCROLL);
197
198 // Explicitly call default scroll behaviour
199 void OnScroll(wxScrollEvent& event);
200
201 protected:
202 void Init() { m_scrollX = m_scrollY = 0; }
203
204 int m_scrollX, m_scrollY;
205
206 private:
207 DECLARE_EVENT_TABLE()
208 };
209
210 #endif
211 // _WX_MDI_H_