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