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     // this function should return the brush to paint the window background
 362     // with or 0 for the default brush
 363     virtual WXHBRUSH MSWControlColor(WXHDC hDC);
 364
 365     // this function should return the brush to paint the children controls
 366     // background or 0 if this window doesn't impose any particular background
 367     // on its children
 368     //
 369     // the base class version uses MSWGetBgColourForChild() and returns a solid
 370     // brush if we have a non default background colour or 0 otherwise
 371     virtual WXHBRUSH MSWGetBgBrushForChild(WXHDC WXUNUSED(hDC), wxWindow *child)
 372     {
 373         return MSWGetSolidBgBrushForChild(child);
 374     }
 375
 376     // return the background colour of this window under the given child
 377     // (possible grand child)
 378     //
 379     // this is a hack as if the background is themed, there is no single colour
 380     // representing it, but sometimes we can't use the pattern brush returned
 381     // by MSWGetBgBrushForChild() anyhow and then this function is used as
 382     // fallback
 383     //
 384     // the base class version returns bg colour if it had been explicitely set
 385     // or wxNullColour otherwise
 386     virtual wxColour MSWGetBgColourForChild(wxWindow *child);
 387
 388     // convenience function: returns a solid brush of the colour returned by
 389     // MSWGetBgColourForChild() or 0
 390     WXHBRUSH MSWGetSolidBgBrushForChild(wxWindow *child);
 391
 392     // normally just calls MSWGetBgBrushForChild() on the parent window but may
 393     // be overridden if the default background brush is not suitable for some
 394     // reason (e.g. wxStaticBox uses MSWGetSolidBgBrushForChild() instead)
 395     virtual WXHBRUSH MSWGetBgBrushForSelf(wxWindow *parent, WXHDC hDC);
 396
 397     // return the background brush to use for this window by quering the parent
 398     // windows via their MSWGetBgBrushForChild() recursively
 399     WXHBRUSH MSWGetBgBrush(WXHDC hDC);
 400
 401     // overriding this method gives the parent window the opportunity to
 402     // process WM_PRINTCLIENT for its children: this is currently used by
 403     // wxNotebook to draw themed background for them
 404     //
 405     // return true if the message was processed or false to use default logic
 406     // for it (currently this means handling it just as WM_PAINT i.e. render
 407     // the control into the provided DC)
 408     virtual bool MSWPrintChild(wxWindow *win, WXWPARAM wParam, WXLPARAM lParam);
 409
 410
 411     // Responds to colour changes: passes event on to children.
 412     void OnSysColourChanged(wxSysColourChangedEvent& event);
 413
 414     // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
 415     void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
 416
 417     // check if mouse is in the window
 418     bool IsMouseInWindow() const;
 419
 420     // synthesize a wxEVT_LEAVE_WINDOW event and set m_mouseInWindow to false
 421     void GenerateMouseLeave();
 422
 423     // virtual function for implementing internal idle
 424     // behaviour
 425     virtual void OnInternalIdle() ;
 426
 427 protected:
 428     // the window handle
 429     WXHWND                m_hWnd;
 430
 431     // the old window proc (we subclass all windows)
 432     WXFARPROC             m_oldWndProc;
 433
 434     // additional (MSW specific) flags
 435     bool                  m_mouseInWindow:1;
 436     bool                  m_lastKeydownProcessed:1;
 437
 438     // the size of one page for scrolling
 439     int                   m_xThumbSize;
 440     int                   m_yThumbSize;
 441
 442 #if wxUSE_MOUSEEVENT_HACK
 443     // the coordinates of the last mouse event and the type of it
 444     long                  m_lastMouseX,
 445                           m_lastMouseY;
 446     int                   m_lastMouseEvent;
 447 #endif // wxUSE_MOUSEEVENT_HACK
 448
 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);
 459
 460     virtual void DoCaptureMouse();
 461     virtual void DoReleaseMouse();
 462
 463     // has the window been frozen by Freeze()?
 464     bool IsFrozen() const { return m_frozenness > 0; }
 465
 466     // move the window to the specified location and resize it: this is called
 467     // from both DoSetSize() and DoSetClientSize() and would usually just call
 468     // ::MoveWindow() except for composite controls which will want to arrange
 469     // themselves inside the given rectangle
 470     virtual void DoMoveWindow(int x, int y, int width, int height);
 471
 472 #if wxUSE_TOOLTIPS
 473     virtual void DoSetToolTip( wxToolTip *tip );
 474
 475     // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
 476     // comctl32.dll in our code -- see the function body for more info)
 477     bool HandleTooltipNotify(WXUINT code,
 478                              WXLPARAM lParam,
 479                              const wxString& ttip);
 480 #endif // wxUSE_TOOLTIPS
 481
 482     // the helper functions used by HandleChar/KeyXXX methods
 483     wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
 484                               WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
 485
 486
 487     // default OnEraseBackground() implementation, return true if we did erase
 488     // the background, false otherwise
 489     bool DoEraseBackground(wxDC& dc);
 490
 491 private:
 492     // common part of all ctors
 493     void Init();
 494
 495     // the (non-virtual) handlers for the events
 496     bool HandleMove(int x, int y);
 497     bool HandleMoving(wxRect& rect);
 498     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
 499
 500 #ifdef __WIN95__
 501     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 502 #endif // __WIN95__
 503
 504     // list of disabled children before last call to our Disable()
 505     wxWindowList *m_childrenDisabled;
 506
 507     // number of calls to Freeze() minus number of calls to Thaw()
 508     unsigned int m_frozenness;
 509
 510     // current defer window position operation handle (may be NULL)
 511     WXHANDLE m_hDWP;
 512
 513
 514     DECLARE_DYNAMIC_CLASS(wxWindowMSW)
 515     DECLARE_NO_COPY_CLASS(wxWindowMSW)
 516     DECLARE_EVENT_TABLE()
 517 };
 518
 519 // ----------------------------------------------------------------------------
 520 // inline functions
 521 // ----------------------------------------------------------------------------
 522
 523 #if WXWIN_COMPATIBILITY_2_4
 524
 525 inline bool wxWindowMSW::GetUseCtl3D() const { return false; }
 526 inline bool wxWindowMSW::GetTransparentBackground() const { return false; }
 527 inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
 528
 529 #endif // WXWIN_COMPATIBILITY_2_4
 530
 531 // ---------------------------------------------------------------------------
 532 // global functions
 533 // ---------------------------------------------------------------------------
 534
 535 // kbd code translation
 536 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym, WXLPARAM lParam = 0);
 537 WXDLLEXPORT WXWORD wxCharCodeWXToMSW(int id, bool *IsVirtual);
 538
 539 // window creation helper class: before creating a new HWND, instantiate an
 540 // object of this class on stack - this allows to process the messages sent to
 541 // the window even before CreateWindow() returns
 542 class wxWindowCreationHook
 543 {
 544 public:
 545     wxWindowCreationHook(wxWindowMSW *winBeingCreated);
 546     ~wxWindowCreationHook();
 547 };
 548
 549 // ----------------------------------------------------------------------------
 550 // global objects
 551 // ----------------------------------------------------------------------------
 552
 553 // notice that this hash must be defined after wxWindow declaration as it
 554 // needs to "see" its dtor and not just forward declaration
 555 #include "wx/hash.h"
 556
 557 // pseudo-template HWND <-> wxWindow hash table
 558 #if WXWIN_COMPATIBILITY_2_4
 559 WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
 560 #else
 561 WX_DECLARE_HASH(wxWindowMSW, wxWindowList, wxWinHashTable);
 562 #endif
 563
 564 extern wxWinHashTable *wxWinHandleHash;
 565
 566 #endif
 567     // _WX_WINDOW_H_