include/wx/msw/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/private.h
   3 // Purpose:     Private declarations: as this header is only included by
   4 //              wxWidgets itself, it may contain identifiers which don't start
   5 //              with "wx".
   6 // Author:      Julian Smart
   7 // Modified by:
   8 // Created:     01/02/97
   9 // RCS-ID:      $Id$
  10 // Copyright:   (c) Julian Smart
  11 // Licence:     wxWindows licence
  12 /////////////////////////////////////////////////////////////////////////////
  13
  14 #ifndef _WX_PRIVATE_H_
  15 #define _WX_PRIVATE_H_
  16
  17 #include "wx/msw/wrapwin.h"
  18
  19 #ifdef __WXMICROWIN__
  20     // Extra prototypes and symbols not defined by MicroWindows
  21     #include "wx/msw/microwin.h"
  22 #endif
  23
  24 #include "wx/log.h"
  25
  26 #if wxUSE_GUI
  27     #include "wx/window.h"
  28 #endif // wxUSE_GUI
  29
  30 class WXDLLIMPEXP_FWD_CORE wxFont;
  31 class WXDLLIMPEXP_FWD_CORE wxWindow;
  32 class WXDLLIMPEXP_FWD_CORE wxWindowBase;
  33
  34 // ---------------------------------------------------------------------------
  35 // private constants
  36 // ---------------------------------------------------------------------------
  37
  38 // 260 was taken from windef.h
  39 #ifndef MAX_PATH
  40     #define MAX_PATH  260
  41 #endif
  42
  43 // ---------------------------------------------------------------------------
  44 // standard icons from the resources
  45 // ---------------------------------------------------------------------------
  46
  47 #if wxUSE_GUI
  48
  49 extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_FRAME_ICON;
  50 extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_MDIPARENTFRAME_ICON;
  51 extern WXDLLIMPEXP_DATA_CORE(HICON) wxSTD_MDICHILDFRAME_ICON;
  52 extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_FRAME_ICON;
  53 extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
  54 extern WXDLLIMPEXP_DATA_CORE(HICON) wxDEFAULT_MDICHILDFRAME_ICON;
  55 extern WXDLLIMPEXP_DATA_CORE(HFONT) wxSTATUS_LINE_FONT;
  56
  57 #endif // wxUSE_GUI
  58
  59 // ---------------------------------------------------------------------------
  60 // global data
  61 // ---------------------------------------------------------------------------
  62
  63 extern WXDLLIMPEXP_DATA_BASE(HINSTANCE) wxhInstance;
  64
  65 extern "C"
  66 {
  67     WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
  68 }
  69
  70 WXDLLIMPEXP_BASE void wxSetInstance(HINSTANCE hInst);
  71
  72 // ---------------------------------------------------------------------------
  73 // define things missing from some compilers' headers
  74 // ---------------------------------------------------------------------------
  75
  76 #if defined(__WXWINCE__) || (defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS)
  77 #ifndef ZeroMemory
  78     inline void ZeroMemory(void *buf, size_t len) { memset(buf, 0, len); }
  79 #endif
  80 #endif // old mingw32
  81
  82 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
  83 // window proc
  84 #if defined(STRICT) || defined(__GNUC__)
  85     typedef WNDPROC WndProcCast;
  86 #else
  87     typedef FARPROC WndProcCast;
  88 #endif
  89
  90
  91 #define CASTWNDPROC (WndProcCast)
  92
  93
  94
  95 // ---------------------------------------------------------------------------
  96 // some stuff for old Windows versions (FIXME: what does it do here??)
  97 // ---------------------------------------------------------------------------
  98
  99 #if !defined(APIENTRY)  // NT defines APIENTRY, 3.x not
 100     #define APIENTRY FAR PASCAL
 101 #endif
 102
 103 #ifdef __WIN32__
 104     #define _EXPORT
 105 #else
 106     #define _EXPORT _export
 107 #endif
 108
 109 #ifndef __WIN32__
 110     typedef signed short int SHORT;
 111 #endif
 112
 113 #if !defined(__WIN32__)  // 3.x uses FARPROC for dialogs
 114 #ifndef STRICT
 115     #define DLGPROC FARPROC
 116 #endif
 117 #endif
 118
 119 /*
 120  * Decide what window classes we're going to use
 121  * for this combination of CTl3D/FAFA settings
 122  */
 123
 124 #define STATIC_CLASS     wxT("STATIC")
 125 #define STATIC_FLAGS     (SS_LEFT|WS_CHILD|WS_VISIBLE)
 126 #define CHECK_CLASS      wxT("BUTTON")
 127 #define CHECK_FLAGS      (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
 128 #define CHECK_IS_FAFA    FALSE
 129 #define RADIO_CLASS      wxT("BUTTON")
 130 #define RADIO_FLAGS      (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
 131 #define RADIO_SIZE       20
 132 #define RADIO_IS_FAFA    FALSE
 133 #define PURE_WINDOWS
 134 #define GROUP_CLASS      wxT("BUTTON")
 135 #define GROUP_FLAGS      (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
 136
 137 /*
 138 #define BITCHECK_FLAGS   (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
 139 #define BITRADIO_FLAGS   (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
 140 */
 141
 142 // ---------------------------------------------------------------------------
 143 // misc macros
 144 // ---------------------------------------------------------------------------
 145
 146 #define MEANING_CHARACTER '0'
 147 #define DEFAULT_ITEM_WIDTH  100
 148 #define DEFAULT_ITEM_HEIGHT 80
 149
 150 // Scale font to get edit control height
 151 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (3*(cy)/2)
 152 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (cy+8)
 153
 154 // Generic subclass proc, for panel item moving/sizing and intercept
 155 // EDIT control VK_RETURN messages
 156 extern LONG APIENTRY _EXPORT
 157   wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 158
 159 // ---------------------------------------------------------------------------
 160 // useful macros and functions
 161 // ---------------------------------------------------------------------------
 162
 163 // a wrapper macro for ZeroMemory()
 164 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
 165 #define wxZeroMemory(obj)   ::ZeroMemory(&obj, sizeof(obj))
 166 #else
 167 #define wxZeroMemory(obj)   memset((void*) & obj, 0, sizeof(obj))
 168 #endif
 169
 170 // This one is a macro so that it can be tested with #ifdef, it will be
 171 // undefined if it cannot be implemented for a given compiler.
 172 // Vc++, bcc, dmc, ow, mingw akk have _get_osfhandle() and Cygwin has
 173 // get_osfhandle. Others are currently unknown, e.g. Salford, Intel, Visual
 174 // Age.
 175 #if defined(__WXWINCE__)
 176     #define wxGetOSFHandle(fd) ((HANDLE)fd)
 177     #define wxOpenOSFHandle(h, flags) ((int)wxPtrToUInt(h))
 178 #elif defined(__CYGWIN__)
 179     #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
 180 #elif defined(__VISUALC__) \
 181    || defined(__BORLANDC__) \
 182    || defined(__DMC__) \
 183    || defined(__WATCOMC__) \
 184    || defined(__MINGW32__)
 185     #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))
 186     #define wxOpenOSFHandle(h, flags) (_open_osfhandle(wxPtrToUInt(h), flags))
 187     #define wx_fdopen _fdopen
 188 #endif
 189
 190 // close the handle in the class dtor
 191 class AutoHANDLE
 192 {
 193 public:
 194     wxEXPLICIT AutoHANDLE(HANDLE handle) : m_handle(handle) { }
 195
 196     bool IsOk() const { return m_handle != INVALID_HANDLE_VALUE; }
 197     operator HANDLE() const { return m_handle; }
 198
 199     ~AutoHANDLE() { if ( IsOk() ) ::CloseHandle(m_handle); }
 200
 201 protected:
 202     HANDLE m_handle;
 203 };
 204
 205 // a template to make initializing Windows styructs less painful: it zeroes all
 206 // the struct fields and also sets cbSize member to the correct value (and so
 207 // can be only used with structures which have this member...)
 208 template <class T>
 209 struct WinStruct : public T
 210 {
 211     WinStruct()
 212     {
 213         ::ZeroMemory(this, sizeof(T));
 214
 215         // explicit qualification is required here for this to be valid C++
 216         this->cbSize = sizeof(T);
 217     }
 218 };
 219
 220
 221 #if wxUSE_GUI
 222
 223 #include "wx/gdicmn.h"
 224 #include "wx/colour.h"
 225
 226 // make conversion from wxColour and COLORREF a bit less painful
 227 inline COLORREF wxColourToRGB(const wxColour& c)
 228 {
 229     return RGB(c.Red(), c.Green(), c.Blue());
 230 }
 231
 232 inline COLORREF wxColourToPalRGB(const wxColour& c)
 233 {
 234     return PALETTERGB(c.Red(), c.Green(), c.Blue());
 235 }
 236
 237 inline wxColour wxRGBToColour(COLORREF rgb)
 238 {
 239     return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 240 }
 241
 242 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
 243 {
 244     c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 245 }
 246
 247 // get the standard colour map for some standard colours - see comment in this
 248 // function to understand why is it needed and when should it be used
 249 //
 250 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
 251 // might be not included/available) array of size wxSTD_COLOUR_MAX
 252 //
 253 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
 254 //     resources as well: it must have the same number of pixels!
 255 enum wxSTD_COLOUR
 256 {
 257     wxSTD_COL_BTNTEXT,
 258     wxSTD_COL_BTNSHADOW,
 259     wxSTD_COL_BTNFACE,
 260     wxSTD_COL_BTNHIGHLIGHT,
 261     wxSTD_COL_MAX
 262 };
 263
 264 struct WXDLLIMPEXP_CORE wxCOLORMAP
 265 {
 266     COLORREF from, to;
 267 };
 268
 269 // this function is implemented in src/msw/window.cpp
 270 extern wxCOLORMAP *wxGetStdColourMap();
 271
 272 // create a wxRect from Windows RECT
 273 inline wxRect wxRectFromRECT(const RECT& rc)
 274 {
 275     return wxRect(rc.left, rc.top, rc.right - rc.left, rc.bottom - rc.top);
 276 }
 277
 278 // copy Windows RECT to our wxRect
 279 inline void wxCopyRECTToRect(const RECT& rc, wxRect& rect)
 280 {
 281     rect = wxRectFromRECT(rc);
 282 }
 283
 284 // and vice versa
 285 inline void wxCopyRectToRECT(const wxRect& rect, RECT& rc)
 286 {
 287     // note that we don't use wxRect::GetRight() as it is one of compared to
 288     // wxRectFromRECT() above
 289     rc.top = rect.y;
 290     rc.left = rect.x;
 291     rc.right = rect.x + rect.width;
 292     rc.bottom = rect.y + rect.height;
 293 }
 294
 295 // translations between HIMETRIC units (which OLE likes) and pixels (which are
 296 // liked by all the others) - implemented in msw/utilsexc.cpp
 297 extern void HIMETRICToPixel(LONG *x, LONG *y);
 298 extern void HIMETRICToPixel(LONG *x, LONG *y, HDC hdcRef);
 299 extern void PixelToHIMETRIC(LONG *x, LONG *y);
 300 extern void PixelToHIMETRIC(LONG *x, LONG *y, HDC hdcRef);
 301
 302 // Windows convention of the mask is opposed to the wxWidgets one, so we need
 303 // to invert the mask each time we pass one/get one to/from Windows
 304 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
 305
 306 // Creates an icon or cursor depending from a bitmap
 307 //
 308 // The bitmap must be valid and it should have a mask. If it doesn't, a default
 309 // mask is created using light grey as the transparent colour.
 310 extern HICON wxBitmapToHICON(const wxBitmap& bmp);
 311
 312 // Same requirments as above apply and the bitmap must also have the correct
 313 // size.
 314 extern
 315 HCURSOR wxBitmapToHCURSOR(const wxBitmap& bmp, int hotSpotX, int hotSpotY);
 316
 317
 318 #if wxUSE_OWNER_DRAWN
 319
 320 // Draw the bitmap in specified state (this is used by owner drawn controls)
 321 enum wxDSBStates
 322 {
 323     wxDSB_NORMAL = 0,
 324     wxDSB_SELECTED,
 325     wxDSB_DISABLED
 326 };
 327
 328 extern
 329 BOOL wxDrawStateBitmap(HDC hDC, HBITMAP hBitmap, int x, int y, UINT uState);
 330
 331 #endif // wxUSE_OWNER_DRAWN
 332
 333 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
 334 // will fail on system with multiple monitors where the coords may be negative
 335 //
 336 // these macros are standard now (Win98) but some older headers don't have them
 337 #ifndef GET_X_LPARAM
 338     #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
 339     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 340 #endif // GET_X_LPARAM
 341
 342 // get the current state of SHIFT/CTRL/ALT keys
 343 inline bool wxIsModifierDown(int vk)
 344 {
 345     // GetKeyState() returns different negative values on WinME and WinNT,
 346     // so simply test for negative value.
 347     return ::GetKeyState(vk) < 0;
 348 }
 349
 350 inline bool wxIsShiftDown()
 351 {
 352     return wxIsModifierDown(VK_SHIFT);
 353 }
 354
 355 inline bool wxIsCtrlDown()
 356 {
 357     return wxIsModifierDown(VK_CONTROL);
 358 }
 359
 360 inline bool wxIsAltDown()
 361 {
 362     return wxIsModifierDown(VK_MENU);
 363 }
 364
 365 inline bool wxIsAnyModifierDown()
 366 {
 367     return wxIsShiftDown() || wxIsCtrlDown() || wxIsAltDown();
 368 }
 369
 370 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
 371 // for Win32
 372 inline RECT wxGetWindowRect(HWND hwnd)
 373 {
 374     RECT rect;
 375
 376     if ( !::GetWindowRect(hwnd, &rect) )
 377     {
 378         wxLogLastError(wxT("GetWindowRect"));
 379     }
 380
 381     return rect;
 382 }
 383
 384 inline RECT wxGetClientRect(HWND hwnd)
 385 {
 386     RECT rect;
 387
 388     if ( !::GetClientRect(hwnd, &rect) )
 389     {
 390         wxLogLastError(wxT("GetClientRect"));
 391     }
 392
 393     return rect;
 394 }
 395
 396 // ---------------------------------------------------------------------------
 397 // small helper classes
 398 // ---------------------------------------------------------------------------
 399
 400 // create an instance of this class and use it as the HDC for screen, will
 401 // automatically release the DC going out of scope
 402 class ScreenHDC
 403 {
 404 public:
 405     ScreenHDC() { m_hdc = ::GetDC(NULL);    }
 406    ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
 407
 408     operator HDC() const { return m_hdc; }
 409
 410 private:
 411     HDC m_hdc;
 412
 413     wxDECLARE_NO_COPY_CLASS(ScreenHDC);
 414 };
 415
 416 // the same as ScreenHDC but for window DCs
 417 class WindowHDC
 418 {
 419 public:
 420     WindowHDC(HWND hwnd) { m_hdc = ::GetDC(m_hwnd = hwnd); }
 421    ~WindowHDC() { ::ReleaseDC(m_hwnd, m_hdc); }
 422
 423     operator HDC() const { return m_hdc; }
 424
 425 private:
 426    HWND m_hwnd;
 427    HDC m_hdc;
 428
 429    wxDECLARE_NO_COPY_CLASS(WindowHDC);
 430 };
 431
 432 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
 433 // the given one (screen by default) in ctor and destroys it in dtor
 434 class MemoryHDC
 435 {
 436 public:
 437     MemoryHDC(HDC hdc = 0) { m_hdc = ::CreateCompatibleDC(hdc); }
 438    ~MemoryHDC() { ::DeleteDC(m_hdc); }
 439
 440     operator HDC() const { return m_hdc; }
 441
 442 private:
 443     HDC m_hdc;
 444
 445     wxDECLARE_NO_COPY_CLASS(MemoryHDC);
 446 };
 447
 448 // a class which selects a GDI object into a DC in its ctor and deselects in
 449 // dtor
 450 class SelectInHDC
 451 {
 452 private:
 453     void DoInit(HGDIOBJ hgdiobj) { m_hgdiobj = ::SelectObject(m_hdc, hgdiobj); }
 454
 455 public:
 456     SelectInHDC() : m_hdc(NULL), m_hgdiobj(NULL) { }
 457     SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc) { DoInit(hgdiobj); }
 458
 459     void Init(HDC hdc, HGDIOBJ hgdiobj)
 460     {
 461         wxASSERT_MSG( !m_hdc, wxT("initializing twice?") );
 462
 463         m_hdc = hdc;
 464
 465         DoInit(hgdiobj);
 466     }
 467
 468     ~SelectInHDC() { if ( m_hdc ) ::SelectObject(m_hdc, m_hgdiobj); }
 469
 470     // return true if the object was successfully selected
 471     operator bool() const { return m_hgdiobj != 0; }
 472
 473 private:
 474     HDC m_hdc;
 475     HGDIOBJ m_hgdiobj;
 476
 477     wxDECLARE_NO_COPY_CLASS(SelectInHDC);
 478 };
 479
 480 // a class which cleans up any GDI object
 481 class AutoGDIObject
 482 {
 483 protected:
 484     AutoGDIObject() { m_gdiobj = NULL; }
 485     AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
 486     ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
 487
 488     void InitGdiobj(HGDIOBJ gdiobj)
 489     {
 490         wxASSERT_MSG( !m_gdiobj, wxT("initializing twice?") );
 491
 492         m_gdiobj = gdiobj;
 493     }
 494
 495     HGDIOBJ GetObject() const { return m_gdiobj; }
 496
 497 private:
 498     HGDIOBJ m_gdiobj;
 499 };
 500
 501 // TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
 502
 503 // a class for temporary brushes
 504 class AutoHBRUSH : private AutoGDIObject
 505 {
 506 public:
 507     AutoHBRUSH(COLORREF col)
 508         : AutoGDIObject(::CreateSolidBrush(col)) { }
 509
 510     operator HBRUSH() const { return (HBRUSH)GetObject(); }
 511 };
 512
 513 // a class for temporary fonts
 514 class AutoHFONT : private AutoGDIObject
 515 {
 516 private:
 517 public:
 518     AutoHFONT()
 519         : AutoGDIObject() { }
 520
 521     AutoHFONT(const LOGFONT& lf)
 522         : AutoGDIObject(::CreateFontIndirect(&lf)) { }
 523
 524     void Init(const LOGFONT& lf) { InitGdiobj(::CreateFontIndirect(&lf)); }
 525
 526     operator HFONT() const { return (HFONT)GetObject(); }
 527 };
 528
 529 // a class for temporary pens
 530 class AutoHPEN : private AutoGDIObject
 531 {
 532 public:
 533     AutoHPEN(COLORREF col)
 534         : AutoGDIObject(::CreatePen(PS_SOLID, 0, col)) { }
 535
 536     operator HPEN() const { return (HPEN)GetObject(); }
 537 };
 538
 539 // classes for temporary bitmaps
 540 class AutoHBITMAP : private AutoGDIObject
 541 {
 542 public:
 543     AutoHBITMAP()
 544         : AutoGDIObject() { }
 545
 546     AutoHBITMAP(HBITMAP hbmp) : AutoGDIObject(hbmp) { }
 547
 548     void Init(HBITMAP hbmp) { InitGdiobj(hbmp); }
 549
 550     operator HBITMAP() const { return (HBITMAP)GetObject(); }
 551 };
 552
 553 class CompatibleBitmap : public AutoHBITMAP
 554 {
 555 public:
 556     CompatibleBitmap(HDC hdc, int w, int h)
 557         : AutoHBITMAP(::CreateCompatibleBitmap(hdc, w, h))
 558     {
 559     }
 560 };
 561
 562 class MonoBitmap : public AutoHBITMAP
 563 {
 564 public:
 565     MonoBitmap(int w, int h)
 566         : AutoHBITMAP(::CreateBitmap(w, h, 1, 1, 0))
 567     {
 568     }
 569 };
 570
 571 // class automatically destroys the region object
 572 class AutoHRGN : private AutoGDIObject
 573 {
 574 public:
 575     AutoHRGN(HRGN hrgn) : AutoGDIObject(hrgn) { }
 576
 577     operator HRGN() const { return (HRGN)GetObject(); }
 578 };
 579
 580 // class sets the specified clipping region during its life time
 581 class HDCClipper
 582 {
 583 public:
 584     HDCClipper(HDC hdc, HRGN hrgn)
 585         : m_hdc(hdc)
 586     {
 587         if ( !::SelectClipRgn(hdc, hrgn) )
 588         {
 589             wxLogLastError(wxT("SelectClipRgn"));
 590         }
 591     }
 592
 593     ~HDCClipper()
 594     {
 595         ::SelectClipRgn(m_hdc, NULL);
 596     }
 597
 598 private:
 599     HDC m_hdc;
 600
 601     wxDECLARE_NO_COPY_CLASS(HDCClipper);
 602 };
 603
 604 // set the given map mode for the life time of this object
 605 //
 606 // NB: SetMapMode() is not supported by CE so we also define a helper macro
 607 //     to avoid using it there
 608 #ifdef __WXWINCE__
 609     #define wxCHANGE_HDC_MAP_MODE(hdc, mm)
 610 #else // !__WXWINCE__
 611     class HDCMapModeChanger
 612     {
 613     public:
 614         HDCMapModeChanger(HDC hdc, int mm)
 615             : m_hdc(hdc)
 616         {
 617             m_modeOld = ::SetMapMode(hdc, mm);
 618             if ( !m_modeOld )
 619             {
 620                 wxLogLastError(wxT("SelectClipRgn"));
 621             }
 622         }
 623
 624         ~HDCMapModeChanger()
 625         {
 626             if ( m_modeOld )
 627                 ::SetMapMode(m_hdc, m_modeOld);
 628         }
 629
 630     private:
 631         HDC m_hdc;
 632         int m_modeOld;
 633
 634         wxDECLARE_NO_COPY_CLASS(HDCMapModeChanger);
 635     };
 636
 637     #define wxCHANGE_HDC_MAP_MODE(hdc, mm) \
 638         HDCMapModeChanger wxMAKE_UNIQUE_NAME(wxHDCMapModeChanger)(hdc, mm)
 639 #endif // __WXWINCE__/!__WXWINCE__
 640
 641 // smart pointer using GlobalAlloc/GlobalFree()
 642 class GlobalPtr
 643 {
 644 public:
 645     // default ctor, call Init() later
 646     GlobalPtr()
 647     {
 648         m_hGlobal = NULL;
 649     }
 650
 651     // allocates a block of given size
 652     void Init(size_t size, unsigned flags = GMEM_MOVEABLE)
 653     {
 654         m_hGlobal = ::GlobalAlloc(flags, size);
 655         if ( !m_hGlobal )
 656         {
 657             wxLogLastError(wxT("GlobalAlloc"));
 658         }
 659     }
 660
 661     GlobalPtr(size_t size, unsigned flags = GMEM_MOVEABLE)
 662     {
 663         Init(size, flags);
 664     }
 665
 666     ~GlobalPtr()
 667     {
 668         if ( m_hGlobal && ::GlobalFree(m_hGlobal) )
 669         {
 670             wxLogLastError(wxT("GlobalFree"));
 671         }
 672     }
 673
 674     // implicit conversion
 675     operator HGLOBAL() const { return m_hGlobal; }
 676
 677 private:
 678     HGLOBAL m_hGlobal;
 679
 680     wxDECLARE_NO_COPY_CLASS(GlobalPtr);
 681 };
 682
 683 // when working with global pointers (which is unfortunately still necessary
 684 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
 685 // many times as we lock them which just asks for using a "smart lock" class
 686 class GlobalPtrLock
 687 {
 688 public:
 689     // default ctor, use Init() later -- should only be used if the HGLOBAL can
 690     // be NULL (in which case Init() shouldn't be called)
 691     GlobalPtrLock()
 692     {
 693         m_hGlobal = NULL;
 694         m_ptr = NULL;
 695     }
 696
 697     // initialize the object, may be only called if we were created using the
 698     // default ctor; HGLOBAL must not be NULL
 699     void Init(HGLOBAL hGlobal)
 700     {
 701         m_hGlobal = hGlobal;
 702
 703         // NB: GlobalLock() is a macro, not a function, hence don't use the
 704         //     global scope operator with it (and neither with GlobalUnlock())
 705         m_ptr = GlobalLock(hGlobal);
 706         if ( !m_ptr )
 707         {
 708             wxLogLastError(wxT("GlobalLock"));
 709         }
 710     }
 711
 712     // initialize the object, HGLOBAL must not be NULL
 713     GlobalPtrLock(HGLOBAL hGlobal)
 714     {
 715         Init(hGlobal);
 716     }
 717
 718     ~GlobalPtrLock()
 719     {
 720         if ( m_hGlobal && !GlobalUnlock(m_hGlobal) )
 721         {
 722             // this might happen simply because the block became unlocked
 723             DWORD dwLastError = ::GetLastError();
 724             if ( dwLastError != NO_ERROR )
 725             {
 726                 wxLogApiError(wxT("GlobalUnlock"), dwLastError);
 727             }
 728         }
 729     }
 730
 731     void *Get() const { return m_ptr; }
 732     operator void *() const { return m_ptr; }
 733
 734 private:
 735     HGLOBAL m_hGlobal;
 736     void *m_ptr;
 737
 738     wxDECLARE_NO_COPY_CLASS(GlobalPtrLock);
 739 };
 740
 741 // register the class when it is first needed and unregister it in dtor
 742 class ClassRegistrar
 743 {
 744 public:
 745     // ctor doesn't register the class, call Initialize() for this
 746     ClassRegistrar() { m_registered = -1; }
 747
 748     // return true if the class is already registered
 749     bool IsInitialized() const { return m_registered != -1; }
 750
 751     // return true if the class had been already registered
 752     bool IsRegistered() const { return m_registered == 1; }
 753
 754     // try to register the class if not done yet, return true on success
 755     bool Register(const WNDCLASS& wc)
 756     {
 757         // we should only be called if we hadn't been initialized yet
 758         wxASSERT_MSG( m_registered == -1,
 759                         wxT("calling ClassRegistrar::Register() twice?") );
 760
 761         m_registered = ::RegisterClass(&wc) ? 1 : 0;
 762         if ( !IsRegistered() )
 763         {
 764             wxLogLastError(wxT("RegisterClassEx()"));
 765         }
 766         else
 767         {
 768             m_clsname = wc.lpszClassName;
 769         }
 770
 771         return m_registered == 1;
 772     }
 773
 774     // get the name of the registered class (returns empty string if not
 775     // registered)
 776     const wxString& GetName() const { return m_clsname; }
 777
 778     // unregister the class if it had been registered
 779     ~ClassRegistrar()
 780     {
 781         if ( IsRegistered() )
 782         {
 783             if ( !::UnregisterClass(m_clsname.wx_str(), wxGetInstance()) )
 784             {
 785                 wxLogLastError(wxT("UnregisterClass"));
 786             }
 787         }
 788     }
 789
 790 private:
 791     // initial value is -1 which means that we hadn't tried registering the
 792     // class yet, it becomes true or false (1 or 0) when Initialize() is called
 793     int m_registered;
 794
 795     // the name of the class, only non empty if it had been registered
 796     wxString m_clsname;
 797 };
 798
 799 // ---------------------------------------------------------------------------
 800 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
 801 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
 802 // an argument which should be a pointer or reference to the object of the
 803 // corresponding class (this depends on the macro)
 804 // ---------------------------------------------------------------------------
 805
 806 #define GetHwnd()               ((HWND)GetHWND())
 807 #define GetHwndOf(win)          ((HWND)((win)->GetHWND()))
 808 // old name
 809 #define GetWinHwnd              GetHwndOf
 810
 811 #define GetHdc()                ((HDC)GetHDC())
 812 #define GetHdcOf(dc)            ((HDC)(dc).GetHDC())
 813
 814 #define GetHbitmap()            ((HBITMAP)GetHBITMAP())
 815 #define GetHbitmapOf(bmp)       ((HBITMAP)(bmp).GetHBITMAP())
 816
 817 #define GetHicon()              ((HICON)GetHICON())
 818 #define GetHiconOf(icon)        ((HICON)(icon).GetHICON())
 819
 820 #define GetHaccel()             ((HACCEL)GetHACCEL())
 821 #define GetHaccelOf(table)      ((HACCEL)((table).GetHACCEL()))
 822
 823 #define GetHbrush()             ((HBRUSH)GetResourceHandle())
 824 #define GetHbrushOf(brush)      ((HBRUSH)(brush).GetResourceHandle())
 825
 826 #define GetHmenu()              ((HMENU)GetHMenu())
 827 #define GetHmenuOf(menu)        ((HMENU)(menu)->GetHMenu())
 828
 829 #define GetHcursor()            ((HCURSOR)GetHCURSOR())
 830 #define GetHcursorOf(cursor)    ((HCURSOR)(cursor).GetHCURSOR())
 831
 832 #define GetHfont()              ((HFONT)GetHFONT())
 833 #define GetHfontOf(font)        ((HFONT)(font).GetHFONT())
 834
 835 #define GetHimagelist()         ((HIMAGELIST)GetHIMAGELIST())
 836 #define GetHimagelistOf(imgl)   ((HIMAGELIST)(imgl)->GetHIMAGELIST())
 837
 838 #define GetHpalette()           ((HPALETTE)GetHPALETTE())
 839 #define GetHpaletteOf(pal)      ((HPALETTE)(pal).GetHPALETTE())
 840
 841 #define GetHpen()               ((HPEN)GetResourceHandle())
 842 #define GetHpenOf(pen)          ((HPEN)(pen).GetResourceHandle())
 843
 844 #define GetHrgn()               ((HRGN)GetHRGN())
 845 #define GetHrgnOf(rgn)          ((HRGN)(rgn).GetHRGN())
 846
 847 #endif // wxUSE_GUI
 848
 849 // ---------------------------------------------------------------------------
 850 // global functions
 851 // ---------------------------------------------------------------------------
 852
 853 // return the full path of the given module
 854 inline wxString wxGetFullModuleName(HMODULE hmod)
 855 {
 856     wxString fullname;
 857     if ( !::GetModuleFileName
 858             (
 859                 hmod,
 860                 wxStringBuffer(fullname, MAX_PATH),
 861                 MAX_PATH
 862             ) )
 863     {
 864         wxLogLastError(wxT("GetModuleFileName"));
 865     }
 866
 867     return fullname;
 868 }
 869
 870 // return the full path of the program file
 871 inline wxString wxGetFullModuleName()
 872 {
 873     return wxGetFullModuleName((HMODULE)wxGetInstance());
 874 }
 875
 876 // return the run-time version of the OS in a format similar to
 877 // WINVER/_WIN32_WINNT compile-time macros:
 878 //
 879 //      0x0300      Windows NT 3.51
 880 //      0x0400      Windows 95, NT4
 881 //      0x0410      Windows 98
 882 //      0x0500      Windows ME, 2000
 883 //      0x0501      Windows XP, 2003
 884 //      0x0502      Windows XP SP2, 2003 SP1
 885 //      0x0600      Windows Vista, 2008
 886 //      0x0601      Windows 7
 887 //
 888 // for the other Windows versions 0 is currently returned
 889 enum wxWinVersion
 890 {
 891     wxWinVersion_Unknown = 0,
 892
 893     wxWinVersion_3 = 0x0300,
 894     wxWinVersion_NT3 = wxWinVersion_3,
 895
 896     wxWinVersion_4 = 0x0400,
 897     wxWinVersion_95 = wxWinVersion_4,
 898     wxWinVersion_NT4 = wxWinVersion_4,
 899     wxWinVersion_98 = 0x0410,
 900
 901     wxWinVersion_5 = 0x0500,
 902     wxWinVersion_ME = wxWinVersion_5,
 903     wxWinVersion_NT5 = wxWinVersion_5,
 904     wxWinVersion_2000 = wxWinVersion_5,
 905     wxWinVersion_XP = 0x0501,
 906     wxWinVersion_2003 = 0x0501,
 907     wxWinVersion_XP_SP2 = 0x0502,
 908     wxWinVersion_2003_SP1 = 0x0502,
 909
 910     wxWinVersion_6 = 0x0600,
 911     wxWinVersion_Vista = wxWinVersion_6,
 912     wxWinVersion_NT6 = wxWinVersion_6,
 913
 914     wxWinVersion_7 = 0x601
 915 };
 916
 917 WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();
 918
 919 #if wxUSE_GUI
 920
 921 // cursor stuff
 922 extern HCURSOR wxGetCurrentBusyCursor();    // from msw/utils.cpp
 923 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
 924
 925 // GetCursorPos can fail without populating the POINT. This falls back to GetMessagePos.
 926 WXDLLIMPEXP_CORE void wxGetCursorPosMSW(POINT* pt);
 927
 928 WXDLLIMPEXP_CORE void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont& the_font);
 929 WXDLLIMPEXP_CORE void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
 930 WXDLLIMPEXP_CORE wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
 931 WXDLLIMPEXP_CORE wxFontEncoding wxGetFontEncFromCharSet(int charset);
 932
 933 WXDLLIMPEXP_CORE void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
 934 WXDLLIMPEXP_CORE void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
 935
 936 // Find maximum size of window/rectangle
 937 extern WXDLLIMPEXP_CORE void wxFindMaxSize(WXHWND hwnd, RECT *rect);
 938
 939 // Safely get the window text (i.e. without using fixed size buffer)
 940 extern WXDLLIMPEXP_CORE wxString wxGetWindowText(WXHWND hWnd);
 941
 942 // get the window class name
 943 extern WXDLLIMPEXP_CORE wxString wxGetWindowClass(WXHWND hWnd);
 944
 945 // get the window id (should be unsigned, hence this is not wxWindowID which
 946 // is, for mainly historical reasons, signed)
 947 extern WXDLLIMPEXP_CORE int wxGetWindowId(WXHWND hWnd);
 948
 949 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
 950 // different
 951 extern WXDLLIMPEXP_CORE bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
 952
 953 // Does this window style specify any border?
 954 inline bool wxStyleHasBorder(long style)
 955 {
 956     return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
 957                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 958 }
 959
 960 inline long wxGetWindowExStyle(const wxWindowMSW *win)
 961 {
 962     return ::GetWindowLong(GetHwndOf(win), GWL_EXSTYLE);
 963 }
 964
 965 inline bool wxHasWindowExStyle(const wxWindowMSW *win, long style)
 966 {
 967     return (wxGetWindowExStyle(win) & style) != 0;
 968 }
 969
 970 inline long wxSetWindowExStyle(const wxWindowMSW *win, long style)
 971 {
 972     return ::SetWindowLong(GetHwndOf(win), GWL_EXSTYLE, style);
 973 }
 974
 975 // ----------------------------------------------------------------------------
 976 // functions mapping HWND to wxWindow
 977 // ----------------------------------------------------------------------------
 978
 979 // this function simply checks whether the given hwnd corresponds to a wxWindow
 980 // and returns either that window if it does or NULL otherwise
 981 extern WXDLLIMPEXP_CORE wxWindow* wxFindWinFromHandle(HWND hwnd);
 982
 983 // find the window for HWND which is part of some wxWindow, i.e. unlike
 984 // wxFindWinFromHandle() above it will also work for "sub controls" of a
 985 // wxWindow.
 986 //
 987 // returns the wxWindow corresponding to the given HWND or NULL.
 988 extern WXDLLIMPEXP_CORE wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
 989
 990 // Get the size of an icon
 991 extern WXDLLIMPEXP_CORE wxSize wxGetHiconSize(HICON hicon);
 992
 993 // Lines are drawn differently for WinCE and regular WIN32
 994 WXDLLIMPEXP_CORE void wxDrawLine(HDC hdc, int x1, int y1, int x2, int y2);
 995
 996 // fill the client rect of the given window on the provided dc using this brush
 997 inline void wxFillRect(HWND hwnd, HDC hdc, HBRUSH hbr)
 998 {
 999     RECT rc;
1000     ::GetClientRect(hwnd, &rc);
1001     ::FillRect(hdc, &rc, hbr);
1002 }
1003
1004 // ----------------------------------------------------------------------------
1005 // 32/64 bit helpers
1006 // ----------------------------------------------------------------------------
1007
1008 #ifdef __WIN64__
1009
1010 inline void *wxGetWindowProc(HWND hwnd)
1011 {
1012     return (void *)::GetWindowLongPtr(hwnd, GWLP_WNDPROC);
1013 }
1014
1015 inline void *wxGetWindowUserData(HWND hwnd)
1016 {
1017     return (void *)::GetWindowLongPtr(hwnd, GWLP_USERDATA);
1018 }
1019
1020 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
1021 {
1022     return (WNDPROC)::SetWindowLongPtr(hwnd, GWLP_WNDPROC, (LONG_PTR)func);
1023 }
1024
1025 inline void *wxSetWindowUserData(HWND hwnd, void *data)
1026 {
1027     return (void *)::SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)data);
1028 }
1029
1030 #else // __WIN32__
1031
1032 // note that the casts to LONG_PTR here are required even on 32-bit machines
1033 // for the 64-bit warning mode of later versions of MSVC (C4311/4312)
1034 inline WNDPROC wxGetWindowProc(HWND hwnd)
1035 {
1036     return (WNDPROC)(LONG_PTR)::GetWindowLong(hwnd, GWL_WNDPROC);
1037 }
1038
1039 inline void *wxGetWindowUserData(HWND hwnd)
1040 {
1041     return (void *)(LONG_PTR)::GetWindowLong(hwnd, GWL_USERDATA);
1042 }
1043
1044 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
1045 {
1046     return (WNDPROC)(LONG_PTR)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG_PTR)func);
1047 }
1048
1049 inline void *wxSetWindowUserData(HWND hwnd, void *data)
1050 {
1051     return (void *)(LONG_PTR)::SetWindowLong(hwnd, GWL_USERDATA, (LONG_PTR)data);
1052 }
1053
1054 #endif // __WIN64__/__WIN32__
1055
1056 #endif // wxUSE_GUI
1057
1058 #endif // _WX_PRIVATE_H_