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