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