include/wx/msw/private.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        private.h
   3 // Purpose:     Private declarations: as this header is only included by
   4 //              wxWindows 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 #ifndef STRICT
  18     #define STRICT 1
  19 #endif
  20
  21 #include <windows.h>
  22
  23 #ifdef __WXMICROWIN__
  24     // Extra prototypes and symbols not defined by MicroWindows
  25     #include "wx/msw/microwin.h"
  26 #endif
  27
  28 // undefine conflicting symbols which were defined in windows.h
  29 #include "wx/msw/winundef.h"
  30
  31 // Include fixes for MSLU:
  32 #include "wx/msw/mslu.h"
  33
  34 #include "wx/log.h"
  35
  36 class WXDLLEXPORT wxFont;
  37 class WXDLLEXPORT wxWindow;
  38
  39 // ---------------------------------------------------------------------------
  40 // private constants
  41 // ---------------------------------------------------------------------------
  42
  43 // Conversion
  44 static const double METRIC_CONVERSION_CONSTANT = 0.0393700787;
  45
  46 // Scaling factors for various unit conversions
  47 static const double mm2inches = (METRIC_CONVERSION_CONSTANT);
  48 static const double inches2mm = (1/METRIC_CONVERSION_CONSTANT);
  49
  50 static const double mm2twips = (METRIC_CONVERSION_CONSTANT*1440);
  51 static const double twips2mm = (1/(METRIC_CONVERSION_CONSTANT*1440));
  52
  53 static const double mm2pt = (METRIC_CONVERSION_CONSTANT*72);
  54 static const double pt2mm = (1/(METRIC_CONVERSION_CONSTANT*72));
  55
  56 // ---------------------------------------------------------------------------
  57 // standard icons from the resources
  58 // ---------------------------------------------------------------------------
  59
  60 #if wxUSE_GUI
  61
  62 WXDLLEXPORT_DATA(extern HICON) wxSTD_FRAME_ICON;
  63 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDIPARENTFRAME_ICON;
  64 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDICHILDFRAME_ICON;
  65 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_FRAME_ICON;
  66 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
  67 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDICHILDFRAME_ICON;
  68 WXDLLEXPORT_DATA(extern HFONT) wxSTATUS_LINE_FONT;
  69
  70 #endif // wxUSE_GUI
  71
  72 // ---------------------------------------------------------------------------
  73 // define things missing from some compilers' headers
  74 // ---------------------------------------------------------------------------
  75
  76 #if 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 #define CASTWNDPROC (WndProcCast)
  91
  92 // ---------------------------------------------------------------------------
  93 // some stuff for old Windows versions (FIXME: what does it do here??)
  94 // ---------------------------------------------------------------------------
  95
  96 #if !defined(APIENTRY)  // NT defines APIENTRY, 3.x not
  97     #define APIENTRY FAR PASCAL
  98 #endif
  99
 100 #ifdef __WIN32__
 101     #define _EXPORT
 102 #else
 103     #define _EXPORT _export
 104 #endif
 105
 106 #ifndef __WIN32__
 107     typedef signed short int SHORT;
 108 #endif
 109
 110 #if !defined(__WIN32__)  // 3.x uses FARPROC for dialogs
 111 #ifndef STRICT
 112     #define DLGPROC FARPROC
 113 #endif
 114 #endif
 115
 116 #if wxUSE_PENWIN
 117     WXDLLEXPORT void wxRegisterPenWin();
 118     WXDLLEXPORT void wxCleanUpPenWin();
 119     WXDLLEXPORT void wxEnablePenAppHooks (bool hook);
 120 #endif // wxUSE_PENWIN
 121
 122 #if wxUSE_ITSY_BITSY
 123     #define IBS_HORZCAPTION    0x4000L
 124     #define IBS_VERTCAPTION    0x8000L
 125
 126     UINT    WINAPI ibGetCaptionSize( HWND hWnd  ) ;
 127     UINT    WINAPI ibSetCaptionSize( HWND hWnd, UINT nSize ) ;
 128     LRESULT WINAPI ibDefWindowProc( HWND hWnd, UINT uiMsg, WPARAM wParam, LPARAM lParam ) ;
 129     VOID    WINAPI ibAdjustWindowRect( HWND hWnd, LPRECT lprc ) ;
 130 #endif // wxUSE_ITSY_BITSY
 131
 132 #if wxUSE_CTL3D
 133     #include "wx/msw/ctl3d/ctl3d.h"
 134 #endif // wxUSE_CTL3D
 135
 136 /*
 137  * Decide what window classes we're going to use
 138  * for this combination of CTl3D/FAFA settings
 139  */
 140
 141 #define STATIC_CLASS     wxT("STATIC")
 142 #define STATIC_FLAGS     (SS_LEFT|WS_CHILD|WS_VISIBLE)
 143 #define CHECK_CLASS      wxT("BUTTON")
 144 #define CHECK_FLAGS      (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
 145 #define CHECK_IS_FAFA   FALSE
 146 #define RADIO_CLASS      wxT("BUTTON")
 147 #define RADIO_FLAGS      (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
 148 #define RADIO_SIZE       20
 149 #define RADIO_IS_FAFA   FALSE
 150 #define PURE_WINDOWS
 151 #define GROUP_CLASS      wxT("BUTTON")
 152 #define GROUP_FLAGS      (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
 153
 154 /*
 155 #define BITCHECK_FLAGS   (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
 156 #define BITRADIO_FLAGS   (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
 157 */
 158
 159 // ---------------------------------------------------------------------------
 160 // misc macros
 161 // ---------------------------------------------------------------------------
 162
 163 #define MEANING_CHARACTER '0'
 164 #define DEFAULT_ITEM_WIDTH  100
 165 #define DEFAULT_ITEM_HEIGHT 80
 166
 167 // Scale font to get edit control height
 168 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (3*(cy)/2)
 169 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (cy+8)
 170
 171 // Generic subclass proc, for panel item moving/sizing and intercept
 172 // EDIT control VK_RETURN messages
 173 extern LONG APIENTRY _EXPORT
 174   wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 175
 176 // ---------------------------------------------------------------------------
 177 // constants which might miss from some compilers' headers
 178 // ---------------------------------------------------------------------------
 179
 180 #if !defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
 181     #define WS_EX_CLIENTEDGE 0
 182 #endif
 183
 184 #if defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
 185     #define WS_EX_CLIENTEDGE 0x00000200L
 186 #endif
 187
 188 #ifndef ENDSESSION_LOGOFF
 189     #define ENDSESSION_LOGOFF    0x80000000
 190 #endif
 191
 192 // ---------------------------------------------------------------------------
 193 // useful macros and functions
 194 // ---------------------------------------------------------------------------
 195
 196 // a wrapper macro for ZeroMemory()
 197 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
 198 #define wxZeroMemory(obj)   ::ZeroMemory(&obj, sizeof(obj))
 199 #else
 200 #define wxZeroMemory(obj)   memset((void*) & obj, 0, sizeof(obj))
 201 #endif
 202
 203 #if wxUSE_GUI
 204
 205 #include <wx/gdicmn.h>
 206
 207 // make conversion from wxColour and COLORREF a bit less painful
 208 inline COLORREF wxColourToRGB(const wxColour& c)
 209 {
 210     return RGB(c.Red(), c.Green(), c.Blue());
 211 }
 212
 213 inline COLORREF wxColourToPalRGB(const wxColour& c)
 214 {
 215     return PALETTERGB(c.Red(), c.Green(), c.Blue());
 216 }
 217
 218 inline wxColour wxRGBToColour(COLORREF rgb)
 219 {
 220     return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 221 }
 222
 223 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
 224 {
 225     c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 226 }
 227
 228 // get the standard colour map for some standard colours - see comment in this
 229 // function to understand why is it needed and when should it be used
 230 //
 231 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
 232 // might be not included/available) array of size wxSTD_COLOUR_MAX
 233 //
 234 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
 235 //     resources as well: it must have the same number of pixels!
 236 enum wxSTD_COLOUR
 237 {
 238     wxSTD_COL_BTNTEXT,
 239     wxSTD_COL_BTNSHADOW,
 240     wxSTD_COL_BTNFACE,
 241     wxSTD_COL_BTNHIGHLIGHT,
 242     wxSTD_COL_MAX,
 243 };
 244
 245 struct WXDLLEXPORT wxCOLORMAP
 246 {
 247     COLORREF from, to;
 248 };
 249
 250 // this function is implemented in src/msw/window.cpp
 251 extern wxCOLORMAP *wxGetStdColourMap();
 252
 253 // copy Windows RECT to our wxRect
 254 inline void wxCopyRECTToRect(const RECT& r, wxRect& rect)
 255 {
 256     rect.y = r.top;
 257     rect.x = r.left;
 258     rect.width = r.right - r.left;
 259     rect.height = r.bottom - r.top;
 260 }
 261
 262 // translations between HIMETRIC units (which OLE likes) and pixels (which are
 263 // liked by all the others) - implemented in msw/utilsexc.cpp
 264 extern void HIMETRICToPixel(LONG *x, LONG *y);
 265 extern void PixelToHIMETRIC(LONG *x, LONG *y);
 266
 267 // Windows convention of the mask is opposed to the wxWindows one, so we need
 268 // to invert the mask each time we pass one/get one to/from Windows
 269 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
 270
 271 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
 272 // will fail on system with multiple monitors where the coords may be negative
 273 //
 274 // these macros are standard now (Win98) but some older headers don't have them
 275 #ifndef GET_X_LPARAM
 276     #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
 277     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 278 #endif // GET_X_LPARAM
 279
 280 // get the current state of SHIFT/CTRL keys
 281 inline bool wxIsShiftDown()
 282 {
 283     return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
 284 }
 285
 286 inline bool wxIsCtrlDown()
 287 {
 288     return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
 289 }
 290
 291 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
 292 // for Win32
 293 inline RECT wxGetWindowRect(HWND hwnd)
 294 {
 295     RECT rect;
 296 #ifdef __WIN16__
 297     ::GetWindowRect(hwnd, &rect);
 298 #else // Win32
 299     if ( !::GetWindowRect(hwnd, &rect) )
 300     {
 301         wxLogLastError(_T("GetWindowRect"));
 302     }
 303 #endif // Win16/32
 304
 305     return rect;
 306 }
 307
 308 inline RECT wxGetClientRect(HWND hwnd)
 309 {
 310     RECT rect;
 311 #ifdef __WIN16__
 312     ::GetClientRect(hwnd, &rect);
 313 #else // Win32
 314     if ( !::GetClientRect(hwnd, &rect) )
 315     {
 316         wxLogLastError(_T("GetClientRect"));
 317     }
 318 #endif // Win16/32
 319
 320     return rect;
 321 }
 322
 323 // ---------------------------------------------------------------------------
 324 // small helper classes
 325 // ---------------------------------------------------------------------------
 326
 327 // create an instance of this class and use it as the HDC for screen, will
 328 // automatically release the DC going out of scope
 329 class ScreenHDC
 330 {
 331 public:
 332     ScreenHDC() { m_hdc = ::GetDC(NULL);    }
 333    ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
 334
 335     operator HDC() const { return m_hdc; }
 336
 337 private:
 338     HDC m_hdc;
 339 };
 340
 341 // the same as ScreenHDC but for memory DCs: creates the HDC in ctor and
 342 // destroys it in dtor
 343 class MemoryHDC
 344 {
 345 public:
 346     MemoryHDC() { m_hdc = ::CreateCompatibleDC(NULL); }
 347    ~MemoryHDC() { ::DeleteObject(m_hdc);              }
 348
 349     operator HDC() const { return m_hdc; }
 350
 351 private:
 352     HDC m_hdc;
 353 };
 354
 355 // a class which selects a GDI object into a DC in its ctor and deselects in
 356 // dtor
 357 class SelectInHDC
 358 {
 359 public:
 360     SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
 361         { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
 362
 363    ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
 364
 365    // return true if the object was successfully selected
 366    operator bool() const { return m_hgdiobj != 0; }
 367
 368 private:
 369    HDC m_hdc;
 370    HGDIOBJ m_hgdiobj;
 371 };
 372
 373 // ---------------------------------------------------------------------------
 374 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
 375 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
 376 // an argument which should be a pointer or reference to the object of the
 377 // corresponding class (this depends on the macro)
 378 // ---------------------------------------------------------------------------
 379
 380 #define GetHwnd()               ((HWND)GetHWND())
 381 #define GetHwndOf(win)          ((HWND)((win)->GetHWND()))
 382 // old name
 383 #define GetWinHwnd              GetHwndOf
 384
 385 #define GetHdc()                ((HDC)GetHDC())
 386 #define GetHdcOf(dc)            ((HDC)(dc).GetHDC())
 387
 388 #define GetHbitmap()            ((HBITMAP)GetHBITMAP())
 389 #define GetHbitmapOf(bmp)       ((HBITMAP)(bmp).GetHBITMAP())
 390
 391 #define GetHicon()              ((HICON)GetHICON())
 392 #define GetHiconOf(icon)        ((HICON)(icon).GetHICON())
 393
 394 #define GetHaccel()             ((HACCEL)GetHACCEL())
 395 #define GetHaccelOf(table)      ((HACCEL)((table).GetHACCEL()))
 396
 397 #define GetHmenu()              ((HMENU)GetHMenu())
 398 #define GetHmenuOf(menu)        ((HMENU)menu->GetHMenu())
 399
 400 #define GetHcursor()            ((HCURSOR)GetHCURSOR())
 401 #define GetHcursorOf(cursor)    ((HCURSOR)(cursor).GetHCURSOR())
 402
 403 #define GetHfont()              ((HFONT)GetHFONT())
 404 #define GetHfontOf(font)        ((HFONT)(font).GetHFONT())
 405
 406 #define GetHpalette()           ((HPALETTE)GetHPALETTE())
 407 #define GetHpaletteOf(pal)      ((HPALETTE)(pal).GetHPALETTE())
 408
 409 #define GetHrgn()               ((HRGN)GetHRGN())
 410 #define GetHrgnOf(rgn)          ((HRGN)(rgn).GetHRGN())
 411
 412 #endif // wxUSE_GUI
 413
 414 // ---------------------------------------------------------------------------
 415 // global data
 416 // ---------------------------------------------------------------------------
 417
 418 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 419
 420 WXDLLEXPORT_DATA(extern HINSTANCE) wxhInstance;
 421
 422 // ---------------------------------------------------------------------------
 423 // global functions
 424 // ---------------------------------------------------------------------------
 425
 426 extern "C"
 427 {
 428     WXDLLEXPORT HINSTANCE wxGetInstance();
 429 }
 430
 431 WXDLLEXPORT void wxSetInstance(HINSTANCE hInst);
 432
 433 #if wxUSE_GUI
 434
 435 // cursor stuff
 436 extern HCURSOR wxGetCurrentBusyCursor();    // from msw/utils.cpp
 437 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
 438
 439 WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
 440
 441 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont *the_font);
 442 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
 443 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
 444 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
 445
 446 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
 447 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
 448
 449 // Find maximum size of window/rectangle
 450 WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
 451
 452 WXDLLEXPORT wxWindow* wxFindControlFromHandle(WXHWND hWnd);
 453 WXDLLEXPORT void wxAddControlHandle(WXHWND hWnd, wxWindow *item);
 454
 455 // Safely get the window text (i.e. without using fixed size buffer)
 456 WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
 457
 458 // get the window class name
 459 WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
 460
 461 // get the window id (should be unsigned, hence this is not wxWindowID which
 462 // is, for mainly historical reasons, signed)
 463 WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
 464
 465 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are different
 466 extern bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
 467
 468 // Does this window style specify any border?
 469 inline bool wxStyleHasBorder(long style)
 470 {
 471     return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
 472                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 473 }
 474
 475 // find the window for HWND which is part of some wxWindow, returns just the
 476 // corresponding wxWindow for HWND which just is one
 477 //
 478 // may return NULL
 479 extern wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
 480
 481 #endif // wxUSE_GUI
 482
 483 #endif
 484     // _WX_PRIVATE_H_