include/wx/msw/window.h

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