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