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