include/wx/msw/window.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        window.h
   3 // Purpose:     wxWindow class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_WINDOW_H_
  13 #define _WX_WINDOW_H_
  14
  15 // ---------------------------------------------------------------------------
  16 // headers
  17 // ---------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "window.h"
  21 #endif
  22
  23 // #include "wx/msw/winundef.h"
  24
  25 // VZ: apparently some version of Windows send extra mouse move messages after
  26 //     a mouse click. My tests under NT 4.0 and 95 didn't show it so I'm
  27 //     tempted to think that it was just an effect of a poor mouse and so the
  28 //     code to work around this is currently disabled - just define this as 1
  29 //     to reenable it
  30 #define wxUSE_MOUSEEVENT_HACK 0
  31
  32 // ---------------------------------------------------------------------------
  33 // forward declarations
  34 // ---------------------------------------------------------------------------
  35
  36 class WXDLLEXPORT wxButton;
  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 class WXDLLEXPORT wxWindow : public wxWindowBase
  53 {
  54     DECLARE_DYNAMIC_CLASS(wxWindow);
  55
  56 public:
  57     wxWindow() { Init(); }
  58
  59     wxWindow(wxWindow *parent,
  60              wxWindowID id,
  61              const wxPoint& pos = wxDefaultPosition,
  62              const wxSize& size = wxDefaultSize,
  63              long style = 0,
  64              const wxString& name = wxPanelNameStr)
  65     {
  66         Init();
  67         Create(parent, id, pos, size, style, name);
  68     }
  69
  70     virtual ~wxWindow();
  71
  72     bool Create(wxWindow *parent,
  73                 wxWindowID id,
  74                 const wxPoint& pos = wxDefaultPosition,
  75                 const wxSize& size = wxDefaultSize,
  76                 long style = 0,
  77                 const wxString& name = wxPanelNameStr);
  78
  79     // implement base class pure virtuals
  80     virtual void SetTitle( const wxString& title);
  81     virtual wxString GetTitle() const;
  82
  83     virtual void Raise();
  84     virtual void Lower();
  85
  86     virtual bool Show( bool show = TRUE );
  87     virtual bool Enable( bool enable = TRUE );
  88
  89     virtual void SetFocus();
  90
  91     virtual bool Reparent( wxWindow *newParent );
  92
  93     virtual void WarpPointer(int x, int y);
  94     virtual void CaptureMouse();
  95     virtual void ReleaseMouse();
  96
  97     virtual void Refresh( bool eraseBackground = TRUE,
  98                           const wxRect *rect = (const wxRect *) NULL );
  99     virtual void Clear();
 100
 101     virtual bool SetCursor( const wxCursor &cursor );
 102     virtual bool SetFont( const wxFont &font );
 103
 104     virtual int GetCharHeight() const;
 105     virtual int GetCharWidth() const;
 106     virtual void GetTextExtent(const wxString& string,
 107                                int *x, int *y,
 108                                int *descent = (int *) NULL,
 109                                int *externalLeading = (int *) NULL,
 110                                const wxFont *theFont = (const wxFont *) NULL)
 111                                const;
 112
 113     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 114
 115     virtual void SetScrollbar( int orient, int pos, int thumbVisible,
 116                                int range, bool refresh = TRUE );
 117     virtual void SetScrollPos( int orient, int pos, bool refresh = TRUE );
 118     virtual int GetScrollPos( int orient ) const;
 119     virtual int GetScrollThumb( int orient ) const;
 120     virtual int GetScrollRange( int orient ) const;
 121     virtual void ScrollWindow( int dx, int dy,
 122                                const wxRect* rect = (wxRect *) NULL );
 123
 124 #if wxUSE_DRAG_AND_DROP
 125     virtual void SetDropTarget( wxDropTarget *dropTarget );
 126 #endif // wxUSE_DRAG_AND_DROP
 127
 128     // Accept files for dragging
 129     virtual void DragAcceptFiles(bool accept);
 130
 131 #if WXWIN_COMPATIBILITY
 132     // Set/get scroll attributes
 133     virtual void SetScrollRange(int orient, int range, bool refresh = TRUE);
 134     virtual void SetScrollPage(int orient, int page, bool refresh = TRUE);
 135     virtual int OldGetScrollRange(int orient) const;
 136     virtual int GetScrollPage(int orient) const;
 137
 138     // event handlers
 139         // Handle a control command
 140     virtual void OnCommand(wxWindow& win, wxCommandEvent& event);
 141
 142         // Override to define new behaviour for default action (e.g. double
 143         // clicking on a listbox)
 144     virtual void OnDefaultAction(wxControl * WXUNUSED(initiatingItem)) { }
 145 #endif // WXWIN_COMPATIBILITY
 146
 147 #if wxUSE_CARET && WXWIN_COMPATIBILITY
 148     // caret manipulation (old MSW only functions, see wxCaret class for the
 149     // new API)
 150     void CreateCaret(int w, int h);
 151     void CreateCaret(const wxBitmap *bitmap);
 152     void DestroyCaret();
 153     void ShowCaret(bool show);
 154     void SetCaretPos(int x, int y);
 155     void GetCaretPos(int *x, int *y) const;
 156 #endif // wxUSE_CARET
 157
 158     // Native resource loading (implemented in src/msw/nativdlg.cpp)
 159     // FIXME: should they really be all virtual?
 160     virtual bool LoadNativeDialog(wxWindow* parent, wxWindowID& id);
 161     virtual bool LoadNativeDialog(wxWindow* parent, const wxString& name);
 162     wxWindow* GetWindowChild1(wxWindowID id);
 163     wxWindow* GetWindowChild(wxWindowID id);
 164
 165     // implementation from now on
 166     // --------------------------
 167
 168     // simple accessors
 169     // ----------------
 170
 171     WXHWND GetHWND() const { return m_hWnd; }
 172     void SetHWND(WXHWND hWnd) { m_hWnd = hWnd; }
 173     virtual WXWidget GetHandle() const { return GetHWND(); }
 174
 175     bool GetUseCtl3D() const { return m_useCtl3D; }
 176     bool GetTransparentBackground() const { return m_backgroundTransparent; }
 177     void SetTransparent(bool t = TRUE) { m_backgroundTransparent = t; }
 178
 179     // event handlers
 180     // --------------
 181     void OnEraseBackground(wxEraseEvent& event);
 182     void OnIdle(wxIdleEvent& event);
 183
 184 public:
 185     // For implementation purposes - sometimes decorations make the client area
 186     // smaller
 187     virtual wxPoint GetClientAreaOrigin() const;
 188
 189     // Makes an adjustment to the window position (for example, a frame that has
 190     // a toolbar that it manages itself).
 191     virtual void AdjustForParentClientOrigin(int& x, int& y, int sizeFlags);
 192
 193     // Windows subclassing
 194     void SubclassWin(WXHWND hWnd);
 195     void UnsubclassWin();
 196
 197     WXFARPROC MSWGetOldWndProc() const { return m_oldWndProc; }
 198     void MSWSetOldWndProc(WXFARPROC proc) { m_oldWndProc = proc; }
 199
 200     wxWindow *FindItem(int id) const;
 201     wxWindow *FindItemByHWND(WXHWND hWnd, bool controlOnly = FALSE) const;
 202
 203     // Make a Windows extended style from the given wxWindows window style
 204     static WXDWORD MakeExtendedStyle(long style,
 205                                      bool eliminateBorders = TRUE);
 206     // Determine whether 3D effects are wanted
 207     WXDWORD Determine3DEffects(WXDWORD defaultBorderStyle, bool *want3D) const;
 208
 209     // MSW only: TRUE if this control is part of the main control
 210     virtual bool ContainsHWND(WXHWND WXUNUSED(hWnd)) const { return FALSE; };
 211
 212     // returns TRUE if the window has been created
 213     bool MSWCreate(int id,
 214                    wxWindow *parent,
 215                    const wxChar *wclass,
 216                    wxWindow *wx_win,
 217                    const wxChar *title,
 218                    int x, int y, int width, int height,
 219                    WXDWORD style,
 220                    const wxChar *dialog_template = NULL,
 221                    WXDWORD exendedStyle = 0);
 222     virtual bool MSWCommand(WXUINT param, WXWORD id);
 223
 224 #if WXWIN_COMPATIBILITY
 225     wxObject *GetChild(int number) const;
 226     virtual void MSWDeviceToLogical(float *x, float *y) const;
 227 #endif // WXWIN_COMPATIBILITY
 228
 229     // Create an appropriate wxWindow from a HWND
 230     virtual wxWindow* CreateWindowFromHWND(wxWindow* parent, WXHWND hWnd);
 231
 232     // Make sure the window style reflects the HWND style (roughly)
 233     virtual void AdoptAttributesFromHWND();
 234
 235     // Setup background and foreground colours correctly
 236     virtual void SetupColours();
 237
 238     // ------------------------------------------------------------------------
 239     // helpers for message handlers: these perform the same function as the
 240     // message crackers from <windowsx.h> - they unpack WPARAM and LPARAM into
 241     // the correct parameters
 242     // ------------------------------------------------------------------------
 243
 244     void UnpackCommand(WXWPARAM wParam, WXLPARAM lParam,
 245                        WXWORD *id, WXHWND *hwnd, WXWORD *cmd);
 246     void UnpackActivate(WXWPARAM wParam, WXLPARAM lParam,
 247                         WXWORD *state, WXWORD *minimized, WXHWND *hwnd);
 248     void UnpackScroll(WXWPARAM wParam, WXLPARAM lParam,
 249                       WXWORD *code, WXWORD *pos, WXHWND *hwnd);
 250     void UnpackCtlColor(WXWPARAM wParam, WXLPARAM lParam,
 251                         WXWORD *nCtlColor, WXHDC *hdc, WXHWND *hwnd);
 252     void UnpackMenuSelect(WXWPARAM wParam, WXLPARAM lParam,
 253                           WXWORD *item, WXWORD *flags, WXHMENU *hmenu);
 254
 255     // ------------------------------------------------------------------------
 256     // internal handlers for MSW messages: all handlers return a boolen value:
 257     // TRUE means that the handler processed the event and FALSE that it didn't
 258     // ------------------------------------------------------------------------
 259
 260     // there are several cases where we have virtual functions for Windows
 261     // message processing: this is because these messages often require to be
 262     // processed in a different manner in the derived classes. For all other
 263     // messages, however, we do *not* have corresponding MSWOnXXX() function
 264     // and if the derived class wants to process them, it should override
 265     // MSWWindowProc() directly.
 266
 267     // scroll event (both horizontal and vertical)
 268     virtual bool MSWOnScroll(int orientation, WXWORD nSBCode,
 269                              WXWORD pos, WXHWND control);
 270
 271     // child control notifications
 272 #ifdef __WIN95__
 273     virtual bool MSWOnNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 274 #endif // __WIN95__
 275
 276     // owner-drawn controls need to process these messages
 277     virtual bool MSWOnDrawItem(int id, WXDRAWITEMSTRUCT *item);
 278     virtual bool MSWOnMeasureItem(int id, WXMEASUREITEMSTRUCT *item);
 279
 280     // the rest are not virtual
 281     bool HandleCreate(WXLPCREATESTRUCT cs, bool *mayCreate);
 282     bool HandleInitDialog(WXHWND hWndFocus);
 283     bool HandleDestroy();
 284
 285     bool HandlePaint();
 286     bool HandleEraseBkgnd(WXHDC pDC);
 287
 288     bool HandleMinimize();
 289     bool HandleMaximize();
 290     bool HandleSize(int x, int y, WXUINT flag);
 291     bool HandleGetMinMaxInfo(void *mmInfo);
 292
 293     bool HandleShow(bool show, int status);
 294     bool HandleActivate(int flag, bool minimized, WXHWND activate);
 295
 296     bool HandleCommand(WXWORD id, WXWORD cmd, WXHWND control);
 297     bool HandleSysCommand(WXWPARAM wParam, WXLPARAM lParam);
 298
 299     bool HandleCtlColor(WXHBRUSH *hBrush,
 300                         WXHDC hdc,
 301                         WXHWND hWnd,
 302                         WXUINT nCtlColor,
 303                         WXUINT message,
 304                         WXWPARAM wParam,
 305                         WXLPARAM lParam);
 306
 307     bool HandlePaletteChanged(WXHWND hWndPalChange);
 308     bool HandleQueryNewPalette();
 309     bool HandleSysColorChange();
 310
 311     bool HandleQueryEndSession(long logOff, bool *mayEnd);
 312     bool HandleEndSession(bool endSession, long logOff);
 313
 314     bool HandleSetFocus(WXHWND wnd);
 315     bool HandleKillFocus(WXHWND wnd);
 316
 317     bool HandleDropFiles(WXWPARAM wParam);
 318
 319     bool HandleMouseEvent(WXUINT msg, int x, int y, WXUINT flags);
 320     bool HandleMouseMove(int x, int y, WXUINT flags);
 321
 322     bool HandleChar(WXWORD wParam, WXLPARAM lParam, bool isASCII = FALSE);
 323     bool HandleKeyDown(WXWORD wParam, WXLPARAM lParam);
 324     bool HandleKeyUp(WXWORD wParam, WXLPARAM lParam);
 325
 326     bool HandleQueryDragIcon(WXHICON *hIcon);
 327
 328     bool HandleSetCursor(WXHWND hWnd, short nHitTest, int mouseMsg);
 329
 330     // Window procedure
 331     virtual long MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 332
 333     // Calls an appropriate default window procedure
 334     virtual long MSWDefWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 335     virtual bool MSWProcessMessage(WXMSG* pMsg);
 336     virtual bool MSWTranslateMessage(WXMSG* pMsg);
 337     virtual void MSWDestroyWindow();
 338
 339     // Detach "Window" menu from menu bar so it doesn't get deleted
 340     void MSWDetachWindowMenu();
 341
 342     // this function should return the brush to paint the window background
 343     // with or 0 for the default brush
 344     virtual WXHBRUSH OnCtlColor(WXHDC hDC,
 345                                 WXHWND hWnd,
 346                                 WXUINT nCtlColor,
 347                                 WXUINT message,
 348                                 WXWPARAM wParam,
 349                                 WXLPARAM lParam);
 350
 351 #if WXWIN_COMPATIBILITY
 352     void SetShowing(bool show) { (void)Show(show); }
 353     bool IsUserEnabled() const { return IsEnabled(); }
 354 #endif // WXWIN_COMPATIBILITY
 355
 356     // Responds to colour changes: passes event on to children.
 357     void OnSysColourChanged(wxSysColourChangedEvent& event);
 358
 359     // initialize various fields of wxMouseEvent (common part of MSWOnMouseXXX)
 360     void InitMouseEvent(wxMouseEvent& event, int x, int y, WXUINT flags);
 361
 362 protected:
 363     // the window handle
 364     WXHWND                m_hWnd;
 365
 366     // the old window proc (we subclass all windows)
 367     WXFARPROC             m_oldWndProc;
 368
 369     // additional (MSW specific) flags
 370     bool                  m_useCtl3D:1; // Using CTL3D for this control
 371     bool                  m_backgroundTransparent:1;
 372     bool                  m_mouseInWindow:1;
 373     bool                  m_doubleClickAllowed:1;
 374     bool                  m_winCaptured:1;
 375
 376     // the size of one page for scrolling
 377     int                   m_xThumbSize;
 378     int                   m_yThumbSize;
 379
 380 #if wxUSE_MOUSEEVENT_HACK
 381     // the coordinates of the last mouse event and the type of it
 382     long                  m_lastMouseX,
 383                           m_lastMouseY;
 384     int                   m_lastMouseEvent;
 385 #endif // wxUSE_MOUSEEVENT_HACK
 386
 387     WXHMENU               m_hMenu; // Menu, if any
 388
 389     // the return value of WM_GETDLGCODE handler
 390     long m_lDlgCode;
 391
 392     // implement the base class pure virtuals
 393     virtual void DoClientToScreen( int *x, int *y ) const;
 394     virtual void DoScreenToClient( int *x, int *y ) const;
 395     virtual void DoGetPosition( int *x, int *y ) const;
 396     virtual void DoGetSize( int *width, int *height ) const;
 397     virtual void DoGetClientSize( int *width, int *height ) const;
 398     virtual void DoSetSize(int x, int y,
 399                            int width, int height,
 400                            int sizeFlags = wxSIZE_AUTO);
 401     virtual void DoSetClientSize(int width, int height);
 402
 403     // get the size which best suits the window: e.g., for a static text it
 404     // will be the width and height of the text
 405     virtual wxSize DoGetBestSize();
 406
 407 #if wxUSE_TOOLTIPS
 408     virtual void DoSetToolTip( wxToolTip *tip );
 409 #endif // wxUSE_TOOLTIPS
 410
 411 private:
 412     // common part of all ctors
 413     void Init();
 414
 415     // the (non-virtual) handlers for the events
 416     bool HandleMove(int x, int y);
 417     bool HandleJoystickEvent(WXUINT msg, int x, int y, WXUINT flags);
 418
 419 #ifdef __WIN95__
 420     bool HandleNotify(int idCtrl, WXLPARAM lParam, WXLPARAM *result);
 421 #endif // __WIN95__
 422
 423     DECLARE_NO_COPY_CLASS(wxWindow);
 424     DECLARE_EVENT_TABLE()
 425 };
 426
 427 // ---------------------------------------------------------------------------
 428 // global functions
 429 // ---------------------------------------------------------------------------
 430
 431 // kbd code translation
 432 WXDLLEXPORT int wxCharCodeMSWToWX(int keySym);
 433 WXDLLEXPORT int wxCharCodeWXToMSW(int id, bool *IsVirtual);
 434
 435 #endif
 436     // _WX_WINDOW_H_