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