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