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