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 class WXDLLEXPORT wxFont;
  32 class WXDLLEXPORT wxWindow;
  33
  34 // ---------------------------------------------------------------------------
  35 // private constants
  36 // ---------------------------------------------------------------------------
  37
  38 // Conversion
  39 static const double METRIC_CONVERSION_CONSTANT = 0.0393700787;
  40
  41 // Scaling factors for various unit conversions
  42 static const double mm2inches = (METRIC_CONVERSION_CONSTANT);
  43 static const double inches2mm = (1/METRIC_CONVERSION_CONSTANT);
  44
  45 static const double mm2twips = (METRIC_CONVERSION_CONSTANT*1440);
  46 static const double twips2mm = (1/(METRIC_CONVERSION_CONSTANT*1440));
  47
  48 static const double mm2pt = (METRIC_CONVERSION_CONSTANT*72);
  49 static const double pt2mm = (1/(METRIC_CONVERSION_CONSTANT*72));
  50
  51 // ---------------------------------------------------------------------------
  52 // standard icons from the resources
  53 // ---------------------------------------------------------------------------
  54
  55 #if wxUSE_GUI
  56
  57 WXDLLEXPORT_DATA(extern HICON) wxSTD_FRAME_ICON;
  58 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDIPARENTFRAME_ICON;
  59 WXDLLEXPORT_DATA(extern HICON) wxSTD_MDICHILDFRAME_ICON;
  60 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_FRAME_ICON;
  61 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDIPARENTFRAME_ICON;
  62 WXDLLEXPORT_DATA(extern HICON) wxDEFAULT_MDICHILDFRAME_ICON;
  63 WXDLLEXPORT_DATA(extern HFONT) wxSTATUS_LINE_FONT;
  64
  65 #endif // wxUSE_GUI
  66
  67 // ---------------------------------------------------------------------------
  68 // define things missing from some compilers' headers
  69 // ---------------------------------------------------------------------------
  70
  71 #if defined(__GNUWIN32__) && !wxUSE_NORLANDER_HEADERS
  72 #ifndef ZeroMemory
  73     inline void ZeroMemory(void *buf, size_t len) { memset(buf, 0, len); }
  74 #endif
  75 #endif // old mingw32
  76
  77 // this defines a CASTWNDPROC macro which casts a pointer to the type of a
  78 // window proc
  79 #if defined(STRICT) || defined(__GNUC__)
  80     typedef WNDPROC WndProcCast;
  81 #else
  82     typedef FARPROC WndProcCast;
  83 #endif
  84
  85 #define CASTWNDPROC (WndProcCast)
  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 #if wxUSE_CTL3D
 128     #include "wx/msw/ctl3d/ctl3d.h"
 129 #endif // wxUSE_CTL3D
 130
 131 /*
 132  * Decide what window classes we're going to use
 133  * for this combination of CTl3D/FAFA settings
 134  */
 135
 136 #define STATIC_CLASS     wxT("STATIC")
 137 #define STATIC_FLAGS     (SS_LEFT|WS_CHILD|WS_VISIBLE)
 138 #define CHECK_CLASS      wxT("BUTTON")
 139 #define CHECK_FLAGS      (BS_AUTOCHECKBOX|WS_TABSTOP|WS_CHILD)
 140 #define CHECK_IS_FAFA   FALSE
 141 #define RADIO_CLASS      wxT("BUTTON")
 142 #define RADIO_FLAGS      (BS_AUTORADIOBUTTON|WS_CHILD|WS_VISIBLE)
 143 #define RADIO_SIZE       20
 144 #define RADIO_IS_FAFA   FALSE
 145 #define PURE_WINDOWS
 146 #define GROUP_CLASS      wxT("BUTTON")
 147 #define GROUP_FLAGS      (BS_GROUPBOX|WS_CHILD|WS_VISIBLE)
 148
 149 /*
 150 #define BITCHECK_FLAGS   (FB_BITMAP|FC_BUTTONDRAW|FC_DEFAULT|WS_VISIBLE)
 151 #define BITRADIO_FLAGS   (FC_BUTTONDRAW|FB_BITMAP|FC_RADIO|WS_CHILD|WS_VISIBLE)
 152 */
 153
 154 // ---------------------------------------------------------------------------
 155 // misc macros
 156 // ---------------------------------------------------------------------------
 157
 158 #define MEANING_CHARACTER '0'
 159 #define DEFAULT_ITEM_WIDTH  100
 160 #define DEFAULT_ITEM_HEIGHT 80
 161
 162 // Scale font to get edit control height
 163 //#define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (3*(cy)/2)
 164 #define EDIT_HEIGHT_FROM_CHAR_HEIGHT(cy)    (cy+8)
 165
 166 // Generic subclass proc, for panel item moving/sizing and intercept
 167 // EDIT control VK_RETURN messages
 168 extern LONG APIENTRY _EXPORT
 169   wxSubclassedGenericControlProc(WXHWND hWnd, WXUINT message, WXWPARAM wParam, WXLPARAM lParam);
 170
 171 // ---------------------------------------------------------------------------
 172 // constants which might miss from some compilers' headers
 173 // ---------------------------------------------------------------------------
 174
 175 #if !defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
 176     #define WS_EX_CLIENTEDGE 0
 177 #endif
 178
 179 #if defined(__WIN32__) && !defined(WS_EX_CLIENTEDGE)
 180     #define WS_EX_CLIENTEDGE 0x00000200L
 181 #endif
 182
 183 #ifndef ENDSESSION_LOGOFF
 184     #define ENDSESSION_LOGOFF    0x80000000
 185 #endif
 186
 187 // ---------------------------------------------------------------------------
 188 // useful macros and functions
 189 // ---------------------------------------------------------------------------
 190
 191 // a wrapper macro for ZeroMemory()
 192 #if defined(__WIN32__) && !defined(__WXMICROWIN__)
 193 #define wxZeroMemory(obj)   ::ZeroMemory(&obj, sizeof(obj))
 194 #else
 195 #define wxZeroMemory(obj)   memset((void*) & obj, 0, sizeof(obj))
 196 #endif
 197
 198 #if wxUSE_GUI
 199
 200 #include <wx/gdicmn.h>
 201
 202 // make conversion from wxColour and COLORREF a bit less painful
 203 inline COLORREF wxColourToRGB(const wxColour& c)
 204 {
 205     return RGB(c.Red(), c.Green(), c.Blue());
 206 }
 207
 208 inline void wxRGBToColour(wxColour& c, COLORREF rgb)
 209 {
 210     c.Set(GetRValue(rgb), GetGValue(rgb), GetBValue(rgb));
 211 }
 212
 213 // copy Windows RECT to our wxRect
 214 inline void wxCopyRECTToRect(const RECT& r, wxRect& rect)
 215 {
 216     rect.y = r.top;
 217     rect.x = r.left;
 218     rect.width = r.right - r.left;
 219     rect.height = r.bottom - r.top;
 220 }
 221
 222 // translations between HIMETRIC units (which OLE likes) and pixels (which are
 223 // liked by all the others) - implemented in msw/utilsexc.cpp
 224 extern void HIMETRICToPixel(LONG *x, LONG *y);
 225 extern void PixelToHIMETRIC(LONG *x, LONG *y);
 226
 227 // Windows convention of the mask is opposed to the wxWindows one, so we need
 228 // to invert the mask each time we pass one/get one to/from Windows
 229 extern HBITMAP wxInvertMask(HBITMAP hbmpMask, int w = 0, int h = 0);
 230
 231 // get (x, y) from DWORD - notice that HI/LOWORD can *not* be used because they
 232 // will fail on system with multiple monitors where the coords may be negative
 233 //
 234 // these macros are standard now (Win98) but some older headers don't have them
 235 #ifndef GET_X_LPARAM
 236     #define GET_X_LPARAM(lp) ((int)(short)LOWORD(lp))
 237     #define GET_Y_LPARAM(lp) ((int)(short)HIWORD(lp))
 238 #endif // GET_X_LPARAM
 239
 240 // get the current state of SHIFT/CTRL keys
 241 inline bool wxIsShiftDown()
 242 {
 243     return (::GetKeyState(VK_SHIFT) & 0x100) != 0;
 244 }
 245
 246 inline bool wxIsCtrlDown()
 247 {
 248     return (::GetKeyState(VK_CONTROL) & 0x100) != 0;
 249 }
 250
 251 // wrapper around GetWindowRect() and GetClientRect() APIs doing error checking
 252 // for Win32
 253 inline RECT wxGetWindowRect(HWND hwnd)
 254 {
 255     RECT rect;
 256 #ifdef __WIN16__
 257     ::GetWindowRect(hwnd, &rect);
 258 #else // Win32
 259     if ( !::GetWindowRect(hwnd, &rect) )
 260     {
 261         wxLogLastError(_T("GetWindowRect"));
 262     }
 263 #endif // Win16/32
 264
 265     return rect;
 266 }
 267
 268 inline RECT wxGetClientRect(HWND hwnd)
 269 {
 270     RECT rect;
 271 #ifdef __WIN16__
 272     ::GetClientRect(hwnd, &rect);
 273 #else // Win32
 274     if ( !::GetClientRect(hwnd, &rect) )
 275     {
 276         wxLogLastError(_T("GetClientRect"));
 277     }
 278 #endif // Win16/32
 279
 280     return rect;
 281 }
 282
 283 // ---------------------------------------------------------------------------
 284 // small helper classes
 285 // ---------------------------------------------------------------------------
 286
 287 // create an instance of this class and use it as the HDC for screen, will
 288 // automatically release the DC going out of scope
 289 class ScreenHDC
 290 {
 291 public:
 292     ScreenHDC() { m_hdc = GetDC(NULL);    }
 293    ~ScreenHDC() { ReleaseDC(NULL, m_hdc); }
 294     operator HDC() const { return m_hdc;  }
 295
 296 private:
 297     HDC m_hdc;
 298 };
 299
 300 // ---------------------------------------------------------------------------
 301 // macros to make casting between WXFOO and FOO a bit easier: the GetFoo()
 302 // returns Foo cast to the Windows type for oruselves, while GetFooOf() takes
 303 // an argument which should be a pointer or reference to the object of the
 304 // corresponding class (this depends on the macro)
 305 // ---------------------------------------------------------------------------
 306
 307 #define GetHwnd()               ((HWND)GetHWND())
 308 #define GetHwndOf(win)          ((HWND)((win)->GetHWND()))
 309 // old name
 310 #define GetWinHwnd              GetHwndOf
 311
 312 #define GetHdc()                ((HDC)GetHDC())
 313 #define GetHdcOf(dc)            ((HDC)(dc).GetHDC())
 314
 315 #define GetHbitmap()            ((HBITMAP)GetHBITMAP())
 316 #define GetHbitmapOf(bmp)       ((HBITMAP)(bmp).GetHBITMAP())
 317
 318 #define GetHicon()              ((HICON)GetHICON())
 319 #define GetHiconOf(icon)        ((HICON)(icon).GetHICON())
 320
 321 #define GetHaccel()             ((HACCEL)GetHACCEL())
 322 #define GetHaccelOf(table)      ((HACCEL)((table).GetHACCEL()))
 323
 324 #define GetHmenu()              ((HMENU)GetHMenu())
 325 #define GetHmenuOf(menu)        ((HMENU)menu->GetHMenu())
 326
 327 #define GetHcursor()            ((HCURSOR)GetHCURSOR())
 328 #define GetHcursorOf(cursor)    ((HCURSOR)(cursor).GetHCURSOR())
 329
 330 #define GetHfont()              ((HFONT)GetHFONT())
 331 #define GetHfontOf(font)        ((HFONT)(font).GetHFONT())
 332
 333 #define GetHrgn()               ((HRGN)GetHRGN())
 334 #define GetHrgnOf(rgn)          ((HRGN)(rgn).GetHRGN())
 335
 336 #endif // wxUSE_GUI
 337
 338 // ---------------------------------------------------------------------------
 339 // global data
 340 // ---------------------------------------------------------------------------
 341
 342 WXDLLEXPORT_DATA(extern wxChar*) wxBuffer;
 343
 344 WXDLLEXPORT_DATA(extern HINSTANCE) wxhInstance;
 345
 346 // ---------------------------------------------------------------------------
 347 // global functions
 348 // ---------------------------------------------------------------------------
 349
 350 extern "C"
 351 {
 352     WXDLLEXPORT HINSTANCE wxGetInstance();
 353 }
 354
 355 WXDLLEXPORT void wxSetInstance(HINSTANCE hInst);
 356
 357 #if wxUSE_GUI
 358
 359 // cursor stuff
 360 extern HCURSOR wxGetCurrentBusyCursor();    // from msw/utils.cpp
 361 extern const wxCursor *wxGetGlobalCursor(); // from msw/cursor.cpp
 362
 363 WXDLLEXPORT wxWindow* wxFindWinFromHandle(WXHWND hWnd);
 364
 365 WXDLLEXPORT void wxGetCharSize(WXHWND wnd, int *x, int *y, const wxFont *the_font);
 366 WXDLLEXPORT void wxFillLogFont(LOGFONT *logFont, const wxFont *font);
 367 WXDLLEXPORT wxFont wxCreateFontFromLogFont(const LOGFONT *logFont);
 368 WXDLLEXPORT wxFontEncoding wxGetFontEncFromCharSet(int charset);
 369
 370 WXDLLEXPORT void wxSliderEvent(WXHWND control, WXWORD wParam, WXWORD pos);
 371 WXDLLEXPORT void wxScrollBarEvent(WXHWND hbar, WXWORD wParam, WXWORD pos);
 372
 373 // Find maximum size of window/rectangle
 374 WXDLLEXPORT extern void wxFindMaxSize(WXHWND hwnd, RECT *rect);
 375
 376 WXDLLEXPORT wxWindow* wxFindControlFromHandle(WXHWND hWnd);
 377 WXDLLEXPORT void wxAddControlHandle(WXHWND hWnd, wxWindow *item);
 378
 379 // Safely get the window text (i.e. without using fixed size buffer)
 380 WXDLLEXPORT extern wxString wxGetWindowText(WXHWND hWnd);
 381
 382 // get the window class name
 383 WXDLLEXPORT extern wxString wxGetWindowClass(WXHWND hWnd);
 384
 385 // get the window id (should be unsigned, hence this is not wxWindowID which
 386 // is, for mainly historical reasons, signed)
 387 WXDLLEXPORT extern WXWORD wxGetWindowId(WXHWND hWnd);
 388
 389 // Does this window style specify any border?
 390 inline bool wxStyleHasBorder(long style)
 391 {
 392     return (style & (wxSIMPLE_BORDER | wxRAISED_BORDER |
 393                      wxSUNKEN_BORDER | wxDOUBLE_BORDER)) != 0;
 394 }
 395
 396 // find the window for HWND which is part of some wxWindow, returns just the
 397 // corresponding wxWindow for HWND which just is one
 398 //
 399 // may return NULL
 400 extern wxWindow *wxGetWindowFromHWND(WXHWND hwnd);
 401
 402 #endif // wxUSE_GUI
 403
 404 #endif
 405     // _WX_PRIVATE_H_