]> git.saurik.com Git - wxWidgets.git/blob - include/wx/msw/toplevel.h
Fix documentation of wxGridBagSizer::Add() spacer overload.
[wxWidgets.git] / include / wx / msw / toplevel.h
1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/toplevel.h
3 // Purpose: wxTopLevelWindowMSW is the MSW implementation of wxTLW
4 // Author: Vadim Zeitlin
5 // Modified by:
6 // Created: 20.09.01
7 // RCS-ID: $Id$
8 // Copyright: (c) 2001 SciTech Software, Inc. (www.scitechsoft.com)
9 // Licence: wxWindows licence
10 ///////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_MSW_TOPLEVEL_H_
13 #define _WX_MSW_TOPLEVEL_H_
14
15 // ----------------------------------------------------------------------------
16 // wxTopLevelWindowMSW
17 // ----------------------------------------------------------------------------
18
19 class WXDLLIMPEXP_CORE wxTopLevelWindowMSW : public wxTopLevelWindowBase
20 {
21 public:
22 // constructors and such
23 wxTopLevelWindowMSW() { Init(); }
24
25 wxTopLevelWindowMSW(wxWindow *parent,
26 wxWindowID id,
27 const wxString& title,
28 const wxPoint& pos = wxDefaultPosition,
29 const wxSize& size = wxDefaultSize,
30 long style = wxDEFAULT_FRAME_STYLE,
31 const wxString& name = wxFrameNameStr)
32 {
33 Init();
34
35 (void)Create(parent, id, title, pos, size, style, name);
36 }
37
38 bool Create(wxWindow *parent,
39 wxWindowID id,
40 const wxString& title,
41 const wxPoint& pos = wxDefaultPosition,
42 const wxSize& size = wxDefaultSize,
43 long style = wxDEFAULT_FRAME_STYLE,
44 const wxString& name = wxFrameNameStr);
45
46 virtual ~wxTopLevelWindowMSW();
47
48 // implement base class pure virtuals
49 virtual void SetTitle( const wxString& title);
50 virtual wxString GetTitle() const;
51 virtual void Maximize(bool maximize = true);
52 virtual bool IsMaximized() const;
53 virtual void Iconize(bool iconize = true);
54 virtual bool IsIconized() const;
55 virtual void SetIcons(const wxIconBundle& icons );
56 virtual void Restore();
57
58 virtual void SetLayoutDirection(wxLayoutDirection dir);
59
60 virtual void RequestUserAttention(int flags = wxUSER_ATTENTION_INFO);
61
62 virtual bool Show(bool show = true);
63 virtual void Raise();
64
65 virtual void ShowWithoutActivating();
66 virtual bool ShowFullScreen(bool show, long style = wxFULLSCREEN_ALL);
67 virtual bool IsFullScreen() const { return m_fsIsShowing; }
68
69 // wxMSW only: EnableCloseButton(false) may be used to remove the "Close"
70 // button from the title bar
71 virtual bool EnableCloseButton(bool enable = true);
72
73 // Set window transparency if the platform supports it
74 virtual bool SetTransparent(wxByte alpha);
75 virtual bool CanSetTransparent();
76
77
78 // MSW-specific methods
79 // --------------------
80
81 // Return the menu representing the "system" menu of the window. You can
82 // call wxMenu::AppendWhatever() methods on it but removing items from it
83 // is in general not a good idea.
84 //
85 // The pointer returned by this method belongs to the window and will be
86 // deleted when the window itself is, do not delete it yourself. May return
87 // NULL if getting the system menu failed.
88 wxMenu *MSWGetSystemMenu() const;
89
90
91 // implementation from now on
92 // --------------------------
93
94 // event handlers
95 void OnActivate(wxActivateEvent& event);
96
97 // called by wxWindow whenever it gets focus
98 void SetLastFocus(wxWindow *win) { m_winLastFocused = win; }
99 wxWindow *GetLastFocus() const { return m_winLastFocused; }
100
101 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
102 virtual void SetLeftMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL);
103 virtual void SetRightMenu(int id = wxID_ANY, const wxString& label = wxEmptyString, wxMenu *subMenu = NULL);
104 bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
105 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
106 #endif // __SMARTPHONE__ && __WXWINCE__
107
108 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
109 // Soft Input Panel (SIP) change notification
110 virtual bool HandleSettingChange(WXWPARAM wParam, WXLPARAM lParam);
111 #endif
112
113 // translate wxWidgets flags to Windows ones
114 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle) const;
115
116 // choose the right parent to use with CreateWindow()
117 virtual WXHWND MSWGetParent() const;
118
119 // window proc for the frames
120 WXLRESULT MSWWindowProc(WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
121
122 // returns true if the platform should explicitly apply a theme border
123 virtual bool CanApplyThemeBorder() const { return false; }
124
125 protected:
126 // common part of all ctors
127 void Init();
128
129 // create a new frame, return false if it couldn't be created
130 bool CreateFrame(const wxString& title,
131 const wxPoint& pos,
132 const wxSize& size);
133
134 // create a new dialog using the given dialog template from resources,
135 // return false if it couldn't be created
136 bool CreateDialog(const void *dlgTemplate,
137 const wxString& title,
138 const wxPoint& pos,
139 const wxSize& size);
140
141 // common part of Iconize(), Maximize() and Restore()
142 void DoShowWindow(int nShowCmd);
143
144 // override those to return the normal window coordinates even when the
145 // window is minimized
146 #ifndef __WXWINCE__
147 virtual void DoGetPosition(int *x, int *y) const;
148 virtual void DoGetSize(int *width, int *height) const;
149 #endif // __WXWINCE__
150
151 // Top level windows have different freeze semantics on Windows
152 virtual void DoFreeze();
153 virtual void DoThaw();
154
155 // helper of SetIcons(): calls gets the icon with the size specified by the
156 // given system metrics (SM_C{X|Y}[SM]ICON) from the bundle and sets it
157 // using WM_SETICON with the specified wParam (ICOM_SMALL or ICON_BIG);
158 // returns true if the icon was set
159 bool DoSelectAndSetIcon(const wxIconBundle& icons, int smX, int smY, int i);
160
161 // override wxWindow virtual method to use CW_USEDEFAULT if necessary
162 virtual void MSWGetCreateWindowCoords(const wxPoint& pos,
163 const wxSize& size,
164 int& x, int& y,
165 int& w, int& h) const;
166
167
168 // is the window currently iconized?
169 bool m_iconized;
170
171 // should the frame be maximized when it will be shown? set by Maximize()
172 // when it is called while the frame is hidden
173 bool m_maximizeOnShow;
174
175 // Data to save/restore when calling ShowFullScreen
176 long m_fsStyle; // Passed to ShowFullScreen
177 wxRect m_fsOldSize;
178 long m_fsOldWindowStyle;
179 bool m_fsIsMaximized;
180 bool m_fsIsShowing;
181
182 // Save the current focus to m_winLastFocused if we're not iconized (the
183 // focus is always NULL when we're iconized).
184 void DoSaveLastFocus();
185
186 // Restore focus to m_winLastFocused if possible and needed.
187 void DoRestoreLastFocus();
188
189 // The last focused child: we remember it when we're deactivated and
190 // restore focus to it when we're activated (this is done here) or restored
191 // from iconic state (done by wxFrame).
192 wxWindow *m_winLastFocused;
193
194 #if defined(__SMARTPHONE__) && defined(__WXWINCE__)
195 class ButtonMenu
196 {
197 public:
198 ButtonMenu();
199 ~ButtonMenu();
200
201 void SetButton(int id = wxID_ANY,
202 const wxString& label = wxEmptyString,
203 wxMenu *subMenu = NULL);
204
205 bool IsAssigned() const {return m_assigned;}
206 bool IsMenu() const {return m_menu!=NULL;}
207
208 int GetId() const {return m_id;}
209 wxMenu* GetMenu() const {return m_menu;}
210 wxString GetLabel() {return m_label;}
211
212 static wxMenu *DuplicateMenu(wxMenu *menu);
213
214 protected:
215 int m_id;
216 wxString m_label;
217 wxMenu *m_menu;
218 bool m_assigned;
219 };
220
221 ButtonMenu m_LeftButton;
222 ButtonMenu m_RightButton;
223 HWND m_MenuBarHWND;
224
225 void ReloadButton(ButtonMenu& button, UINT menuID);
226 void ReloadAllButtons();
227 #endif // __SMARTPHONE__ && __WXWINCE__
228
229 private:
230
231 #if defined(__SMARTPHONE__) || defined(__POCKETPC__)
232 void* m_activateInfo;
233 #endif
234
235 // The system menu: initially NULL but can be set (once) by
236 // MSWGetSystemMenu(). Owned by this window.
237 wxMenu *m_menuSystem;
238
239 DECLARE_EVENT_TABLE()
240 wxDECLARE_NO_COPY_CLASS(wxTopLevelWindowMSW);
241 };
242
243 #endif // _WX_MSW_TOPLEVEL_H_