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