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(), ...
9 // Copyright: (c) Julian Smart
10 // Licence: wxWindows licence
11 /////////////////////////////////////////////////////////////////////////////
16 // ---------------------------------------------------------------------------
18 // ---------------------------------------------------------------------------
20 // ---------------------------------------------------------------------------
21 // wxWindow declaration for MSW
22 // ---------------------------------------------------------------------------
24 class WXDLLEXPORT wxWindowMSW
: public wxWindowBase
26 friend class wxSpinCtrl
;
27 friend class wxSlider
;
28 friend class wxRadioBox
;
29 #if defined __VISUALC__ && __VISUALC__ <= 1200
30 friend class wxWindowMSW
;
33 wxWindowMSW() { Init(); }
35 wxWindowMSW(wxWindow
*parent
,
37 const wxPoint
& pos
= wxDefaultPosition
,
38 const wxSize
& size
= wxDefaultSize
,
40 const wxString
& name
= wxPanelNameStr
)
43 Create(parent
, id
, pos
, size
, style
, name
);
46 virtual ~wxWindowMSW();
48 bool Create(wxWindow
*parent
,
50 const wxPoint
& pos
= wxDefaultPosition
,
51 const wxSize
& size
= wxDefaultSize
,
53 const wxString
& name
= wxPanelNameStr
);
55 // implement base class pure virtuals
56 virtual void SetLabel(const wxString
& label
);
57 virtual wxString
GetLabel() const;
62 virtual bool Show( bool show
= true );
63 virtual void DoEnable( bool enable
);
65 virtual void SetFocus();
66 virtual void SetFocusFromKbd();
68 virtual bool Reparent(wxWindowBase
*newParent
);
70 virtual void WarpPointer(int x
, int y
);
72 virtual void Refresh( bool eraseBackground
= true,
73 const wxRect
*rect
= (const wxRect
*) NULL
);
74 virtual void Update();
75 virtual void Freeze();
77 virtual bool IsFrozen() const { return m_frozenness
> 0; }
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
);
84 virtual int GetCharHeight() const;
85 virtual int GetCharWidth() const;
86 virtual void GetTextExtent(const wxString
& string
,
88 int *descent
= (int *) NULL
,
89 int *externalLeading
= (int *) NULL
,
90 const wxFont
*theFont
= (const wxFont
*) NULL
)
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
);
102 virtual bool ScrollLines(int lines
);
103 virtual bool ScrollPages(int pages
);
105 virtual void SetLayoutDirection(wxLayoutDirection dir
);
106 virtual wxLayoutDirection
GetLayoutDirection() const;
107 virtual wxCoord
AdjustForLayoutDirection(wxCoord x
,
109 wxCoord widthTotal
) const;
111 #if wxUSE_DRAG_AND_DROP
112 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
113 #endif // wxUSE_DRAG_AND_DROP
115 // Accept files for dragging
116 virtual void DragAcceptFiles(bool accept
);
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__
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
134 bool IsContextMenuEnabled() const { return m_contextMenuEnabled
; }
135 void EnableContextMenu(bool enable
= true) { m_contextMenuEnabled
= enable
; }
138 // window handle stuff
139 // -------------------
141 WXHWND
GetHWND() const { return m_hWnd
; }
142 void SetHWND(WXHWND hWnd
) { m_hWnd
= hWnd
; }
143 virtual WXWidget
GetHandle() const { return GetHWND(); }
145 void AssociateHandle(WXWidget handle
);
146 void DissociateHandle();
148 // does this window have deferred position and/or size?
149 bool IsSizeDeferred() const;
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)
156 // notice that if you want to process a message for a given window only you
157 // should override its MSWWindowProc() instead
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
163 typedef bool (*MSWMessageHandler
)(wxWindowMSW
*win
,
168 // install a handler, shouldn't be called more than one for the same message
169 static bool MSWRegisterMessageHandler(int msg
, MSWMessageHandler handler
);
171 // unregister a previously registered handler
172 static void MSWUnregisterMessageHandler(int msg
, MSWMessageHandler handler
);
175 // implementation from now on
176 // ==========================
181 void OnPaint(wxPaintEvent
& event
);
182 void OnEraseBackground(wxEraseEvent
& event
);
184 void OnInitDialog(wxInitDialogEvent
& event
);
188 // Windows subclassing
189 void SubclassWin(WXHWND hWnd
);
190 void UnsubclassWin();
192 WXFARPROC
MSWGetOldWndProc() const { return m_oldWndProc
; }
193 void MSWSetOldWndProc(WXFARPROC proc
) { m_oldWndProc
= proc
; }
195 // return true if the window is of a standard (i.e. not wxWidgets') class
197 // to understand why does it work, look at SubclassWin() code and comments
198 bool IsOfStandardClass() const { return m_oldWndProc
!= NULL
; }
200 wxWindow
*FindItem(long id
) const;
201 wxWindow
*FindItemByHWND(WXHWND hWnd
, bool controlOnly
= false) const;
203 // MSW only: true if this control is part of the main control
204 virtual bool ContainsHWND(WXHWND
WXUNUSED(hWnd
)) const { return false; }
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
211 // translate wxWidgets style flags for this control into the Windows style
212 // and optional extended style for the corresponding native control
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 ;
218 // get the MSW window flags corresponding to wxWidgets ones
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
); }
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
228 void MSWUpdateStyle(long flagsOld
, long exflagsOld
);
230 // translate wxWidgets coords into Windows ones suitable to be passed to
233 // returns true if non default coords are returned, false otherwise
234 bool MSWGetCreateWindowCoords(const wxPoint
& pos
,
237 int& w
, int& h
) const;
239 // get the HWND to be used as parent of this window with CreateWindow()
240 virtual WXHWND
MSWGetParent() const;
242 // creates the window of specified Windows class with given style, extended
243 // style, title and geometry (default values
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
,
251 WXDWORD exendedStyle
= 0);
253 virtual bool MSWCommand(WXUINT param
, WXWORD id
);
255 #ifndef __WXUNIVERSAL__
256 // Create an appropriate wxWindow from a HWND
257 virtual wxWindow
* CreateWindowFromHWND(wxWindow
* parent
, WXHWND hWnd
);
259 // Make sure the window style reflects the HWND style (roughly)
260 virtual void AdoptAttributesFromHWND();
261 #endif // __WXUNIVERSAL__
263 // Setup background and foreground colours correctly
264 virtual void SetupColours();
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 // ------------------------------------------------------------------------
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
);
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 // ------------------------------------------------------------------------
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.
295 // scroll event (both horizontal and vertical)
296 virtual bool MSWOnScroll(int orientation
, WXWORD nSBCode
,
297 WXWORD pos
, WXHWND control
);
299 // child control notifications
300 virtual bool MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
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
);
306 // the rest are not virtual
307 bool HandleCreate(WXLPCREATESTRUCT cs
, bool *mayCreate
);
308 bool HandleInitDialog(WXHWND hWndFocus
);
309 bool HandleDestroy();
312 bool HandlePrintClient(WXHDC hDC
);
313 bool HandleEraseBkgnd(WXHDC hDC
);
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 bool HandleEnterSizeMove();
321 bool HandleExitSizeMove();
323 bool HandleShow(bool show
, int status
);
324 bool HandleActivate(int flag
, bool minimized
, WXHWND activate
);
326 bool HandleCommand(WXWORD id
, WXWORD cmd
, WXHWND control
);
328 bool HandleCtlColor(WXHBRUSH
*hBrush
, WXHDC hdc
, WXHWND hWnd
);
330 bool HandlePaletteChanged(WXHWND hWndPalChange
);
331 bool HandleQueryNewPalette();
332 bool HandleSysColorChange();
333 bool HandleDisplayChange();
334 bool HandleCaptureChanged(WXHWND gainedCapture
);
335 virtual bool HandleSettingChange(WXWPARAM wParam
, WXLPARAM lParam
);
337 bool HandleQueryEndSession(long logOff
, bool *mayEnd
);
338 bool HandleEndSession(bool endSession
, long logOff
);
340 bool HandleSetFocus(WXHWND wnd
);
341 bool HandleKillFocus(WXHWND wnd
);
343 bool HandleDropFiles(WXWPARAM wParam
);
345 bool HandleMouseEvent(WXUINT msg
, int x
, int y
, WXUINT flags
);
346 bool HandleMouseMove(int x
, int y
, WXUINT flags
);
347 bool HandleMouseWheel(WXWPARAM wParam
, WXLPARAM lParam
);
349 bool HandleChar(WXWPARAM wParam
, WXLPARAM lParam
, bool isASCII
= false);
350 bool HandleKeyDown(WXWPARAM wParam
, WXLPARAM lParam
);
351 bool HandleKeyUp(WXWPARAM wParam
, WXLPARAM lParam
);
353 bool HandleHotKey(WXWPARAM wParam
, WXLPARAM lParam
);
356 int HandleMenuChar(int chAccel
, WXLPARAM lParam
);
358 // Create and process a clipboard event specified by type.
359 bool HandleClipboardEvent( WXUINT nMsg
);
361 bool HandleQueryDragIcon(WXHICON
*hIcon
);
363 bool HandleSetCursor(WXHWND hWnd
, short nHitTest
, int mouseMsg
);
365 bool HandlePower(WXWPARAM wParam
, WXLPARAM lParam
, bool *vetoed
);
369 virtual WXLRESULT
MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
371 // Calls an appropriate default window procedure
372 virtual WXLRESULT
MSWDefWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
374 // message processing helpers
376 // return false if the message shouldn't be translated/preprocessed but
377 // dispatched normally
378 virtual bool MSWShouldPreProcessMessage(WXMSG
* pMsg
);
380 // return true if the message was preprocessed and shouldn't be dispatched
381 virtual bool MSWProcessMessage(WXMSG
* pMsg
);
383 // return true if the message was translated and shouldn't be dispatched
384 virtual bool MSWTranslateMessage(WXMSG
* pMsg
);
386 // called when the window is about to be destroyed
387 virtual void MSWDestroyWindow();
390 // this function should return the brush to paint the children controls
391 // background or 0 if this window doesn't impose any particular background
394 // the base class version returns a solid brush if we have a non default
395 // background colour or 0 otherwise
396 virtual WXHBRUSH
MSWGetBgBrushForChild(WXHDC hDC
, WXHWND hWnd
);
398 // return the background brush to use for painting the given window by
399 // quering the parent windows via their MSWGetBgBrushForChild() recursively
401 // hWndToPaint is normally NULL meaning this window itself, but it can also
402 // be a child of this window which is used by the static box and could be
403 // potentially useful for other transparent controls
404 WXHBRUSH
MSWGetBgBrush(WXHDC hDC
, WXHWND hWndToPaint
= NULL
);
406 // gives the parent the possibility to draw its children background, e.g.
407 // this is used by wxNotebook to do it using DrawThemeBackground()
409 // return true if background was drawn, false otherwise
410 virtual bool MSWPrintChild(WXHDC
WXUNUSED(hDC
), wxWindow
* WXUNUSED(child
))
415 // some controls (e.g. wxListBox) need to set the return value themselves
417 // return true to let parent handle it if we don't, false otherwise
418 virtual bool MSWShouldPropagatePrintChild()
424 // Responds to colour changes: passes event on to children.
425 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
427 // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
428 void InitMouseEvent(wxMouseEvent
& event
, int x
, int y
, WXUINT flags
);
430 // check if mouse is in the window
431 bool IsMouseInWindow() const;
433 // check if a native double-buffering applies for this window
434 virtual bool IsDoubleBuffered() const;
436 // this allows you to implement standard control borders without
437 // repeating the code in different classes that are not derived from
439 virtual wxBorder
GetDefaultBorderForControl() const;
441 // choose the default border for this window
442 virtual wxBorder
GetDefaultBorder() const;
444 // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
445 void GenerateMouseLeave();
447 // virtual function for implementing internal idle
449 virtual void OnInternalIdle();
453 #if wxUSE_MENUS_NATIVE
454 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
455 #endif // wxUSE_MENUS_NATIVE
460 // the old window proc (we subclass all windows)
461 WXFARPROC m_oldWndProc
;
463 // additional (MSW specific) flags
464 bool m_mouseInWindow
:1;
465 bool m_lastKeydownProcessed
:1;
467 // the size of one page for scrolling
471 // implement the base class pure virtuals
472 virtual void DoClientToScreen( int *x
, int *y
) const;
473 virtual void DoScreenToClient( int *x
, int *y
) const;
474 virtual void DoGetPosition( int *x
, int *y
) const;
475 virtual void DoGetSize( int *width
, int *height
) const;
476 virtual void DoGetClientSize( int *width
, int *height
) const;
477 virtual void DoSetSize(int x
, int y
,
478 int width
, int height
,
479 int sizeFlags
= wxSIZE_AUTO
);
480 virtual void DoSetClientSize(int width
, int height
);
482 virtual void DoCaptureMouse();
483 virtual void DoReleaseMouse();
485 // this simply moves/resizes the given HWND which is supposed to be our
486 // sibling (this is useful for controls which are composite at MSW level
487 // and for which DoMoveWindow() is not enough)
489 // returns true if the window move was deferred, false if it was moved
490 // immediately (no error return)
491 bool DoMoveSibling(WXHWND hwnd
, int x
, int y
, int width
, int height
);
493 // move the window to the specified location and resize it: this is called
494 // from both DoSetSize() and DoSetClientSize() and would usually just call
495 // ::MoveWindow() except for composite controls which will want to arrange
496 // themselves inside the given rectangle
497 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
500 virtual void DoSetToolTip( wxToolTip
*tip
);
502 // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
503 // comctl32.dll in our code -- see the function body for more info)
504 bool HandleTooltipNotify(WXUINT code
,
506 const wxString
& ttip
);
507 #endif // wxUSE_TOOLTIPS
509 // the helper functions used by HandleChar/KeyXXX methods
510 wxKeyEvent
CreateKeyEvent(wxEventType evType
, int id
,
511 WXLPARAM lParam
= 0, WXWPARAM wParam
= 0) const;
514 // default OnEraseBackground() implementation, return true if we did erase
515 // the background, false otherwise (i.e. the system should erase it)
516 bool DoEraseBackground(WXHDC hDC
);
518 // generate WM_CHANGEUISTATE if it's needed for the OS we're running under
520 // action should be one of the UIS_XXX constants
521 // state should be one or more of the UISF_XXX constants
522 // if action == UIS_INITIALIZE then it doesn't seem to matter what we use
523 // for state as the system will decide for us what needs to be set
524 void MSWUpdateUIState(int action
, int state
= 0);
527 // common part of all ctors
530 // the (non-virtual) handlers for the events
531 bool HandleMove(int x
, int y
);
532 bool HandleMoving(wxRect
& rect
);
533 bool HandleJoystickEvent(WXUINT msg
, int x
, int y
, WXUINT flags
);
534 bool HandleNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
537 // number of calls to Freeze() minus number of calls to Thaw()
538 unsigned int m_frozenness
;
540 // current defer window position operation handle (may be NULL)
544 // When deferred positioning is done these hold the pending changes, and
545 // are used for the default values if another size/pos changes is done on
546 // this window before the group of deferred changes is completed.
547 wxPoint m_pendingPosition
;
548 wxSize m_pendingSize
;
552 bool m_contextMenuEnabled
;
555 DECLARE_DYNAMIC_CLASS(wxWindowMSW
)
556 DECLARE_NO_COPY_CLASS(wxWindowMSW
)
557 DECLARE_EVENT_TABLE()
560 // ----------------------------------------------------------------------------
562 // ----------------------------------------------------------------------------
564 // ---------------------------------------------------------------------------
566 // ---------------------------------------------------------------------------
568 // kbd code translation
569 WXDLLEXPORT
int wxCharCodeMSWToWX(int keySym
, WXLPARAM lParam
= 0);
570 WXDLLEXPORT WXWORD
wxCharCodeWXToMSW(int id
, bool *IsVirtual
= NULL
);
572 // window creation helper class: before creating a new HWND, instantiate an
573 // object of this class on stack - this allows to process the messages sent to
574 // the window even before CreateWindow() returns
575 class wxWindowCreationHook
578 wxWindowCreationHook(wxWindowMSW
*winBeingCreated
);
579 ~wxWindowCreationHook();
582 // ----------------------------------------------------------------------------
584 // ----------------------------------------------------------------------------
586 // notice that this hash must be defined after wxWindow declaration as it
587 // needs to "see" its dtor and not just forward declaration
590 // pseudo-template HWND <-> wxWindow hash table
591 WX_DECLARE_HASH(wxWindowMSW
, wxWindowList
, wxWinHashTable
);
593 extern wxWinHashTable
*wxWinHandleHash
;
595 #endif // _WX_WINDOW_H_