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 #include "wx/hash.h"
  32
  33 // pseudo-template HWND <-> wxWindow hash table
  34 WX_DECLARE_HASH(wxWindow, wxWindowList, wxWinHashTable);
  35
  36 extern wxWinHashTable *wxWinHandleHash;
  37
  38 // ---------------------------------------------------------------------------
  39 // constants
  40 // ---------------------------------------------------------------------------
  41
  42 // FIXME does anybody use those? they're unused by wxWindows...
  43 enum
  44 {
  45     wxKEY_SHIFT = 1,
  46     wxKEY_CTRL  = 2
  47 };
  48
  49 // ---------------------------------------------------------------------------
  50 // wxWindow declaration for MSW
  51 // ---------------------------------------------------------------------------
  52
  53 class WXDLLEXPORT wxWindowMSW : public wxWindowBase
  54 {
  55 public:
  56     wxWindowMSW();
  57
  58     wxWindowMSW(wxWindow *parent,
  59                 wxWindowID id,
  60                 const wxPoint& pos = wxDefaultPosition,
  61                 const wxSize& size = wxDefaultSize,
  62                 long style = 0,
  63                 const wxString& name = wxPanelNameStr);
  64
  65     virtual ~wxWindowMSW();
  66
  67     bool Create(wxWindow *parent,
  68                 wxWindowID id,
  69                 const wxPoint& pos = wxDefaultPosition,
  70                 const wxSize& size = wxDefaultSize,
  71                 long style = 0,
  72                 const wxString& name = wxPanelNameStr);
  73
  74     // implement base class pure virtuals
  75     virtual void SetTitle( const wxString& title);
  76     virtual wxString GetTitle() const;
  77
  78     virtual void Raise();
  79     virtual void Lower();
  80
  81     virtual bool Show( bool show = TRUE );
  82     virtual bool Enable( bool enable = TRUE );
  83
  84     virtual void SetFocus();
  85     virtual void SetFocusFromKbd();
  86
  87     virtual bool Reparent(wxWindowBase *newParent);
  88
  89     virtual void WarpPointer(int x, int y);
  90
  91     virtual void Refresh( bool eraseBackground = TRUE,
  92                           const wxRect *rect = (const wxRect *) NULL );
  93     virtual void Update();
  94     virtual void Freeze();
  95     virtual void Thaw();
  96
  97     virtual void SetWindowStyleFlag( long style );
  98     virtual bool SetCursor( const wxCursor &cursor );
  99     virtual bool SetFont( const wxFont &font );
 100
 101     virtual int GetCharHeight() const;
 102     virtual int GetCharWidth() const;
 103     virtual void GetTextExtent(const wxString& string,
 104                                int *x, int *y,
 105                                int *descent = (int *) NULL,
 106                                int *externalLeading = (int *) NULL,
 107                                const wxFont *theFont = (const wxFont *) NULL)
 108                                const;
 109
 110 #if wxUSE_MENUS_NATIVE
 111     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 112 #endif // wxUSE_MENUS_NATIVE
 113
 114     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 115                                int range, bool refresh = TRUE );
 116     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 117     virtual int GetScrollPos( int orient ) const;
 118     virtual int GetScrollThumb( int orient ) const;
 119     virtual int GetScrollRange( int orient ) const;
 120     virtual void ScrollWindow( int dx, int dy,
 121                                const wxRect* rect = (wxRect *) NULL );
 122
 123     virtual bool ScrollLines(int lines);
 124     virtual bool ScrollPages(int pages);
 125
 126 #if wxUSE_DRAG_AND_DROP
 127     virtual void SetDropTarget( wxDropTarget *dropTarget );
 128 #endif // wxUSE_DRAG_AND_DROP
 129
 130     // Accept files for dragging
 131     virtual void DragAcceptFiles(bool accept);
 132
 133 #if WXWIN_COMPATIBILITY_2_4
 134     wxDEPRECATED( bool GetUseCtl3D() const );
 135     wxDEPRECATED( bool GetTransparentBackground() const );
 136     wxDEPRECATED( void SetTransparent(bool t = TRUE) );
 137 #endif // WXWIN_COMPATIBILITY_2_4
 138
 139 #ifndef __WXUNIVERSAL__
 140     // Native resource loading (implemented in src/msw/nativdlg.cpp)
 141     // FIXME: should they really be all virtual?
 142     virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
 143     virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
 144     wxWindow* GetWindowChild1(wxWindowID id);
 145     wxWindow* GetWindowChild(wxWindowID id);
 146 #endif // __WXUNIVERSAL__
 147
 148 #if wxUSE_HOTKEY
 149     // install and deinstall a system wide hotkey
 150     virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode);
 151     virtual bool UnregisterHotKey(int hotkeyId);
 152 #endif // wxUSE_HOTKEY
 153
 154     // implementation from now on
 155     // --------------------------
 156
 157     // simple accessors
 158     // ----------------
 159
 160     WXHWND GetHWND() const { return m_hWnd; }
 161     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
 162     virtual WXWidget GetHandle() const { return GetHWND(); }
 163
 164     // event handlers
 165     // --------------
 166
 167     void OnEraseBackground(wxEraseEvent& event);
 168     void OnPaint(wxPaintEvent& event);
 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 wxWindows') 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 wxWindows 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 wxWindows 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 wxWindows 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     bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam);
 304
 305     bool HandleCtlColor(WXHBRUSH *hBrush,
 306                         WXHDC hdc,
 307                         WXHWND hWnd,
 308                         WXUINT nCtlColor,
 309                         WXUINT message,
 310                         WXWPARAM wParam,
 311                         WXLPARAM lParam);
 312
 313     bool HandlePaletteChanged(WXHWND hWndPalChange);
 314     bool HandleQueryNewPalette();
 315     bool HandleSysColorChange();
 316     bool HandleDisplayChange();
 317     bool HandleCaptureChanged(WXHWND gainedCapture);
 318
 319     bool HandleQueryEndSession(long logOff, bool *mayEnd);
 320     bool HandleEndSession(bool endSession, long logOff);
 321
 322     bool HandleSetFocus(WXHWND wnd);
 323     bool HandleKillFocus(WXHWND wnd);
 324
 325     bool HandleDropFiles(WXWPARAM wParam);
 326
 327     bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
 328     bool HandleMouseMove(int x, int y, WXUINT flags);
 329     bool HandleMouseWheel(WXWPARAM wParam, WXLPARAM lParam);
 330
 331     bool HandleChar(WXWPARAM wParam, WXLPARAM lParam, bool isASCII = FALSE);
 332     bool HandleKeyDown(WXWPARAM wParam, WXLPARAM lParam);
 333     bool HandleKeyUp(WXWPARAM wParam, WXLPARAM lParam);
 334 #if wxUSE_ACCEL
 335     bool HandleHotKey(WXWPARAM wParam, WXLPARAM lParam);
 336 #endif
 337 #ifdef __WIN32__
 338     int HandleMenuChar(int chAccel, WXLPARAM lParam);
 339 #endif
 340
 341     bool HandleQueryDragIcon(WXHICON *hIcon);
 342
 343     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 344
 345     // Window procedure
 346     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 347
 348     // Calls an appropriate default window procedure
 349     virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 350
 351     // message processing helpers
 352
 353     // return FALSE if the message shouldn't be translated/preprocessed but
 354     // dispatched normally
 355     virtual bool MSWShouldPreProcessMessage(WXMSG* pMsg);
 356
 357     // return TRUE if the message was preprocessed and shouldn't be dispatched
 358     virtual bool MSWProcessMessage(WXMSG* pMsg);
 359
 360     // return TRUE if the message was translated and shouldn't be dispatched
 361     virtual bool MSWTranslateMessage(WXMSG* pMsg);
 362
 363     // called when the window is about to be destroyed
 364     virtual void MSWDestroyWindow();
 365
 366     // this function should return the brush to paint the window background
 367     // with or 0 for the default brush
 368     virtual WXHBRUSH OnCtlColor(WXHDC hDC,
 369                                 WXHWND hWnd,
 370                                 WXUINT nCtlColor,
 371                                 WXUINT message,
 372                                 WXWPARAM wParam,
 373                                 WXLPARAM lParam);
 374
 375     // Responds to colour changes: passes event on to children.
 376     void OnSysColourChanged(wxSysColourChangedEvent& event);
 377
 378     // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
 379     void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
 380
 381     // check if mouse is in the window
 382     bool IsMouseInWindow() const;
 383
 384     // virtual function for implementing internal idle
 385     // behaviour
 386     virtual void OnInternalIdle() ;
 387
 388 protected:
 389     // the window handle
 390     WXHWND                m_hWnd;
 391
 392     // the old window proc (we subclass all windows)
 393     WXFARPROC             m_oldWndProc;
 394
 395     // additional (MSW specific) flags
 396     bool                  m_mouseInWindow:1;
 397     bool                  m_lastKeydownProcessed:1;
 398
 399     // the size of one page for scrolling
 400     int                   m_xThumbSize;
 401     int                   m_yThumbSize;
 402
 403 #if wxUSE_MOUSEEVENT_HACK
 404     // the coordinates of the last mouse event and the type of it
 405     long                  m_lastMouseX,
 406                           m_lastMouseY;
 407     int                   m_lastMouseEvent;
 408 #endif // wxUSE_MOUSEEVENT_HACK
 409
 410     WXHMENU               m_hMenu; // Menu, if any
 411
 412     // implement the base class pure virtuals
 413     virtual void DoClientToScreen( int *x, int *y ) const;
 414     virtual void DoScreenToClient( int *x, int *y ) const;
 415     virtual void DoGetPosition( int *x, int *y ) const;
 416     virtual void DoGetSize( int *width, int *height ) const;
 417     virtual void DoGetClientSize( int *width, int *height ) const;
 418     virtual void DoSetSize(int x, int y,
 419                            int width, int height,
 420                            int sizeFlags = wxSIZE_AUTO);
 421     virtual void DoSetClientSize(int width, int height);
 422
 423     virtual void DoCaptureMouse();
 424     virtual void DoReleaseMouse();
 425
 426     // move the window to the specified location and resize it: this is called
 427     // from both DoSetSize() and DoSetClientSize() and would usually just call
 428     // ::MoveWindow() except for composite controls which will want to arrange
 429     // themselves inside the given rectangle
 430     virtual void DoMoveWindow(int x, int y, int width, int height);
 431
 432 #if wxUSE_TOOLTIPS
 433     virtual void DoSetToolTip( wxToolTip *tip );
 434
 435     // process TTN_NEEDTEXT message properly (i.e. fixing the bugs in
 436     // comctl32.dll in our code -- see the function body for more info)
 437     bool HandleTooltipNotify(WXUINT code,
 438                              WXLPARAM lParam,
 439                              const wxString& ttip);
 440 #endif // wxUSE_TOOLTIPS
 441
 442     // the helper functions used by HandleChar/KeyXXX methods
 443     wxKeyEvent CreateKeyEvent(wxEventType evType, int id,
 444                               WXLPARAM lParam = 0, WXWPARAM wParam = 0) const;
 445
 446 private:
 447     // common part of all ctors
 448     void Init();
 449
 450     // the (non-virtual) handlers for the events
 451     bool HandleMove(int x, int y);
 452     bool HandleMoving(wxRect& rect);
 453     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
 454
 455 #ifdef __WIN95__
 456     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 457 #endif // __WIN95__
 458
 459     // list of disabled children before last call to our Disable()
 460     wxWindowList *m_childrenDisabled;
 461
 462     DECLARE_DYNAMIC_CLASS(wxWindowMSW)
 463     DECLARE_NO_COPY_CLASS(wxWindowMSW)
 464     DECLARE_EVENT_TABLE()
 465 };
 466
 467 // ----------------------------------------------------------------------------
 468 // inline functions
 469 // ----------------------------------------------------------------------------
 470
 471 #if WXWIN_COMPATIBILITY_2_4
 472
 473 inline bool wxWindowMSW::GetUseCtl3D() const { return false; }
 474 inline bool wxWindowMSW::GetTransparentBackground() const { return false; }
 475 inline void wxWindowMSW::SetTransparent(bool WXUNUSED(t)) { }
 476
 477 #endif // WXWIN_COMPATIBILITY_2_4
 478
 479 // ---------------------------------------------------------------------------
 480 // global functions
 481 // ---------------------------------------------------------------------------
 482
 483 // kbd code translation
 484 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
 485 WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
 486
 487 // window creation helper class: before creating a new HWND, instantiate an
 488 // object of this class on stack - this allows to process the messages sent to
 489 // the window even before CreateWindow() returns
 490 class wxWindowCreationHook
 491 {
 492 public:
 493     wxWindowCreationHook(wxWindowMSW *winBeingCreated);
 494     ~wxWindowCreationHook();
 495 };
 496
 497 #endif
 498     // _WX_WINDOW_H_