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