added a generic mechanism for registering global handlers for custom windows messages...
[wxWidgets.git] / include / wx / msw / window.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/msw/window.h
3 // Purpose: wxWindowMSW class
4 // Author: Julian Smart
5 // Modified by: Vadim Zeitlin on 13.05.99: complete refont of message handling,
6 // elimination of Default(), ...
7 // Created: 01/02/97
8 // RCS-ID: $Id$
9 // Copyright: (c) Julian Smart
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
12
13 #ifndef _WX_WINDOW_H_
14 #define _WX_WINDOW_H_
15
16 // ---------------------------------------------------------------------------
17 // constants
18 // ---------------------------------------------------------------------------
19
20 // ---------------------------------------------------------------------------
21 // wxWindow declaration for MSW
22 // ---------------------------------------------------------------------------
23
24 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
25 {
26 friend class wxSpinCtrl;
27 friend class wxSlider;
28 friend class wxRadioBox;
29 #if defined __VISUALC__ && __VISUALC__ <= 1200
30 friend class wxWindowMSW;
31 #endif
32 public:
33 wxWindowMSW() { Init(); }
34
35 wxWindowMSW(wxWindow *parent,
36 wxWindowID id,
37 const wxPoint& pos = wxDefaultPosition,
38 const wxSize& size = wxDefaultSize,
39 long style = 0,
40 const wxString& name = wxPanelNameStr)
41 {
42 Init();
43 Create(parent, id, pos, size, style, name);
44 }
45
46 virtual ~wxWindowMSW();
47
48 bool Create(wxWindow *parent,
49 wxWindowID id,
50 const wxPoint& pos = wxDefaultPosition,
51 const wxSize& size = wxDefaultSize,
52 long style = 0,
53 const wxString& name = wxPanelNameStr);
54
55 // implement base class pure virtuals
56 virtual void SetLabel(const wxString& label);
57 virtual wxString GetLabel() const;
58
59 virtual void Raise();
60 virtual void Lower();
61
62 virtual bool Show( bool show = true );
63 virtual void DoEnable( bool enable );
64
65 virtual void SetFocus();
66 virtual void SetFocusFromKbd();
67
68 virtual bool Reparent(wxWindowBase *newParent);
69
70 virtual void WarpPointer(int x, int y);
71
72 virtual void Refresh( bool eraseBackground = true,
73 const wxRect *rect = (const wxRect *) NULL );
74 virtual void Update();
75 virtual void Freeze();
76 virtual void Thaw();
77 virtual bool IsFrozen() const { return m_frozenness > 0; }
78
79 virtual void SetWindowStyleFlag(long style);
80 virtual void SetExtraStyle(long exStyle);
81 virtual bool SetCursor( const wxCursor &cursor );
82 virtual bool SetFont( const wxFont &font );
83
84 virtual int GetCharHeight() const;
85 virtual int GetCharWidth() const;
86 virtual void GetTextExtent(const wxString& string,
87 int *x, int *y,
88 int *descent = (int *) NULL,
89 int *externalLeading = (int *) NULL,
90 const wxFont *theFont = (const wxFont *) NULL)
91 const;
92
93 virtual void SetScrollbar( int orient, int pos, int thumbVisible,
94 int range, bool refresh = true );
95 virtual void SetScrollPos( int orient, int pos, bool refresh = true );
96 virtual int GetScrollPos( int orient ) const;
97 virtual int GetScrollThumb( int orient ) const;
98 virtual int GetScrollRange( int orient ) const;
99 virtual void ScrollWindow( int dx, int dy,
100 const wxRect* rect = (wxRect *) NULL );
101
102 virtual bool ScrollLines(int lines);
103 virtual bool ScrollPages(int pages);
104
105 virtual void SetLayoutDirection(wxLayoutDirection dir);
106 virtual wxLayoutDirection GetLayoutDirection() const;
107 virtual wxCoord AdjustForLayoutDirection(wxCoord x,
108 wxCoord width,
109 wxCoord widthTotal) const;
110
111 #if wxUSE_DRAG_AND_DROP
112 virtual void SetDropTarget( wxDropTarget *dropTarget );
113 #endif // wxUSE_DRAG_AND_DROP
114
115 // Accept files for dragging
116 virtual void DragAcceptFiles(bool accept);
117
118 #ifndef __WXUNIVERSAL__
119 // Native resource loading (implemented in src/msw/nativdlg.cpp)
120 // FIXME: should they really be all virtual?
121 virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
122 virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
123 wxWindow* GetWindowChild1(wxWindowID id);
124 wxWindow* GetWindowChild(wxWindowID id);
125 #endif // __WXUNIVERSAL__
126
127 #if wxUSE_HOTKEY
128 // install and deinstall a system wide hotkey
129 virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
130 virtual bool UnregisterHotKey(int hotkeyId);
131 #endif // wxUSE_HOTKEY
132
133 #ifdef __POCKETPC__
134 bool IsContextMenuEnabled() const { return m_contextMenuEnabled; }
135 void EnableContextMenu(bool enable = true) { m_contextMenuEnabled = enable; }
136 #endif
137
138 // window handle stuff
139 // -------------------
140
141 WXHWND GetHWND() const { return m_hWnd; }
142 void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
143 virtual WXWidget GetHandle() const { return GetHWND(); }
144
145 void AssociateHandle(WXWidget handle);
146 void DissociateHandle();
147
148 // does this window have deferred position and/or size?
149 bool IsSizeDeferred() const;
150
151 // these functions allow to register a global handler for the given Windows
152 // message: it will be called from MSWWindowProc() of any window which gets
153 // this event if it's not processed before (i.e. unlike a hook procedure it
154 // does not override the normal processing)
155 //
156 // notice that if you want to process a message for a given window only you
157 // should override its MSWWindowProc() instead
158
159 // type of the handler: it is called with the message parameters (except
160 // that the window object is passed instead of window handle) and should
161 // return true if it handled the message or false if it should be passed to
162 // DefWindowProc()
163 typedef bool (*MSWMessageHandler)(wxWindow *win,
164 WXUINT nMsg,
165 WXWPARAM wParam,
166 WXLPARAM lParam);
167
168 // install a handler, shouldn't be called more than one for the same message
169 static bool MSWRegisterMessageHandler(int msg, MSWMessageHandler handler);
170
171 // unregister a previously registered handler
172 static void MSWUnregisterMessageHandler(int msg, MSWMessageHandler handler);
173
174
175 // implementation from now on
176 // ==========================
177
178 // event handlers
179 // --------------
180
181 void OnPaint(wxPaintEvent& event);
182 void OnEraseBackground(wxEraseEvent& event);
183 #ifdef __WXWINCE__
184 void OnInitDialog(wxInitDialogEvent& event);
185 #endif
186
187 public:
188 // Windows subclassing
189 void SubclassWin(WXHWND hWnd);
190 void UnsubclassWin();
191
192 WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
193 void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
194
195 // return true if the window is of a standard (i.e. not wxWidgets') class
196 //
197 // to understand why does it work, look at SubclassWin() code and comments
198 bool IsOfStandardClass() const { return m_oldWndProc != NULL; }
199
200 wxWindow *FindItem(long id) const;
201 wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = false) const;
202
203 // MSW only: true if this control is part of the main control
204 virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return false; };
205
206 #if wxUSE_TOOLTIPS
207 // MSW only: true if this window or any of its children have a tooltip
208 virtual bool HasToolTips() const { return GetToolTip() != NULL; }
209 #endif // wxUSE_TOOLTIPS
210
211 // translate wxWidgets style flags for this control into the Windows style
212 // and optional extended style for the corresponding native control
213 //
214 // this is the function that should be overridden in the derived classes,
215 // but you will mostly use MSWGetCreateWindowFlags() below
216 virtual WXDWORD MSWGetStyle(long flags, WXDWORD *exstyle = NULL) const ;
217
218 // get the MSW window flags corresponding to wxWidgets ones
219 //
220 // the functions returns the flags (WS_XXX) directly and puts the ext
221 // (WS_EX_XXX) flags into the provided pointer if not NULL
222 WXDWORD MSWGetCreateWindowFlags(WXDWORD *exflags = NULL) const
223 { return MSWGetStyle(GetWindowStyle(), exflags); }
224
225 // update the real underlying window style flags to correspond to the
226 // current wxWindow object style (safe to call even if window isn't fully
227 // created yet)
228 void MSWUpdateStyle(long flagsOld, long exflagsOld);
229
230 // translate wxWidgets coords into Windows ones suitable to be passed to
231 // ::CreateWindow()
232 //
233 // returns true if non default coords are returned, false otherwise
234 bool MSWGetCreateWindowCoords(const wxPoint& pos,
235 const wxSize& size,
236 int& x, int& y,
237 int& w, int& h) const;
238
239 // get the HWND to be used as parent of this window with CreateWindow()
240 virtual WXHWND MSWGetParent() const;
241
242 // creates the window of specified Windows class with given style, extended
243 // style, title and geometry (default values
244 //
245 // returns true if the window has been created, false if creation failed
246 bool MSWCreate(const wxChar *wclass,
247 const wxChar *title = NULL,
248 const wxPoint& pos = wxDefaultPosition,
249 const wxSize& size = wxDefaultSize,
250 WXDWORD style = 0,
251 WXDWORD exendedStyle = 0);
252
253 virtual bool MSWCommand(WXUINT param, WXWORD id);
254
255 #ifndef __WXUNIVERSAL__
256 // Create an appropriate wxWindow from a HWND
257 virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
258
259 // Make sure the window style reflects the HWND style (roughly)
260 virtual void AdoptAttributesFromHWND();
261 #endif // __WXUNIVERSAL__
262
263 // Setup background and foreground colours correctly
264 virtual void SetupColours();
265
266 // ------------------------------------------------------------------------
267 // helpers for message handlers: these perform the same function as the
268 // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
269 // the correct parameters
270 // ------------------------------------------------------------------------
271
272 void UnpackCommand(WXWPARAM wParam, WXLPARAM lParam,
273 WXWORD *id, WXHWND *hwnd, WXWORD *cmd);
274 void UnpackActivate(WXWPARAM wParam, WXLPARAM lParam,
275 WXWORD *state, WXWORD *minimized, WXHWND *hwnd);
276 void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
277 WXWORD *code, WXWORD *pos, WXHWND *hwnd);
278 void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,
279 WXHDC *hdc, WXHWND *hwnd);
280 void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
281 WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
282
283 // ------------------------------------------------------------------------
284 // internal handlers for MSW messages: all handlers return a boolean value:
285 // true means that the handler processed the event and false that it didn't
286 // ------------------------------------------------------------------------
287
288 // there are several cases where we have virtual functions for Windows
289 // message processing: this is because these messages often require to be
290 // processed in a different manner in the derived classes. For all other
291 // messages, however, we do *not* have corresponding MSWOnXXX() function
292 // and if the derived class wants to process them, it should override
293 // MSWWindowProc() directly.
294
295 // scroll event (both horizontal and vertical)
296 virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
297 WXWORD pos, WXHWND control);
298
299 // child control notifications
300 virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
301
302 // owner-drawn controls need to process these messages
303 virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
304 virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
305
306 // the rest are not virtual
307 bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
308 bool HandleInitDialog(WXHWND hWndFocus);
309 bool HandleDestroy();
310
311 bool HandlePaint();
312 bool HandlePrintClient(WXHDC hDC);
313 bool HandleEraseBkgnd(WXHDC hDC);
314
315 bool HandleMinimize();
316 bool HandleMaximize();
317 bool HandleSize(int x, int y, WXUINT flag);
318 bool HandleSizing(wxRect& rect);
319 bool HandleGetMinMaxInfo(void *mmInfo);
320
321 bool HandleShow(bool show, int status);
322 bool HandleActivate(int flag, bool minimized, WXHWND activate);
323
324 bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
325
326 bool HandleCtlColor(WXHBRUSH *hBrush, WXHDC hdc, WXHWND hWnd);
327
328 bool HandlePaletteChanged(WXHWND hWndPalChange);
329 bool HandleQueryNewPalette();
330 bool HandleSysColorChange();
331 bool HandleDisplayChange();
332 bool HandleCaptureChanged(WXHWND gainedCapture);
333 virtual bool HandleSettingChange(WXWPARAM wParam, WXLPARAM lParam);
334
335 bool HandleQueryEndSession(long logOff, bool *mayEnd);
336 bool HandleEndSession(bool endSession, long logOff);
337
338 bool HandleSetFocus(WXHWND wnd);
339 bool HandleKillFocus(WXHWND wnd);
340
341 bool HandleDropFiles(WXWPARAM wParam);
342
343 bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
344 bool HandleMouseMove(int x, int y, WXUINT flags);
345 bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
346
347 bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = false);
348 bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
349 bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
350 #if wxUSE_ACCEL
351 bool HandleHotKey(WXWPARAM wParam, WXLPARAM lParam);
352 #endif
353 #ifdef __WIN32__
354 int HandleMenuChar(int chAccel, WXLPARAM lParam);
355 #endif
356 // Create and process a clipboard event specified by type.
357 bool HandleClipboardEvent( WXUINT nMsg );
358
359 bool HandleQueryDragIcon(WXHICON *hIcon);
360
361 bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
362
363 bool HandlePower(WXWPARAM wParam, WXLPARAM lParam, bool *vetoed);
364
365
366 // Window procedure
367 virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
368
369 // Calls an appropriate default window procedure
370 virtual WXLRESULT MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
371
372 // message processing helpers
373
374 // return false if the message shouldn't be translated/preprocessed but
375 // dispatched normally
376 virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
377
378 // return true if the message was preprocessed and shouldn't be dispatched
379 virtual bool MSWProcessMessage(WXMSG* pMsg);
380
381 // return true if the message was translated and shouldn't be dispatched
382 virtual bool MSWTranslateMessage(WXMSG* pMsg);
383
384 // called when the window is about to be destroyed
385 virtual void MSWDestroyWindow();
386
387
388 // this function should return the brush to paint the children controls
389 // background or 0 if this window doesn't impose any particular background
390 // on its children
391 //
392 // the base class version returns a solid brush if we have a non default
393 // background colour or 0 otherwise
394 virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC hDC, WXHWND hWnd);
395
396 // return the background brush to use for painting the given window by
397 // quering the parent windows via their MSWGetBgBrushForChild() recursively
398 //
399 // hWndToPaint is normally NULL meaning this window itself, but it can also
400 // be a child of this window which is used by the static box and could be
401 // potentially useful for other transparent controls
402 WXHBRUSH MSWGetBgBrush(WXHDC hDC, WXHWND hWndToPaint = NULL);
403
404 // gives the parent the possibility to draw its children background, e.g.
405 // this is used by wxNotebook to do it using DrawThemeBackground()
406 //
407 // return true if background was drawn, false otherwise
408 virtual bool MSWPrintChild(WXHDC WXUNUSED(hDC), wxWindow * WXUNUSED(child))
409 {
410 return false;
411 }
412
413 // some controls (e.g. wxListBox) need to set the return value themselves
414 //
415 // return true to let parent handle it if we don't, false otherwise
416 virtual bool MSWShouldPropagatePrintChild()
417 {
418 return true;
419 }
420
421
422 // Responds to colour changes: passes event on to children.
423 void OnSysColourChanged(wxSysColourChangedEvent& event);
424
425 // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
426 void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
427
428 // check if mouse is in the window
429 bool IsMouseInWindow() const;
430
431 // check if a native double-buffering applies for this window
432 virtual bool IsDoubleBuffered() const;
433
434 // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
435 void GenerateMouseLeave();
436
437 // virtual function for implementing internal idle
438 // behaviour
439 virtual void OnInternalIdle();
440
441 protected:
442
443 #if wxUSE_MENUS_NATIVE
444 virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
445 #endif // wxUSE_MENUS_NATIVE
446
447 // the window handle
448 WXHWND m_hWnd;
449
450 // the old window proc (we subclass all windows)
451 WXFARPROC m_oldWndProc;
452
453 // additional (MSW specific) flags
454 bool m_mouseInWindow:1;
455 bool m_lastKeydownProcessed:1;
456
457 // the size of one page for scrolling
458 int m_xThumbSize;
459 int m_yThumbSize;
460
461 // implement the base class pure virtuals
462 virtual void DoClientToScreen( int *x, int *y ) const;
463 virtual void DoScreenToClient( int *x, int *y ) const;
464 virtual void DoGetPosition( int *x, int *y ) const;
465 virtual void DoGetSize( int *width, int *height ) const;
466 virtual void DoGetClientSize( int *width, int *height ) const;
467 virtual void DoSetSize(int x, int y,
468 int width, int height,
469 int sizeFlags = wxSIZE_AUTO);
470 virtual void DoSetClientSize(int width, int height);
471
472 virtual void DoCaptureMouse();
473 virtual void DoReleaseMouse();
474
475 // this simply moves/resizes the given HWND which is supposed to be our
476 // sibling (this is useful for controls which are composite at MSW level
477 // and for which DoMoveWindow() is not enough)
478 //
479 // returns true if the window move was deferred, false if it was moved
480 // immediately (no error return)
481 bool DoMoveSibling(WXHWND hwnd, int x, int y, int width, int height);
482
483 // move the window to the specified location and resize it: this is called
484 // from both DoSetSize() and DoSetClientSize() and would usually just call
485 // ::MoveWindow() except for composite controls which will want to arrange
486 // themselves inside the given rectangle
487 virtual void DoMoveWindow(int x, int y, int width, int height);
488
489 #if wxUSE_TOOLTIPS
490 virtual void DoSetToolTip( wxToolTip *tip );
491
492 // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
493 // comctl32.dll in our code -- see the function body for more info)
494 bool HandleTooltipNotify(WXUINT code,
495 WXLPARAM lParam,
496 const wxString& ttip);
497 #endif // wxUSE_TOOLTIPS
498
499 // the helper functions used by HandleChar/KeyXXX methods
500 wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
501 WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
502
503
504 // default OnEraseBackground() implementation, return true if we did erase
505 // the background, false otherwise (i.e. the system should erase it)
506 bool DoEraseBackground(WXHDC hDC);
507
508 // generate WM_CHANGEUISTATE if it's needed for the OS we're running under
509 //
510 // action should be one of the UIS_XXX constants
511 // state should be one or more of the UISF_XXX constants
512 // if action == UIS_INITIALIZE then it doesn't seem to matter what we use
513 // for state as the system will decide for us what needs to be set
514 void MSWUpdateUIState(int action, int state = 0);
515
516 private:
517 // common part of all ctors
518 void Init();
519
520 // the (non-virtual) handlers for the events
521 bool HandleMove(int x, int y);
522 bool HandleMoving(wxRect& rect);
523 bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
524 bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
525
526
527 // number of calls to Freeze() minus number of calls to Thaw()
528 unsigned int m_frozenness;
529
530 // current defer window position operation handle (may be NULL)
531 WXHANDLE m_hDWP;
532
533 protected:
534 // When deferred positioning is done these hold the pending changes, and
535 // are used for the default values if another size/pos changes is done on
536 // this window before the group of deferred changes is completed.
537 wxPoint m_pendingPosition;
538 wxSize m_pendingSize;
539
540 private:
541 #ifdef __POCKETPC__
542 bool m_contextMenuEnabled;
543 #endif
544
545 DECLARE_DYNAMIC_CLASS(wxWindowMSW)
546 DECLARE_NO_COPY_CLASS(wxWindowMSW)
547 DECLARE_EVENT_TABLE()
548 };
549
550 // ----------------------------------------------------------------------------
551 // inline functions
552 // ----------------------------------------------------------------------------
553
554 // ---------------------------------------------------------------------------
555 // global functions
556 // ---------------------------------------------------------------------------
557
558 // kbd code translation
559 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
560 WXDLLEXPORT WXWORD wxCharCodeWXToMSW(int id, bool *IsVirtual = NULL);
561
562 // window creation helper class: before creating a new HWND, instantiate an
563 // object of this class on stack - this allows to process the messages sent to
564 // the window even before CreateWindow() returns
565 class wxWindowCreationHook
566 {
567 public:
568 wxWindowCreationHook(wxWindowMSW *winBeingCreated);
569 ~wxWindowCreationHook();
570 };
571
572 // ----------------------------------------------------------------------------
573 // global objects
574 // ----------------------------------------------------------------------------
575
576 // notice that this hash must be defined after wxWindow declaration as it
577 // needs to "see" its dtor and not just forward declaration
578 #include "wx/hash.h"
579
580 // pseudo-template HWND <-> wxWindow hash table
581 WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);
582
583 extern wxWinHashTable *wxWinHandleHash;
584
585 #endif // _WX_WINDOW_H_