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 PALETTERGB(c.Red(), c.Green(), c.Blue());
 211 }
 212
 213 inline wxColour wxRGBToColour(COLORREF rgb)
 214 {
 215     return wxColour(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 216 }
 217
 218 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
 219 {
 220     c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 221 }
 222
 223 // get the standard colour map for some standard colours - see comment in this
 224 // function to understand why is it needed and when should it be used
 225 //
 226 // it returns a wxCOLORMAP (can't use COLORMAP itself here as comctl32.dll
 227 // might be not included/available) array of size wxSTD_COLOUR_MAX
 228 //
 229 // NB: if you change these colours, update wxBITMAP_STD_COLOURS in the
 230 //     resources as well: it must have the same number of pixels!
 231 enum wxSTD_COLOUR
 232 {
 233     wxSTD_COL_BTNTEXT,
 234     wxSTD_COL_BTNSHADOW,
 235     wxSTD_COL_BTNFACE,
 236     wxSTD_COL_BTNHIGHLIGHT,
 237     wxSTD_COL_MAX,
 238 };
 239
 240 struct WXDLLEXPORT wxCOLORMAP
 241 {
 242     COLORREF from, to;
 243 };
 244
 245 // this function is implemented in src/msw/window.cpp
 246 extern wxCOLORMAP *wxGetStdColourMap();
 247
 248 // copy Windows RECT to our wxRect
 249 inline void wxCopyRECTToRect(const RECT& r, wxRect& rect)
 250 {
 251     rect.y = r.top;
 252     rect.x = r.left;
 253     rect.width = r.right - r.left;
 254     rect.height = r.bottom - r.top;
 255 }
 256
 257 // translations between HIMETRIC units (which OLE likes) and pixels (which are
 258 // liked by all the others) - implemented in msw/utilsexc.cpp
 259 extern void HIMETRICToPixel(LONG *x, LONG *y);
 260 extern void PixelToHIMETRIC(LONG *x, LONG *y);
 261
 262 // Windows convention of the mask is opposed to the wxWindows one, so we need
 263 // to invert the mask each time we pass one/get one to/from Windows
 264 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
 265
 266 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
 267 // will fail on system with multiple monitors where the coords may be negative
 268 //
 269 // these macros are standard now (Win98) but some older headers don't have them
 270 #ifndef GET_X_LPARAM
 271     #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
 272     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 273 #endif // GET_X_LPARAM
 274
 275 // get the current state of SHIFT/CTRL keys
 276 inline bool wxIsShiftDown()
 277 {
 278     return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
 279 }
 280
 281 inline bool wxIsCtrlDown()
 282 {
 283     return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
 284 }
 285
 286 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
 287 // for Win32
 288 inline RECT wxGetWindowRect(HWND hwnd)
 289 {
 290     RECT rect;
 291 #ifdef __WIN16__
 292     ::GetWindowRect(hwnd, &rect);
 293 #else // Win32
 294     if ( !::GetWindowRect(hwnd, &rect) )
 295     {
 296         wxLogLastError(_T("GetWindowRect"));
 297     }
 298 #endif // Win16/32
 299
 300     return rect;
 301 }
 302
 303 inline RECT wxGetClientRect(HWND hwnd)
 304 {
 305     RECT rect;
 306 #ifdef __WIN16__
 307     ::GetClientRect(hwnd, &rect);
 308 #else // Win32
 309     if ( !::GetClientRect(hwnd, &rect) )
 310     {
 311         wxLogLastError(_T("GetClientRect"));
 312     }
 313 #endif // Win16/32
 314
 315     return rect;
 316 }
 317
 318 // ---------------------------------------------------------------------------
 319 // small helper classes
 320 // ---------------------------------------------------------------------------
 321
 322 // create an instance of this class and use it as the HDC for screen, will
 323 // automatically release the DC going out of scope
 324 class ScreenHDC
 325 {
 326 public:
 327     ScreenHDC() { m_hdc = ::GetDC(NULL);    }
 328    ~ScreenHDC() { ::ReleaseDC(NULL, m_hdc); }
 329
 330     operator HDC() const { return m_hdc; }
 331
 332 private:
 333     HDC m_hdc;
 334 };
 335
 336 // the same as ScreenHDC but for memory DCs: creates the HDC in ctor and
 337 // destroys it in dtor
 338 class MemoryHDC
 339 {
 340 public:
 341     MemoryHDC() { m_hdc = ::CreateCompatibleDC(NULL); }
 342    ~MemoryHDC() { ::DeleteObject(m_hdc);              }
 343
 344     operator HDC() const { return m_hdc; }
 345
 346 private:
 347     HDC m_hdc;
 348 };
 349
 350 // a class which selects a GDI object into a DC in its ctor and deselects in
 351 // dtor
 352 class SelectInHDC
 353 {
 354 public:
 355     SelectInHDC(HDC hdc, HGDIOBJ hgdiobj) : m_hdc(hdc)
 356         { m_hgdiobj = ::SelectObject(hdc, hgdiobj); }
 357
 358    ~SelectInHDC() { ::SelectObject(m_hdc, m_hgdiobj); }
 359
 360    // return true if the object was successfully selected
 361    operator bool() const { return m_hgdiobj != 0; }
 362
 363 private:
 364    HDC m_hdc;
 365    HGDIOBJ m_hgdiobj;
 366 };
 367
 368 // ---------------------------------------------------------------------------
 369 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
 370 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
 371 // an argument which should be a pointer or reference to the object of the
 372 // corresponding class (this depends on the macro)
 373 // ---------------------------------------------------------------------------
 374
 375 #define GetHwnd()               ((HWND)GetHWND())
 376 #define GetHwndOf(win)          ((HWND)((win)->GetHWND()))
 377 // old name
 378 #define GetWinHwnd              GetHwndOf
 379
 380 #define GetHdc()                ((HDC)GetHDC())
 381 #define GetHdcOf(dc)            ((HDC)(dc).GetHDC())
 382
 383 #define GetHbitmap()            ((HBITMAP)GetHBITMAP())
 384 #define GetHbitmapOf(bmp)       ((HBITMAP)(bmp).GetHBITMAP())
 385
 386 #define GetHicon()              ((HICON)GetHICON())
 387 #define GetHiconOf(icon)        ((HICON)(icon).GetHICON())
 388
 389 #define GetHaccel()             ((HACCEL)GetHACCEL())
 390 #define GetHaccelOf(table)      ((HACCEL)((table).GetHACCEL()))
 391
 392 #define GetHmenu()              ((HMENU)GetHMenu())
 393 #define GetHmenuOf(menu)        ((HMENU)menu->GetHMenu())
 394
 395 #define GetHcursor()            ((HCURSOR)GetHCURSOR())
 396 #define GetHcursorOf(cursor)    ((HCURSOR)(cursor).GetHCURSOR())
 397
 398 #define GetHfont()              ((HFONT)GetHFONT())
 399 #define GetHfontOf(font)        ((HFONT)(font).GetHFONT())
 400
 401 #define GetHpalette()           ((HPALETTE)GetHPALETTE())
 402 #define GetHpaletteOf(pal)      ((HPALETTE)(pal).GetHPALETTE())
 403
 404 #define GetHrgn()               ((HRGN)GetHRGN())
 405 #define GetHrgnOf(rgn)          ((HRGN)(rgn).GetHRGN())
 406
 407 #endif // wxUSE_GUI
 408
 409 // ---------------------------------------------------------------------------
 410 // global data
 411 // ---------------------------------------------------------------------------
 412
 413 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 414
 415 WXDLLEXPORT_DATA(extern HINSTANCE) wxhInstance;
 416
 417 // ---------------------------------------------------------------------------
 418 // global functions
 419 // ---------------------------------------------------------------------------
 420
 421 extern "C"
 422 {
 423     WXDLLEXPORT HINSTANCE wxGetInstance();
 424 }
 425
 426 WXDLLEXPORT void wxSetInstance(HINSTANCE hInst);
 427
 428 #if wxUSE_GUI
 429
 430 // cursor stuff
 431 extern HCURSOR wxGetCurrentBusyCursor();    // from msw/utils.cpp
 432 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
 433
 434 WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
 435
 436 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont *the_font);
 437 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
 438 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
 439 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
 440
 441 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
 442 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
 443
 444 // Find maximum size of window/rectangle
 445 WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
 446
 447 WXDLLEXPORT wxWindow* wxFindControlFromHandle(WXHWND hWnd);
 448 WXDLLEXPORT void wxAddControlHandle(WXHWND hWnd, wxWindow *item);
 449
 450 // Safely get the window text (i.e. without using fixed size buffer)
 451 WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
 452
 453 // get the window class name
 454 WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
 455
 456 // get the window id (should be unsigned, hence this is not wxWindowID which
 457 // is, for mainly historical reasons, signed)
 458 WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
 459
 460 // check if hWnd's WNDPROC is wndProc. Return true if yes, false if they are different
 461 extern bool wxCheckWindowWndProc(WXHWND hWnd, WXFARPROC wndProc);
 462
 463 // Does this window style specify any border?
 464 inline bool wxStyleHasBorder(long style)
 465 {
 466     return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
 467                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 468 }
 469
 470 // find the window for HWND which is part of some wxWindow, returns just the
 471 // corresponding wxWindow for HWND which just is one
 472 //
 473 // may return NULL
 474 extern wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
 475
 476 #endif // wxUSE_GUI
 477
 478 #endif
 479     // _WX_PRIVATE_H_