include/wx/msw/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #if wxUSE_PENWIN
 112     WXDLLEXPORT void wxRegisterPenWin();
 113     WXDLLEXPORT void wxCleanUpPenWin();
 114     WXDLLEXPORT void wxEnablePenAppHooks (bool hook);
 115 #endif // wxUSE_PENWIN
 116
 117 #if wxUSE_ITSY_BITSY
 118     #define IBS_HORZCAPTION    0x4000L
 119     #define IBS_VERTCAPTION    0x8000L
 120
 121     UINT    WINAPI ibGetCaptionSize( HWND hWnd  ) ;
 122     UINT    WINAPI ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
 123     LRESULT WINAPI ibDefWindowProc( HWND hWnd, UINT uiMsg, WPARAM wParam, LPARAM lParam ) ;
 124     VOID    WINAPI ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
 125 #endif // wxUSE_ITSY_BITSY
 126
 127 /*
 128  * Decide what window classes we're going to use
 129  * for this combination of CTl3D/FAFA settings
 130  */
 131
 132 #define STATIC_CLASS     wxT("STATIC")
 133 #define STATIC_FLAGS     (SS_LEFT|WS_CHILD|WS_VISIBLE)
 134 #define CHECK_CLASS      wxT("BUTTON")
 135 #define CHECK_FLAGS      (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
 136 #define CHECK_IS_FAFA    FALSE
 137 #define RADIO_CLASS      wxT("BUTTON")
 138 #define RADIO_FLAGS      (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
 139 #define RADIO_SIZE       20
 140 #define RADIO_IS_FAFA    FALSE
 141 #define PURE_WINDOWS
 142 #define GROUP_CLASS      wxT("BUTTON")
 143 #define GROUP_FLAGS      (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
 144
 145 /*
 146 #define BITCHECK_FLAGS   (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
 147 #define BITRADIO_FLAGS   (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
 148 */
 149
 150 // ---------------------------------------------------------------------------
 151 // misc macros
 152 // ---------------------------------------------------------------------------
 153
 154 #define MEANING_CHARACTER '0'
 155 #define DEFAULT_ITEM_WIDTH  100
 156 #define DEFAULT_ITEM_HEIGHT 80
 157
 158 // Scale font to get edit control height
 159 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (3*(cy)/2)
 160 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (cy+8)
 161
 162 // Generic subclass proc, for panel item moving/sizing and intercept
 163 // EDIT control VK_RETURN messages
 164 extern LONG APIENTRY _EXPORT
 165   wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 166
 167 // ---------------------------------------------------------------------------
 168 // useful macros and functions
 169 // ---------------------------------------------------------------------------
 170
 171 // a wrapper macro for ZeroMemory()
 172 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
 173 #define wxZeroMemory(obj)   ::ZeroMemory(&obj, sizeof(obj))
 174 #else
 175 #define wxZeroMemory(obj)   memset((void*) & obj, 0, sizeof(obj))
 176 #endif
 177
 178 // This one is a macro so that it can be tested with #ifdef, it will be
 179 // undefined if it cannot be implemented for a given compiler.
 180 // Vc++, bcc, dmc, ow, mingw, codewarrior (and rsxnt) have _get_osfhandle.
 181 // Cygwin has get_osfhandle. Others are currently unknown, e.g. Salford,
 182 // Intel, Visual Age.
 183 #if defined(__WXWINCE__)
 184     #define wxGetOSFHandle(fd) ((HANDLE)fd)
 185 #elif defined(__CYGWIN__)
 186     #define wxGetOSFHandle(fd) ((HANDLE)get_osfhandle(fd))
 187 #elif defined(__VISUALC__) \
 188    || defined(__BORLANDC__) \
 189    || defined(__DMC__) \
 190    || defined(__WATCOMC__) \
 191    || defined(__MINGW32__) \
 192    || (defined(__MWERKS__) && defined(__MSL__))
 193     #define wxGetOSFHandle(fd) ((HANDLE)_get_osfhandle(fd))
 194 #endif
 195
 196 // close the handle in the class dtor
 197 class AutoHANDLE
 198 {
 199 public:
 200     wxEXPLICIT AutoHANDLE(HANDLE handle) : m_handle(handle) { }
 201
 202     bool IsOk() const { return m_handle != INVALID_HANDLE_VALUE; }
 203     operator HANDLE() const { return m_handle; }
 204
 205     ~AutoHANDLE() { if ( IsOk() ) ::CloseHandle(m_handle); }
 206
 207 protected:
 208     HANDLE m_handle;
 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 // a template to make initializing Windows styructs less painful: it zeroes all
 362 // the struct fields and also sets cbSize member to the correct value (and so
 363 // can be only used with structures which have this member...)
 364 template <class T>
 365 struct WinStruct : public T
 366 {
 367     WinStruct()
 368     {
 369         ::ZeroMemory(this, sizeof(T));
 370
 371         // explicit qualification is required here for this to be valid C++
 372         this->cbSize = sizeof(T);
 373     }
 374 };
 375
 376
 377 // create an instance of this class and use it as the HDC for screen, will
 378 // automatically release the DC going out of scope
 379 class ScreenHDC
 380 {
 381 public:
 382     ScreenHDC() { m_hdc = ::GetDC(NULL);    }
 383    ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
 384
 385     operator HDC() const { return m_hdc; }
 386
 387 private:
 388     HDC m_hdc;
 389
 390     DECLARE_NO_COPY_CLASS(ScreenHDC)
 391 };
 392
 393 // the same as ScreenHDC but for window DCs
 394 class WindowHDC
 395 {
 396 public:
 397     WindowHDC(HWND hwnd) { m_hdc = ::GetDC(m_hwnd = hwnd); }
 398    ~WindowHDC() { ::ReleaseDC(m_hwnd, m_hdc); }
 399
 400     operator HDC() const { return m_hdc; }
 401
 402 private:
 403    HWND m_hwnd;
 404    HDC m_hdc;
 405
 406    DECLARE_NO_COPY_CLASS(WindowHDC)
 407 };
 408
 409 // the same as ScreenHDC but for memory DCs: creates the HDC compatible with
 410 // the given one (screen by default) in ctor and destroys it in dtor
 411 class MemoryHDC
 412 {
 413 public:
 414     MemoryHDC(HDC hdc = 0) { m_hdc = ::CreateCompatibleDC(hdc); }
 415    ~MemoryHDC() { ::DeleteDC(m_hdc); }
 416
 417     operator HDC() const { return m_hdc; }
 418
 419 private:
 420     HDC m_hdc;
 421
 422     DECLARE_NO_COPY_CLASS(MemoryHDC)
 423 };
 424
 425 // a class which selects a GDI object into a DC in its ctor and deselects in
 426 // dtor
 427 class SelectInHDC
 428 {
 429 public:
 430     SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
 431         { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
 432
 433    ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
 434
 435    // return true if the object was successfully selected
 436    operator bool() const { return m_hgdiobj != 0; }
 437
 438 private:
 439    HDC m_hdc;
 440    HGDIOBJ m_hgdiobj;
 441
 442    DECLARE_NO_COPY_CLASS(SelectInHDC)
 443 };
 444
 445 // a class which cleans up any GDI object
 446 class AutoGDIObject
 447 {
 448 protected:
 449     AutoGDIObject(HGDIOBJ gdiobj) : m_gdiobj(gdiobj) { }
 450     ~AutoGDIObject() { if ( m_gdiobj ) ::DeleteObject(m_gdiobj); }
 451
 452     HGDIOBJ GetObject() const { return m_gdiobj; }
 453
 454 private:
 455     HGDIOBJ m_gdiobj;
 456 };
 457
 458 // TODO: all this asks for using a AutoHandler<T, CreateFunc> template...
 459
 460 // a class for temporary pens
 461 class AutoHBRUSH : private AutoGDIObject
 462 {
 463 public:
 464     AutoHBRUSH(COLORREF col)
 465         : AutoGDIObject(::CreateSolidBrush(col)) { }
 466
 467     operator HBRUSH() const { return (HBRUSH)GetObject(); }
 468 };
 469
 470 // a class for temporary pens
 471 class AutoHPEN : private AutoGDIObject
 472 {
 473 public:
 474     AutoHPEN(COLORREF col)
 475         : AutoGDIObject(::CreatePen(PS_SOLID, 0, col)) { }
 476
 477     operator HPEN() const { return (HPEN)GetObject(); }
 478 };
 479
 480 // classes for temporary bitmaps
 481 class AutoHBITMAP : private AutoGDIObject
 482 {
 483 public:
 484     AutoHBITMAP(HBITMAP hbmp) : AutoGDIObject(hbmp) { }
 485
 486     operator HBITMAP() const { return (HBITMAP)GetObject(); }
 487 };
 488
 489 class CompatibleBitmap : public AutoHBITMAP
 490 {
 491 public:
 492     CompatibleBitmap(HDC hdc, int w, int h)
 493         : AutoHBITMAP(::CreateCompatibleBitmap(hdc, w, h))
 494     {
 495     }
 496 };
 497
 498 class MonoBitmap : public AutoHBITMAP
 499 {
 500 public:
 501     MonoBitmap(int w, int h)
 502         : AutoHBITMAP(::CreateBitmap(w, h, 1, 1, 0))
 503     {
 504     }
 505 };
 506
 507 // class automatically destroys the region object
 508 class AutoHRGN : private AutoGDIObject
 509 {
 510 public:
 511     AutoHRGN(HRGN hrgn) : AutoGDIObject(hrgn) { }
 512
 513     operator HRGN() const { return (HRGN)GetObject(); }
 514 };
 515
 516 // class sets the specified clipping region during its life time
 517 class HDCClipper
 518 {
 519 public:
 520     HDCClipper(HDC hdc, HRGN hrgn)
 521         : m_hdc(hdc)
 522     {
 523         if ( !::SelectClipRgn(hdc, hrgn) )
 524             wxLogLastError(_T("SelectClipRgn"));
 525     }
 526
 527     ~HDCClipper()
 528     {
 529         ::SelectClipRgn(m_hdc, NULL);
 530     }
 531
 532 private:
 533     HDC m_hdc;
 534
 535     DECLARE_NO_COPY_CLASS(HDCClipper)
 536 };
 537
 538 // smart buffeer using GlobalAlloc/GlobalFree()
 539 class GlobalPtr
 540 {
 541 public:
 542     // allocates a block of given size
 543     GlobalPtr(size_t size, unsigned flags = GMEM_MOVEABLE)
 544     {
 545         m_hGlobal = ::GlobalAlloc(flags, size);
 546         if ( !m_hGlobal )
 547             wxLogLastError(_T("GlobalAlloc"));
 548     }
 549
 550     ~GlobalPtr()
 551     {
 552         if ( m_hGlobal && ::GlobalFree(m_hGlobal) )
 553             wxLogLastError(_T("GlobalFree"));
 554     }
 555
 556     // implicit conversion
 557     operator HGLOBAL() const { return m_hGlobal; }
 558
 559 private:
 560     HGLOBAL m_hGlobal;
 561
 562     DECLARE_NO_COPY_CLASS(GlobalPtr)
 563 };
 564
 565 // when working with global pointers (which is unfortunately still necessary
 566 // sometimes, e.g. for clipboard) it is important to unlock them exactly as
 567 // many times as we lock them which just asks for using a "smart lock" class
 568 class GlobalPtrLock
 569 {
 570 public:
 571     GlobalPtrLock(HGLOBAL hGlobal) : m_hGlobal(hGlobal)
 572     {
 573         m_ptr = GlobalLock(hGlobal);
 574         if ( !m_ptr )
 575         {
 576             wxLogLastError(_T("GlobalLock"));
 577         }
 578     }
 579
 580     ~GlobalPtrLock()
 581     {
 582         if ( !GlobalUnlock(m_hGlobal) )
 583         {
 584 #ifdef __WXDEBUG__
 585             // this might happen simply because the block became unlocked
 586             DWORD dwLastError = ::GetLastError();
 587             if ( dwLastError != NO_ERROR )
 588             {
 589                 wxLogApiError(_T("GlobalUnlock"), dwLastError);
 590             }
 591 #endif // __WXDEBUG__
 592         }
 593     }
 594
 595     operator void *() const { return m_ptr; }
 596
 597 private:
 598     HGLOBAL m_hGlobal;
 599     void *m_ptr;
 600
 601     DECLARE_NO_COPY_CLASS(GlobalPtrLock)
 602 };
 603
 604 // register the class when it is first needed and unregister it in dtor
 605 class ClassRegistrar
 606 {
 607 public:
 608     // ctor doesn't register the class, call Initialize() for this
 609     ClassRegistrar() { m_registered = -1; }
 610
 611     // return true if the class is already registered
 612     bool IsInitialized() const { return m_registered != -1; }
 613
 614     // return true if the class had been already registered
 615     bool IsRegistered() const { return m_registered == 1; }
 616
 617     // try to register the class if not done yet, return true on success
 618     bool Register(const WNDCLASS& wc)
 619     {
 620         // we should only be called if we hadn't been initialized yet
 621         wxASSERT_MSG( m_registered == -1,
 622                         _T("calling ClassRegistrar::Register() twice?") );
 623
 624         m_registered = ::RegisterClass(&wc) ? 1 : 0;
 625         if ( !IsRegistered() )
 626         {
 627             wxLogLastError(_T("RegisterClassEx()"));
 628         }
 629         else
 630         {
 631             m_clsname = wc.lpszClassName;
 632         }
 633
 634         return m_registered == 1;
 635     }
 636
 637     // get the name of the registered class (returns empty string if not
 638     // registered)
 639     const wxString& GetName() const { return m_clsname; }
 640
 641     // unregister the class if it had been registered
 642     ~ClassRegistrar()
 643     {
 644         if ( IsRegistered() )
 645         {
 646             if ( !::UnregisterClass(m_clsname, wxhInstance) )
 647             {
 648                 wxLogLastError(_T("UnregisterClass"));
 649             }
 650         }
 651     }
 652
 653 private:
 654     // initial value is -1 which means that we hadn't tried registering the
 655     // class yet, it becomes true or false (1 or 0) when Initialize() is called
 656     int m_registered;
 657
 658     // the name of the class, only non empty if it had been registered
 659     wxString m_clsname;
 660 };
 661
 662 // ---------------------------------------------------------------------------
 663 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
 664 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
 665 // an argument which should be a pointer or reference to the object of the
 666 // corresponding class (this depends on the macro)
 667 // ---------------------------------------------------------------------------
 668
 669 #define GetHwnd()               ((HWND)GetHWND())
 670 #define GetHwndOf(win)          ((HWND)((win)->GetHWND()))
 671 // old name
 672 #define GetWinHwnd              GetHwndOf
 673
 674 #define GetHdc()                ((HDC)GetHDC())
 675 #define GetHdcOf(dc)            ((HDC)(dc).GetHDC())
 676
 677 #define GetHbitmap()            ((HBITMAP)GetHBITMAP())
 678 #define GetHbitmapOf(bmp)       ((HBITMAP)(bmp).GetHBITMAP())
 679
 680 #define GetHicon()              ((HICON)GetHICON())
 681 #define GetHiconOf(icon)        ((HICON)(icon).GetHICON())
 682
 683 #define GetHaccel()             ((HACCEL)GetHACCEL())
 684 #define GetHaccelOf(table)      ((HACCEL)((table).GetHACCEL()))
 685
 686 #define GetHbrush()             ((HBRUSH)GetResourceHandle())
 687 #define GetHbrushOf(brush)      ((HBRUSH)(brush).GetResourceHandle())
 688
 689 #define GetHmenu()              ((HMENU)GetHMenu())
 690 #define GetHmenuOf(menu)        ((HMENU)menu->GetHMenu())
 691
 692 #define GetHcursor()            ((HCURSOR)GetHCURSOR())
 693 #define GetHcursorOf(cursor)    ((HCURSOR)(cursor).GetHCURSOR())
 694
 695 #define GetHfont()              ((HFONT)GetHFONT())
 696 #define GetHfontOf(font)        ((HFONT)(font).GetHFONT())
 697
 698 #define GetHimagelist()         ((HIMAGELIST)GetHIMAGELIST())
 699 #define GetHimagelistOf(imgl)   ((HIMAGELIST)imgl->GetHIMAGELIST())
 700
 701 #define GetHpalette()           ((HPALETTE)GetHPALETTE())
 702 #define GetHpaletteOf(pal)      ((HPALETTE)(pal).GetHPALETTE())
 703
 704 #define GetHpen()               ((HPEN)GetResourceHandle())
 705 #define GetHpenOf(pen)          ((HPEN)(pen).GetResourceHandle())
 706
 707 #define GetHrgn()               ((HRGN)GetHRGN())
 708 #define GetHrgnOf(rgn)          ((HRGN)(rgn).GetHRGN())
 709
 710 #endif // wxUSE_GUI
 711
 712 // ---------------------------------------------------------------------------
 713 // global functions
 714 // ---------------------------------------------------------------------------
 715
 716 extern "C"
 717 {
 718     WXDLLIMPEXP_BASE HINSTANCE wxGetInstance();
 719 }
 720
 721 WXDLLIMPEXP_BASE void wxSetInstance(HINSTANCE hInst);
 722
 723 // return the full path of the given module
 724 inline wxString wxGetFullModuleName(HMODULE hmod)
 725 {
 726     wxString fullname;
 727     if ( !::GetModuleFileName
 728             (
 729                 hmod,
 730                 wxStringBuffer(fullname, MAX_PATH),
 731                 MAX_PATH
 732             ) )
 733     {
 734         wxLogLastError(_T("GetModuleFileName"));
 735     }
 736
 737     return fullname;
 738 }
 739
 740 // return the full path of the program file
 741 inline wxString wxGetFullModuleName()
 742 {
 743     return wxGetFullModuleName((HMODULE)wxGetInstance());
 744 }
 745
 746 // return the run-time version of the OS in a format similar to
 747 // WINVER/_WIN32_WINNT compile-time macros:
 748 //
 749 //      0x0300      Windows NT 3.51
 750 //      0x0400      Windows 95, NT4
 751 //      0x0410      Windows 98
 752 //      0x0500      Windows ME, 2000
 753 //      0x0501      Windows XP
 754 //      0x0502      Windows 2003
 755 //      0x0600      Longhorn
 756 //
 757 // for the other Windows versions 0 is currently returned
 758 enum wxWinVersion
 759 {
 760     wxWinVersion_Unknown = 0,
 761
 762     wxWinVersion_3 = 0x0300,
 763     wxWinVersion_NT3 = wxWinVersion_3,
 764
 765     wxWinVersion_4 = 0x0400,
 766     wxWinVersion_95 = wxWinVersion_4,
 767     wxWinVersion_NT4 = wxWinVersion_4,
 768     wxWinVersion_98 = 0x0410,
 769
 770     wxWinVersion_5 = 0x0500,
 771     wxWinVersion_ME = wxWinVersion_5,
 772     wxWinVersion_NT5 = wxWinVersion_5,
 773     wxWinVersion_2000 = wxWinVersion_5,
 774     wxWinVersion_XP = 0x0501,
 775     wxWinVersion_2003 = 0x0502,
 776
 777     wxWinVersion_6 = 0x0600,
 778     wxWinVersion_NT6 = 0x0600
 779 };
 780
 781 WXDLLIMPEXP_BASE wxWinVersion wxGetWinVersion();
 782
 783 #if wxUSE_GUI
 784
 785 // cursor stuff
 786 extern HCURSOR wxGetCurrentBusyCursor();    // from msw/utils.cpp
 787 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
 788
 789 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont& the_font);
 790 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
 791 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
 792 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
 793
 794 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
 795 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
 796
 797 // Find maximum size of window/rectangle
 798 extern WXDLLEXPORT void wxFindMaxSize(WXHWND hwnd, RECT *rect);
 799
 800 // Safely get the window text (i.e. without using fixed size buffer)
 801 extern WXDLLEXPORT wxString wxGetWindowText(WXHWND hWnd);
 802
 803 // get the window class name
 804 extern WXDLLEXPORT wxString wxGetWindowClass(WXHWND hWnd);
 805
 806 // get the window id (should be unsigned, hence this is not wxWindowID which
 807 // is, for mainly historical reasons, signed)
 808 extern WXDLLEXPORT WXWORD wxGetWindowId(WXHWND hWnd);
 809
 810 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are
 811 // different
 812 extern WXDLLEXPORT bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
 813
 814 // Does this window style specify any border?
 815 inline bool wxStyleHasBorder(long style)
 816 {
 817     return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
 818                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 819 }
 820
 821 // Deferred window moving
 822 bool wxMoveWindowDeferred(HDWP& hdwp, wxWindowBase* win, HWND hWnd, int x, int y, int width, int height);
 823
 824 // ----------------------------------------------------------------------------
 825 // functions mapping HWND to wxWindow
 826 // ----------------------------------------------------------------------------
 827
 828 // this function simply checks whether the given hWnd corresponds to a wxWindow
 829 // and returns either that window if it does or NULL otherwise
 830 extern WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
 831
 832 // find the window for HWND which is part of some wxWindow, i.e. unlike
 833 // wxFindWinFromHandle() above it will also work for "sub controls" of a
 834 // wxWindow.
 835 //
 836 // returns the wxWindow corresponding to the given HWND or NULL.
 837 extern WXDLLEXPORT wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
 838
 839 // Get the size of an icon
 840 extern WXDLLEXPORT wxSize wxGetHiconSize(HICON hicon);
 841
 842 // Lines are drawn differently for WinCE and regular WIN32
 843 WXDLLEXPORT void wxDrawLine(HDC hdc, int x1, int y1, int x2, int y2);
 844
 845 // fill the client rect of the given window on the provided dc using this brush
 846 inline void wxFillRect(HWND hwnd, HDC hdc, HBRUSH hbr)
 847 {
 848     RECT rc;
 849     ::GetClientRect(hwnd, &rc);
 850     ::FillRect(hdc, &rc, hbr);
 851 }
 852
 853 // ----------------------------------------------------------------------------
 854 // 32/64 bit helpers
 855 // ----------------------------------------------------------------------------
 856
 857 #ifdef __WIN64__
 858
 859 inline void *wxGetWindowProc(HWND hwnd)
 860 {
 861     return (void *)::GetWindowLongPtr(hwnd, GWLP_WNDPROC);
 862 }
 863
 864 inline void *wxGetWindowUserData(HWND hwnd)
 865 {
 866     return (void *)::GetWindowLongPtr(hwnd, GWLP_USERDATA);
 867 }
 868
 869 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
 870 {
 871     return (WNDPROC)::SetWindowLongPtr(hwnd, GWLP_WNDPROC, (LONG_PTR)func);
 872 }
 873
 874 inline void *wxSetWindowUserData(HWND hwnd, void *data)
 875 {
 876     return (void *)::SetWindowLongPtr(hwnd, GWLP_USERDATA, (LONG_PTR)data);
 877 }
 878
 879 #else // __WIN32__
 880
 881 #ifdef __VISUALC__
 882     // strangely enough, VC++ 7.1 gives warnings about 32 -> 64 bit conversions
 883     // in the functions below, even in spite of the explicit casts
 884     #pragma warning(disable:4311)
 885     #pragma warning(disable:4312)
 886 #endif
 887
 888 inline void *wxGetWindowProc(HWND hwnd)
 889 {
 890     return (void *)::GetWindowLong(hwnd, GWL_WNDPROC);
 891 }
 892
 893 inline void *wxGetWindowUserData(HWND hwnd)
 894 {
 895     return (void *)::GetWindowLong(hwnd, GWL_USERDATA);
 896 }
 897
 898 inline WNDPROC wxSetWindowProc(HWND hwnd, WNDPROC func)
 899 {
 900     return (WNDPROC)::SetWindowLong(hwnd, GWL_WNDPROC, (LONG)func);
 901 }
 902
 903 inline void *wxSetWindowUserData(HWND hwnd, void *data)
 904 {
 905     return (void *)::SetWindowLong(hwnd, GWL_USERDATA, (LONG)data);
 906 }
 907
 908 #ifdef __VISUALC__
 909     #pragma warning(default:4311)
 910     #pragma warning(default:4312)
 911 #endif
 912
 913 #endif // __WIN64__/__WIN32__
 914
 915 #endif // wxUSE_GUI
 916
 917 #endif // _WX_PRIVATE_H_