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