]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: window.h | |
3 | // Purpose: wxWindow class | |
4 | // Author: Julian Smart | |
5 | // Modified by: | |
6 | // Created: 01/02/97 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) Julian Smart and Markus Holzem | |
9 | // Licence: wxWindows licence | |
10 | ///////////////////////////////////////////////////////////////////////////// | |
11 | ||
12 | #ifndef _WX_WINDOW_H_ | |
13 | #define _WX_WINDOW_H_ | |
14 | ||
15 | // --------------------------------------------------------------------------- | |
16 | // headers | |
17 | // --------------------------------------------------------------------------- | |
18 | ||
19 | #ifdef __GNUG__ | |
20 | #pragma interface "window.h" | |
21 | #endif | |
22 | ||
23 | // #include "wx/msw/winundef.h" | |
24 | ||
25 | // VZ: apparently some version of Windows send extra mouse move messages after | |
26 | // a mouse click. My tests under NT 4.0 and 95 didn't show it so I'm | |
27 | // tempted to think that it was just an effect of a poor mouse and so the | |
28 | // code to work around this is currently disabled - just define this as 1 | |
29 | // to reenable it | |
30 | #define wxUSE_MOUSEEVENT_HACK 0 | |
31 | ||
32 | // --------------------------------------------------------------------------- | |
33 | // forward declarations | |
34 | // --------------------------------------------------------------------------- | |
35 | ||
36 | class WXDLLEXPORT wxButton; | |
37 | ||
38 | // --------------------------------------------------------------------------- | |
39 | // constants | |
40 | // --------------------------------------------------------------------------- | |
41 | ||
42 | // FIXME does anybody use those? they're unused by wxWindows... | |
43 | enum | |
44 | { | |
45 | wxKEY_SHIFT = 1, | |
46 | wxKEY_CTRL = 2 | |
47 | }; | |
48 | ||
49 | // --------------------------------------------------------------------------- | |
50 | // wxWindow declaration for MSW | |
51 | // --------------------------------------------------------------------------- | |
52 | ||
53 | class WXDLLEXPORT wxWindow : public wxWindowBase | |
54 | { | |
55 | public: | |
56 | wxWindow() { Init(); } | |
57 | ||
58 | wxWindow(wxWindow *parent, | |
59 | wxWindowID id, | |
60 | const wxPoint& pos = wxDefaultPosition, | |
61 | const wxSize& size = wxDefaultSize, | |
62 | long style = 0, | |
63 | const wxString& name = wxPanelNameStr) | |
64 | { | |
65 | Init(); | |
66 | Create(parent, id, pos, size, style, name); | |
67 | } | |
68 | ||
69 | virtual ~wxWindow(); | |
70 | ||
71 | bool Create(wxWindow *parent, | |
72 | wxWindowID id, | |
73 | const wxPoint& pos = wxDefaultPosition, | |
74 | const wxSize& size = wxDefaultSize, | |
75 | long style = 0, | |
76 | const wxString& name = wxPanelNameStr); | |
77 | ||
78 | // implement base class pure virtuals | |
79 | virtual void SetTitle( const wxString& title); | |
80 | virtual wxString GetTitle() const; | |
81 | ||
82 | virtual void Raise(); | |
83 | virtual void Lower(); | |
84 | ||
85 | virtual bool Show( bool show = TRUE ); | |
86 | virtual bool Enable( bool enable = TRUE ); | |
87 | ||
88 | virtual void SetFocus(); | |
89 | ||
90 | virtual bool Reparent( wxWindow *newParent ); | |
91 | ||
92 | virtual void WarpPointer(int x, int y); | |
93 | virtual void CaptureMouse(); | |
94 | virtual void ReleaseMouse(); | |
95 | ||
96 | virtual void Refresh( bool eraseBackground = TRUE, | |
97 | const wxRect *rect = (const wxRect *) NULL ); | |
98 | virtual void Clear(); | |
99 | ||
100 | virtual bool SetCursor( const wxCursor &cursor ); | |
101 | virtual bool SetFont( const wxFont &font ); | |
102 | ||
103 | virtual int GetCharHeight() const; | |
104 | virtual int GetCharWidth() const; | |
105 | virtual void GetTextExtent(const wxString& string, | |
106 | int *x, int *y, | |
107 | int *descent = (int *) NULL, | |
108 | int *externalLeading = (int *) NULL, | |
109 | const wxFont *theFont = (const wxFont *) NULL) | |
110 | const; | |
111 | ||
112 | virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); | |
113 | ||
114 | virtual void SetScrollbar( int orient, int pos, int thumbVisible, | |
115 | int range, bool refresh = TRUE ); | |
116 | virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE ); | |
117 | virtual int GetScrollPos( int orient ) const; | |
118 | virtual int GetScrollThumb( int orient ) const; | |
119 | virtual int GetScrollRange( int orient ) const; | |
120 | virtual void ScrollWindow( int dx, int dy, | |
121 | const wxRect* rect = (wxRect *) NULL ); | |
122 | ||
123 | #if wxUSE_DRAG_AND_DROP | |
124 | virtual void SetDropTarget( wxDropTarget *dropTarget ); | |
125 | #endif // wxUSE_DRAG_AND_DROP | |
126 | ||
127 | // Accept files for dragging | |
128 | virtual void DragAcceptFiles(bool accept); | |
129 | ||
130 | #if WXWIN_COMPATIBILITY | |
131 | // Set/get scroll attributes | |
132 | virtual void SetScrollRange(int orient, int range, bool refresh = TRUE); | |
133 | virtual void SetScrollPage(int orient, int page, bool refresh = TRUE); | |
134 | virtual int OldGetScrollRange(int orient) const; | |
135 | virtual int GetScrollPage(int orient) const; | |
136 | ||
137 | // event handlers | |
138 | // Handle a control command | |
139 | virtual void OnCommand(wxWindow& win, wxCommandEvent& event); | |
140 | ||
141 | // Override to define new behaviour for default action (e.g. double | |
142 | // clicking on a listbox) | |
143 | virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { } | |
144 | #endif // WXWIN_COMPATIBILITY | |
145 | ||
146 | #if wxUSE_CARET && WXWIN_COMPATIBILITY | |
147 | // caret manipulation (old MSW only functions, see wxCaret class for the | |
148 | // new API) | |
149 | void CreateCaret(int w, int h); | |
150 | void CreateCaret(const wxBitmap *bitmap); | |
151 | void DestroyCaret(); | |
152 | void ShowCaret(bool show); | |
153 | void SetCaretPos(int x, int y); | |
154 | void GetCaretPos(int *x, int *y) const; | |
155 | #endif // wxUSE_CARET | |
156 | ||
157 | // Native resource loading (implemented in src/msw/nativdlg.cpp) | |
158 | // FIXME: should they really be all virtual? | |
159 | virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id); | |
160 | virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name); | |
161 | wxWindow* GetWindowChild1(wxWindowID id); | |
162 | wxWindow* GetWindowChild(wxWindowID id); | |
163 | ||
164 | // a MSW only function which sends a size event to the window using its | |
165 | // current size - this has an effect of refreshing the window layout | |
166 | /* | |
167 | FUNCTION IS NOW A MEMBER OF wxFrame - gt | |
168 | void SendSizeEvent(); | |
169 | */ | |
170 | ||
171 | // implementation from now on | |
172 | // -------------------------- | |
173 | ||
174 | // simple accessors | |
175 | // ---------------- | |
176 | ||
177 | WXHWND GetHWND() const { return m_hWnd; } | |
178 | void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; } | |
179 | virtual WXWidget GetHandle() const { return GetHWND(); } | |
180 | ||
181 | bool GetUseCtl3D() const { return m_useCtl3D; } | |
182 | bool GetTransparentBackground() const { return m_backgroundTransparent; } | |
183 | void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; } | |
184 | ||
185 | // event handlers | |
186 | // -------------- | |
187 | ||
188 | void OnSetFocus(wxFocusEvent& event); | |
189 | void OnEraseBackground(wxEraseEvent& event); | |
190 | void OnIdle(wxIdleEvent& event); | |
191 | void OnPaint(wxPaintEvent& event); | |
192 | ||
193 | public: | |
194 | // For implementation purposes - sometimes decorations make the client area | |
195 | // smaller | |
196 | virtual wxPoint GetClientAreaOrigin() const; | |
197 | ||
198 | // Makes an adjustment to the window position (for example, a frame that has | |
199 | // a toolbar that it manages itself). | |
200 | virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags); | |
201 | ||
202 | // Windows subclassing | |
203 | void SubclassWin(WXHWND hWnd); | |
204 | void UnsubclassWin(); | |
205 | ||
206 | WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; } | |
207 | void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; } | |
208 | ||
209 | wxWindow *FindItem(long id) const; | |
210 | wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const; | |
211 | ||
212 | // Make a Windows extended style from the given wxWindows window style | |
213 | static WXDWORD MakeExtendedStyle(long style, | |
214 | bool eliminateBorders = FALSE); | |
215 | // Determine whether 3D effects are wanted | |
216 | WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const; | |
217 | ||
218 | // MSW only: TRUE if this control is part of the main control | |
219 | virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; }; | |
220 | ||
221 | // returns TRUE if the window has been created | |
222 | bool MSWCreate(int id, | |
223 | wxWindow *parent, | |
224 | const wxChar *wclass, | |
225 | wxWindow *wx_win, | |
226 | const wxChar *title, | |
227 | int x, int y, int width, int height, | |
228 | WXDWORD style, | |
229 | const wxChar *dialog_template = NULL, | |
230 | WXDWORD exendedStyle = 0); | |
231 | virtual bool MSWCommand(WXUINT param, WXWORD id); | |
232 | ||
233 | #if WXWIN_COMPATIBILITY | |
234 | wxObject *GetChild(int number) const; | |
235 | virtual void MSWDeviceToLogical(float *x, float *y) const; | |
236 | #endif // WXWIN_COMPATIBILITY | |
237 | ||
238 | // Create an appropriate wxWindow from a HWND | |
239 | virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd); | |
240 | ||
241 | // Make sure the window style reflects the HWND style (roughly) | |
242 | virtual void AdoptAttributesFromHWND(); | |
243 | ||
244 | // Setup background and foreground colours correctly | |
245 | virtual void SetupColours(); | |
246 | ||
247 | // ------------------------------------------------------------------------ | |
248 | // helpers for message handlers: these perform the same function as the | |
249 | // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into | |
250 | // the correct parameters | |
251 | // ------------------------------------------------------------------------ | |
252 | ||
253 | void UnpackCommand(WXWPARAM wParam, WXLPARAM lParam, | |
254 | WXWORD *id, WXHWND *hwnd, WXWORD *cmd); | |
255 | void UnpackActivate(WXWPARAM wParam, WXLPARAM lParam, | |
256 | WXWORD *state, WXWORD *minimized, WXHWND *hwnd); | |
257 | void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam, | |
258 | WXWORD *code, WXWORD *pos, WXHWND *hwnd); | |
259 | void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam, | |
260 | WXWORD *nCtlColor, WXHDC *hdc, WXHWND *hwnd); | |
261 | void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam, | |
262 | WXWORD *item, WXWORD *flags, WXHMENU *hmenu); | |
263 | ||
264 | // ------------------------------------------------------------------------ | |
265 | // internal handlers for MSW messages: all handlers return a boolean value: | |
266 | // TRUE means that the handler processed the event and FALSE that it didn't | |
267 | // ------------------------------------------------------------------------ | |
268 | ||
269 | // there are several cases where we have virtual functions for Windows | |
270 | // message processing: this is because these messages often require to be | |
271 | // processed in a different manner in the derived classes. For all other | |
272 | // messages, however, we do *not* have corresponding MSWOnXXX() function | |
273 | // and if the derived class wants to process them, it should override | |
274 | // MSWWindowProc() directly. | |
275 | ||
276 | // scroll event (both horizontal and vertical) | |
277 | virtual bool MSWOnScroll(int orientation, WXWORD nSBCode, | |
278 | WXWORD pos, WXHWND control); | |
279 | ||
280 | // child control notifications | |
281 | #ifdef __WIN95__ | |
282 | virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); | |
283 | #endif // __WIN95__ | |
284 | ||
285 | // owner-drawn controls need to process these messages | |
286 | virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item); | |
287 | virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item); | |
288 | ||
289 | // the rest are not virtual | |
290 | bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate); | |
291 | bool HandleInitDialog(WXHWND hWndFocus); | |
292 | bool HandleDestroy(); | |
293 | ||
294 | bool HandlePaint(); | |
295 | bool HandleEraseBkgnd(WXHDC pDC); | |
296 | ||
297 | bool HandleMinimize(); | |
298 | bool HandleMaximize(); | |
299 | bool HandleSize(int x, int y, WXUINT flag); | |
300 | bool HandleGetMinMaxInfo(void *mmInfo); | |
301 | ||
302 | bool HandleShow(bool show, int status); | |
303 | bool HandleActivate(int flag, bool minimized, WXHWND activate); | |
304 | ||
305 | bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control); | |
306 | bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam); | |
307 | ||
308 | bool HandleCtlColor(WXHBRUSH *hBrush, | |
309 | WXHDC hdc, | |
310 | WXHWND hWnd, | |
311 | WXUINT nCtlColor, | |
312 | WXUINT message, | |
313 | WXWPARAM wParam, | |
314 | WXLPARAM lParam); | |
315 | ||
316 | bool HandlePaletteChanged(WXHWND hWndPalChange); | |
317 | bool HandleQueryNewPalette(); | |
318 | bool HandleSysColorChange(); | |
319 | ||
320 | bool HandleQueryEndSession(long logOff, bool *mayEnd); | |
321 | bool HandleEndSession(bool endSession, long logOff); | |
322 | ||
323 | bool HandleSetFocus(WXHWND wnd); | |
324 | bool HandleKillFocus(WXHWND wnd); | |
325 | ||
326 | bool HandleDropFiles(WXWPARAM wParam); | |
327 | ||
328 | bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags); | |
329 | bool HandleMouseMove(int x, int y, WXUINT flags); | |
330 | ||
331 | bool HandleChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE); | |
332 | bool HandleKeyDown(WXWORD wParam, WXLPARAM lParam); | |
333 | bool HandleKeyUp(WXWORD wParam, WXLPARAM lParam); | |
334 | ||
335 | bool HandleQueryDragIcon(WXHICON *hIcon); | |
336 | ||
337 | bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg); | |
338 | ||
339 | // Window procedure | |
340 | virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); | |
341 | ||
342 | // Calls an appropriate default window procedure | |
343 | virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); | |
344 | virtual bool MSWProcessMessage(WXMSG* pMsg); | |
345 | virtual bool MSWTranslateMessage(WXMSG* pMsg); | |
346 | virtual void MSWDestroyWindow(); | |
347 | ||
348 | // Detach "Window" menu from menu bar so it doesn't get deleted | |
349 | void MSWDetachWindowMenu(); | |
350 | ||
351 | // this function should return the brush to paint the window background | |
352 | // with or 0 for the default brush | |
353 | virtual WXHBRUSH OnCtlColor(WXHDC hDC, | |
354 | WXHWND hWnd, | |
355 | WXUINT nCtlColor, | |
356 | WXUINT message, | |
357 | WXWPARAM wParam, | |
358 | WXLPARAM lParam); | |
359 | ||
360 | #if WXWIN_COMPATIBILITY | |
361 | void SetShowing(bool show) { (void)Show(show); } | |
362 | bool IsUserEnabled() const { return IsEnabled(); } | |
363 | #endif // WXWIN_COMPATIBILITY | |
364 | ||
365 | // Responds to colour changes: passes event on to children. | |
366 | void OnSysColourChanged(wxSysColourChangedEvent& event); | |
367 | ||
368 | // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX) | |
369 | void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags); | |
370 | ||
371 | protected: | |
372 | // the window handle | |
373 | WXHWND m_hWnd; | |
374 | ||
375 | // the old window proc (we subclass all windows) | |
376 | WXFARPROC m_oldWndProc; | |
377 | ||
378 | // additional (MSW specific) flags | |
379 | bool m_useCtl3D:1; // Using CTL3D for this control | |
380 | bool m_backgroundTransparent:1; | |
381 | bool m_mouseInWindow:1; | |
382 | bool m_doubleClickAllowed:1; | |
383 | bool m_winCaptured:1; | |
384 | ||
385 | // the size of one page for scrolling | |
386 | int m_xThumbSize; | |
387 | int m_yThumbSize; | |
388 | ||
389 | #if wxUSE_MOUSEEVENT_HACK | |
390 | // the coordinates of the last mouse event and the type of it | |
391 | long m_lastMouseX, | |
392 | m_lastMouseY; | |
393 | int m_lastMouseEvent; | |
394 | #endif // wxUSE_MOUSEEVENT_HACK | |
395 | ||
396 | WXHMENU m_hMenu; // Menu, if any | |
397 | ||
398 | // the return value of WM_GETDLGCODE handler | |
399 | long m_lDlgCode; | |
400 | ||
401 | // implement the base class pure virtuals | |
402 | virtual void DoClientToScreen( int *x, int *y ) const; | |
403 | virtual void DoScreenToClient( int *x, int *y ) const; | |
404 | virtual void DoGetPosition( int *x, int *y ) const; | |
405 | virtual void DoGetSize( int *width, int *height ) const; | |
406 | virtual void DoGetClientSize( int *width, int *height ) const; | |
407 | virtual void DoSetSize(int x, int y, | |
408 | int width, int height, | |
409 | int sizeFlags = wxSIZE_AUTO); | |
410 | virtual void DoSetClientSize(int width, int height); | |
411 | ||
412 | // move the window to the specified location and resize it: this is called | |
413 | // from both DoSetSize() and DoSetClientSize() and would usually just call | |
414 | // ::MoveWindow() except for composite controls which will want to arrange | |
415 | // themselves inside the given rectangle | |
416 | virtual void DoMoveWindow(int x, int y, int width, int height); | |
417 | ||
418 | #if wxUSE_TOOLTIPS | |
419 | virtual void DoSetToolTip( wxToolTip *tip ); | |
420 | #endif // wxUSE_TOOLTIPS | |
421 | ||
422 | private: | |
423 | // common part of all ctors | |
424 | void Init(); | |
425 | ||
426 | // the (non-virtual) handlers for the events | |
427 | bool HandleMove(int x, int y); | |
428 | bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags); | |
429 | ||
430 | #ifdef __WIN95__ | |
431 | bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result); | |
432 | #endif // __WIN95__ | |
433 | ||
434 | // the helper functions used by HandleChar/KeyXXX methods | |
435 | wxKeyEvent CreateKeyEvent(wxEventType evType, int id, WXLPARAM lp) const; | |
436 | ||
437 | DECLARE_DYNAMIC_CLASS(wxWindow); | |
438 | DECLARE_NO_COPY_CLASS(wxWindow); | |
439 | DECLARE_EVENT_TABLE() | |
440 | }; | |
441 | ||
442 | // --------------------------------------------------------------------------- | |
443 | // global functions | |
444 | // --------------------------------------------------------------------------- | |
445 | ||
446 | // kbd code translation | |
447 | WXDLLEXPORT int wxCharCodeMSWToWX(int keySym); | |
448 | WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual); | |
449 | ||
450 | #endif | |
451 | // _WX_WINDOW_H_ |