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