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