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