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