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