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