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 #if WXWIN_COMPATIBILITY_2_4
21 // they're unused by wxWidgets...
29 // ---------------------------------------------------------------------------
30 // wxWindow declaration for MSW
31 // ---------------------------------------------------------------------------
33 class WXDLLEXPORT wxWindowMSW
: public wxWindowBase
35 friend class wxSpinCtrl
;
36 friend class wxSlider
;
37 friend class wxRadioBox
;
38 #if defined __VISUALC__ && __VISUALC__ <= 1200
39 friend class wxWindowMSW
;
42 wxWindowMSW() { Init(); }
44 wxWindowMSW(wxWindow
*parent
,
46 const wxPoint
& pos
= wxDefaultPosition
,
47 const wxSize
& size
= wxDefaultSize
,
49 const wxString
& name
= wxPanelNameStr
)
52 Create(parent
, id
, pos
, size
, style
, name
);
55 virtual ~wxWindowMSW();
57 bool Create(wxWindow
*parent
,
59 const wxPoint
& pos
= wxDefaultPosition
,
60 const wxSize
& size
= wxDefaultSize
,
62 const wxString
& name
= wxPanelNameStr
);
64 // implement base class pure virtuals
65 virtual void SetLabel(const wxString
& label
);
66 virtual wxString
GetLabel() const;
71 virtual bool Show( bool show
= true );
72 virtual bool Enable( bool enable
= true );
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();
84 virtual void Freeze();
87 virtual void SetWindowStyleFlag(long style
);
88 virtual void SetExtraStyle(long exStyle
);
89 virtual bool SetCursor( const wxCursor
&cursor
);
90 virtual bool SetFont( const wxFont
&font
);
92 virtual int GetCharHeight() const;
93 virtual int GetCharWidth() const;
94 virtual void GetTextExtent(const wxString
& string
,
96 int *descent
= (int *) NULL
,
97 int *externalLeading
= (int *) NULL
,
98 const wxFont
*theFont
= (const wxFont
*) NULL
)
101 virtual void SetScrollbar( int orient
, int pos
, int thumbVisible
,
102 int range
, bool refresh
= true );
103 virtual void SetScrollPos( int orient
, int pos
, bool refresh
= true );
104 virtual int GetScrollPos( int orient
) const;
105 virtual int GetScrollThumb( int orient
) const;
106 virtual int GetScrollRange( int orient
) const;
107 virtual void ScrollWindow( int dx
, int dy
,
108 const wxRect
* rect
= (wxRect
*) NULL
);
110 virtual bool ScrollLines(int lines
);
111 virtual bool ScrollPages(int pages
);
113 virtual void SetLayoutDirection(wxLayoutDirection dir
);
114 virtual wxLayoutDirection
GetLayoutDirection() const;
115 virtual wxCoord
AdjustForLayoutDirection(wxCoord x
,
117 wxCoord widthTotal
) const;
119 #if wxUSE_DRAG_AND_DROP
120 virtual void SetDropTarget( wxDropTarget
*dropTarget
);
121 #endif // wxUSE_DRAG_AND_DROP
123 // Accept files for dragging
124 virtual void DragAcceptFiles(bool accept
);
126 #if WXWIN_COMPATIBILITY_2_4
127 wxDEPRECATED( bool GetUseCtl3D() const );
128 wxDEPRECATED( bool GetTransparentBackground() const );
129 wxDEPRECATED( void SetTransparent(bool t
= true) );
130 #endif // WXWIN_COMPATIBILITY_2_4
132 #ifndef __WXUNIVERSAL__
133 // Native resource loading (implemented in src/msw/nativdlg.cpp)
134 // FIXME: should they really be all virtual?
135 virtual bool LoadNativeDialog(wxWindow
* parent
, wxWindowID
& id
);
136 virtual bool LoadNativeDialog(wxWindow
* parent
, const wxString
& name
);
137 wxWindow
* GetWindowChild1(wxWindowID id
);
138 wxWindow
* GetWindowChild(wxWindowID id
);
139 #endif // __WXUNIVERSAL__
142 // install and deinstall a system wide hotkey
143 virtual bool RegisterHotKey(int hotkeyId
, int modifiers
, int keycode
);
144 virtual bool UnregisterHotKey(int hotkeyId
);
145 #endif // wxUSE_HOTKEY
148 bool IsContextMenuEnabled() const { return m_contextMenuEnabled
; }
149 void EnableContextMenu(bool enable
= true) { m_contextMenuEnabled
= enable
; }
152 // window handle stuff
153 // -------------------
155 WXHWND
GetHWND() const { return m_hWnd
; }
156 void SetHWND(WXHWND hWnd
) { m_hWnd
= hWnd
; }
157 virtual WXWidget
GetHandle() const { return GetHWND(); }
159 void AssociateHandle(WXWidget handle
);
160 void DissociateHandle();
162 // does this window have deferred position and/or size?
163 bool IsSizeDeferred() const;
166 // implementation from now on
167 // ==========================
172 void OnPaint(wxPaintEvent
& event
);
173 void OnEraseBackground(wxEraseEvent
& event
);
175 void OnInitDialog(wxInitDialogEvent
& event
);
179 // Windows subclassing
180 void SubclassWin(WXHWND hWnd
);
181 void UnsubclassWin();
183 WXFARPROC
MSWGetOldWndProc() const { return m_oldWndProc
; }
184 void MSWSetOldWndProc(WXFARPROC proc
) { m_oldWndProc
= proc
; }
186 // return true if the window is of a standard (i.e. not wxWidgets') class
188 // to understand why does it work, look at SubclassWin() code and comments
189 bool IsOfStandardClass() const { return m_oldWndProc
!= NULL
; }
191 wxWindow
*FindItem(long id
) const;
192 wxWindow
*FindItemByHWND(WXHWND hWnd
, bool controlOnly
= false) const;
194 // MSW only: true if this control is part of the main control
195 virtual bool ContainsHWND(WXHWND
WXUNUSED(hWnd
)) const { return false; };
198 // MSW only: true if this window or any of its children have a tooltip
199 virtual bool HasToolTips() const { return GetToolTip() != NULL
; }
200 #endif // wxUSE_TOOLTIPS
202 // translate wxWidgets style flags for this control into the Windows style
203 // and optional extended style for the corresponding native control
205 // this is the function that should be overridden in the derived classes,
206 // but you will mostly use MSWGetCreateWindowFlags() below
207 virtual WXDWORD
MSWGetStyle(long flags
, WXDWORD
*exstyle
= NULL
) const ;
209 // get the MSW window flags corresponding to wxWidgets ones
211 // the functions returns the flags (WS_XXX) directly and puts the ext
212 // (WS_EX_XXX) flags into the provided pointer if not NULL
213 WXDWORD
MSWGetCreateWindowFlags(WXDWORD
*exflags
= NULL
) const
214 { return MSWGetStyle(GetWindowStyle(), exflags
); }
216 // update the real underlying window style flags to correspond to the
217 // current wxWindow object style (safe to call even if window isn't fully
219 void MSWUpdateStyle(long flagsOld
, long exflagsOld
);
221 // translate wxWidgets coords into Windows ones suitable to be passed to
224 // returns true if non default coords are returned, false otherwise
225 bool MSWGetCreateWindowCoords(const wxPoint
& pos
,
228 int& w
, int& h
) const;
230 // get the HWND to be used as parent of this window with CreateWindow()
231 virtual WXHWND
MSWGetParent() const;
233 // creates the window of specified Windows class with given style, extended
234 // style, title and geometry (default values
236 // returns true if the window has been created, false if creation failed
237 bool MSWCreate(const wxChar
*wclass
,
238 const wxChar
*title
= NULL
,
239 const wxPoint
& pos
= wxDefaultPosition
,
240 const wxSize
& size
= wxDefaultSize
,
242 WXDWORD exendedStyle
= 0);
244 virtual bool MSWCommand(WXUINT param
, WXWORD id
);
246 #ifndef __WXUNIVERSAL__
247 // Create an appropriate wxWindow from a HWND
248 virtual wxWindow
* CreateWindowFromHWND(wxWindow
* parent
, WXHWND hWnd
);
250 // Make sure the window style reflects the HWND style (roughly)
251 virtual void AdoptAttributesFromHWND();
252 #endif // __WXUNIVERSAL__
254 // Setup background and foreground colours correctly
255 virtual void SetupColours();
257 // ------------------------------------------------------------------------
258 // helpers for message handlers: these perform the same function as the
259 // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
260 // the correct parameters
261 // ------------------------------------------------------------------------
263 void UnpackCommand(WXWPARAM wParam
, WXLPARAM lParam
,
264 WXWORD
*id
, WXHWND
*hwnd
, WXWORD
*cmd
);
265 void UnpackActivate(WXWPARAM wParam
, WXLPARAM lParam
,
266 WXWORD
*state
, WXWORD
*minimized
, WXHWND
*hwnd
);
267 void UnpackScroll(WXWPARAM wParam
, WXLPARAM lParam
,
268 WXWORD
*code
, WXWORD
*pos
, WXHWND
*hwnd
);
269 void UnpackCtlColor(WXWPARAM wParam
, WXLPARAM lParam
,
270 WXHDC
*hdc
, WXHWND
*hwnd
);
271 void UnpackMenuSelect(WXWPARAM wParam
, WXLPARAM lParam
,
272 WXWORD
*item
, WXWORD
*flags
, WXHMENU
*hmenu
);
274 // ------------------------------------------------------------------------
275 // internal handlers for MSW messages: all handlers return a boolean value:
276 // true means that the handler processed the event and false that it didn't
277 // ------------------------------------------------------------------------
279 // there are several cases where we have virtual functions for Windows
280 // message processing: this is because these messages often require to be
281 // processed in a different manner in the derived classes. For all other
282 // messages, however, we do *not* have corresponding MSWOnXXX() function
283 // and if the derived class wants to process them, it should override
284 // MSWWindowProc() directly.
286 // scroll event (both horizontal and vertical)
287 virtual bool MSWOnScroll(int orientation
, WXWORD nSBCode
,
288 WXWORD pos
, WXHWND control
);
290 // child control notifications
291 virtual bool MSWOnNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
293 // owner-drawn controls need to process these messages
294 virtual bool MSWOnDrawItem(int id
, WXDRAWITEMSTRUCT
*item
);
295 virtual bool MSWOnMeasureItem(int id
, WXMEASUREITEMSTRUCT
*item
);
297 // the rest are not virtual
298 bool HandleCreate(WXLPCREATESTRUCT cs
, bool *mayCreate
);
299 bool HandleInitDialog(WXHWND hWndFocus
);
300 bool HandleDestroy();
303 bool HandlePrintClient(WXHDC hDC
);
304 bool HandleEraseBkgnd(WXHDC hDC
);
306 bool HandleMinimize();
307 bool HandleMaximize();
308 bool HandleSize(int x
, int y
, WXUINT flag
);
309 bool HandleSizing(wxRect
& rect
);
310 bool HandleGetMinMaxInfo(void *mmInfo
);
312 bool HandleShow(bool show
, int status
);
313 bool HandleActivate(int flag
, bool minimized
, WXHWND activate
);
315 bool HandleCommand(WXWORD id
, WXWORD cmd
, WXHWND control
);
317 bool HandleCtlColor(WXHBRUSH
*hBrush
, WXHDC hdc
, WXHWND hWnd
);
319 bool HandlePaletteChanged(WXHWND hWndPalChange
);
320 bool HandleQueryNewPalette();
321 bool HandleSysColorChange();
322 bool HandleDisplayChange();
323 bool HandleCaptureChanged(WXHWND gainedCapture
);
324 virtual bool HandleSettingChange(WXWPARAM wParam
, WXLPARAM lParam
);
326 bool HandleQueryEndSession(long logOff
, bool *mayEnd
);
327 bool HandleEndSession(bool endSession
, long logOff
);
329 bool HandleSetFocus(WXHWND wnd
);
330 bool HandleKillFocus(WXHWND wnd
);
332 bool HandleDropFiles(WXWPARAM wParam
);
334 bool HandleMouseEvent(WXUINT msg
, int x
, int y
, WXUINT flags
);
335 bool HandleMouseMove(int x
, int y
, WXUINT flags
);
336 bool HandleMouseWheel(WXWPARAM wParam
, WXLPARAM lParam
);
338 bool HandleChar(WXWPARAM wParam
, WXLPARAM lParam
, bool isASCII
= false);
339 bool HandleKeyDown(WXWPARAM wParam
, WXLPARAM lParam
);
340 bool HandleKeyUp(WXWPARAM wParam
, WXLPARAM lParam
);
342 bool HandleHotKey(WXWPARAM wParam
, WXLPARAM lParam
);
345 int HandleMenuChar(int chAccel
, WXLPARAM lParam
);
347 // Create and process a clipboard event specified by type.
348 bool HandleClipboardEvent( WXUINT nMsg
);
350 bool HandleQueryDragIcon(WXHICON
*hIcon
);
352 bool HandleSetCursor(WXHWND hWnd
, short nHitTest
, int mouseMsg
);
354 bool HandlePower(WXWPARAM wParam
, WXLPARAM lParam
, bool *vetoed
);
358 virtual WXLRESULT
MSWWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
360 // Calls an appropriate default window procedure
361 virtual WXLRESULT
MSWDefWindowProc(WXUINT nMsg
, WXWPARAM wParam
, WXLPARAM lParam
);
363 // message processing helpers
365 // return false if the message shouldn't be translated/preprocessed but
366 // dispatched normally
367 virtual bool MSWShouldPreProcessMessage(WXMSG
* pMsg
);
369 // return true if the message was preprocessed and shouldn't be dispatched
370 virtual bool MSWProcessMessage(WXMSG
* pMsg
);
372 // return true if the message was translated and shouldn't be dispatched
373 virtual bool MSWTranslateMessage(WXMSG
* pMsg
);
375 // called when the window is about to be destroyed
376 virtual void MSWDestroyWindow();
379 // this function should return the brush to paint the children controls
380 // background or 0 if this window doesn't impose any particular background
383 // the base class version returns a solid brush if we have a non default
384 // background colour or 0 otherwise
385 virtual WXHBRUSH
MSWGetBgBrushForChild(WXHDC hDC
, WXHWND hWnd
);
387 // return the background brush to use for painting the given window by
388 // quering the parent windows via their MSWGetBgBrushForChild() recursively
390 // hWndToPaint is normally NULL meaning this window itself, but it can also
391 // be a child of this window which is used by the static box and could be
392 // potentially useful for other transparent controls
393 WXHBRUSH
MSWGetBgBrush(WXHDC hDC
, WXHWND hWndToPaint
= NULL
);
395 // gives the parent the possibility to draw its children background, e.g.
396 // this is used by wxNotebook to do it using DrawThemeBackground()
398 // return true if background was drawn, false otherwise
399 virtual bool MSWPrintChild(WXHDC
WXUNUSED(hDC
), wxWindow
* WXUNUSED(child
))
404 // some controls (e.g. wxListBox) need to set the return value themselves
406 // return true to let parent handle it if we don't, false otherwise
407 virtual bool MSWShouldPropagatePrintChild()
413 // Responds to colour changes: passes event on to children.
414 void OnSysColourChanged(wxSysColourChangedEvent
& event
);
416 // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
417 void InitMouseEvent(wxMouseEvent
& event
, int x
, int y
, WXUINT flags
);
419 // check if mouse is in the window
420 bool IsMouseInWindow() const;
422 // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
423 void GenerateMouseLeave();
425 // virtual function for implementing internal idle
427 virtual void OnInternalIdle();
431 #if wxUSE_MENUS_NATIVE
432 virtual bool DoPopupMenu( wxMenu
*menu
, int x
, int y
);
433 #endif // wxUSE_MENUS_NATIVE
438 // the old window proc (we subclass all windows)
439 WXFARPROC m_oldWndProc
;
441 // additional (MSW specific) flags
442 bool m_mouseInWindow
:1;
443 bool m_lastKeydownProcessed
:1;
445 // the size of one page for scrolling
449 // implement the base class pure virtuals
450 virtual void DoClientToScreen( int *x
, int *y
) const;
451 virtual void DoScreenToClient( int *x
, int *y
) const;
452 virtual void DoGetPosition( int *x
, int *y
) const;
453 virtual void DoGetSize( int *width
, int *height
) const;
454 virtual void DoGetClientSize( int *width
, int *height
) const;
455 virtual void DoSetSize(int x
, int y
,
456 int width
, int height
,
457 int sizeFlags
= wxSIZE_AUTO
);
458 virtual void DoSetClientSize(int width
, int height
);
460 virtual void DoCaptureMouse();
461 virtual void DoReleaseMouse();
463 // has the window been frozen by Freeze()?
464 bool IsFrozen() const { return m_frozenness
> 0; }
466 // this simply moves/resizes the given HWND which is supposed to be our
467 // sibling (this is useful for controls which are composite at MSW level
468 // and for which DoMoveWindow() is not enough)
470 // returns true if the window move was deferred, false if it was moved
471 // immediately (no error return)
472 bool DoMoveSibling(WXHWND hwnd
, int x
, int y
, int width
, int height
);
474 // move the window to the specified location and resize it: this is called
475 // from both DoSetSize() and DoSetClientSize() and would usually just call
476 // ::MoveWindow() except for composite controls which will want to arrange
477 // themselves inside the given rectangle
478 virtual void DoMoveWindow(int x
, int y
, int width
, int height
);
481 virtual void DoSetToolTip( wxToolTip
*tip
);
483 // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
484 // comctl32.dll in our code -- see the function body for more info)
485 bool HandleTooltipNotify(WXUINT code
,
487 const wxString
& ttip
);
488 #endif // wxUSE_TOOLTIPS
490 // the helper functions used by HandleChar/KeyXXX methods
491 wxKeyEvent
CreateKeyEvent(wxEventType evType
, int id
,
492 WXLPARAM lParam
= 0, WXWPARAM wParam
= 0) const;
495 // default OnEraseBackground() implementation, return true if we did erase
496 // the background, false otherwise (i.e. the system should erase it)
497 bool DoEraseBackground(WXHDC hDC
);
499 // generate WM_CHANGEUISTATE if it's needed for the OS we're running under
501 // action should be one of the UIS_XXX constants
502 // state should be one or more of the UISF_XXX constants
503 // if action == UIS_INITIALIZE then it doesn't seem to matter what we use
504 // for state as the system will decide for us what needs to be set
505 void MSWUpdateUIState(int action
, int state
= 0);
508 // common part of all ctors
511 // the (non-virtual) handlers for the events
512 bool HandleMove(int x
, int y
);
513 bool HandleMoving(wxRect
& rect
);
514 bool HandleJoystickEvent(WXUINT msg
, int x
, int y
, WXUINT flags
);
515 bool HandleNotify(int idCtrl
, WXLPARAM lParam
, WXLPARAM
*result
);
517 // list of disabled children before last call to our Disable()
518 wxWindowList
*m_childrenDisabled
;
520 // number of calls to Freeze() minus number of calls to Thaw()
521 unsigned int m_frozenness
;
523 // current defer window position operation handle (may be NULL)
527 // When deferred positioning is done these hold the pending changes, and
528 // are used for the default values if another size/pos changes is done on
529 // this window before the group of deferred changes is completed.
530 wxPoint m_pendingPosition
;
531 wxSize m_pendingSize
;
535 bool m_contextMenuEnabled
;
538 DECLARE_DYNAMIC_CLASS(wxWindowMSW
)
539 DECLARE_NO_COPY_CLASS(wxWindowMSW
)
540 DECLARE_EVENT_TABLE()
543 // ----------------------------------------------------------------------------
545 // ----------------------------------------------------------------------------
547 #if WXWIN_COMPATIBILITY_2_4
549 inline bool wxWindowMSW::GetUseCtl3D() const { return false; }
550 inline bool wxWindowMSW::GetTransparentBackground() const { return false; }
551 inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t
)) { }
553 #endif // WXWIN_COMPATIBILITY_2_4
555 // ---------------------------------------------------------------------------
557 // ---------------------------------------------------------------------------
559 // kbd code translation
560 WXDLLEXPORT
int wxCharCodeMSWToWX(int keySym
, WXLPARAM lParam
= 0);
561 WXDLLEXPORT WXWORD
wxCharCodeWXToMSW(int id
, bool *IsVirtual
= NULL
);
563 // window creation helper class: before creating a new HWND, instantiate an
564 // object of this class on stack - this allows to process the messages sent to
565 // the window even before CreateWindow() returns
566 class wxWindowCreationHook
569 wxWindowCreationHook(wxWindowMSW
*winBeingCreated
);
570 ~wxWindowCreationHook();
573 // ----------------------------------------------------------------------------
575 // ----------------------------------------------------------------------------
577 // notice that this hash must be defined after wxWindow declaration as it
578 // needs to "see" its dtor and not just forward declaration
581 // pseudo-template HWND <-> wxWindow hash table
582 #if WXWIN_COMPATIBILITY_2_4
583 WX_DECLARE_HASH(wxWindow
, wxWindowList
, wxWinHashTable
);
585 WX_DECLARE_HASH(wxWindowMSW
, wxWindowList
, wxWinHashTable
);
588 extern wxWinHashTable
*wxWinHandleHash
;
590 #endif // _WX_WINDOW_H_