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