include/wx/gdicmn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gdicmn.h
   3 // Purpose:     Common GDI classes, types and declarations
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GDICMNH__
  13 #define _WX_GDICMNH__
  14
  15 // ---------------------------------------------------------------------------
  16 // headers
  17 // ---------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "gdicmn.h"
  21 #endif
  22
  23 #include "wx/object.h"
  24 #include "wx/list.h"
  25 #include "wx/hash.h"
  26 #include "wx/string.h"
  27 #include "wx/setup.h"
  28 #include "wx/colour.h"
  29
  30 // ---------------------------------------------------------------------------
  31 // forward declarations
  32 // ---------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxBitmap;
  35 class WXDLLEXPORT wxBrush;
  36 class WXDLLEXPORT wxColour;
  37 class WXDLLEXPORT wxCursor;
  38 class WXDLLEXPORT wxFont;
  39 class WXDLLEXPORT wxIcon;
  40 class WXDLLEXPORT wxPalette;
  41 class WXDLLEXPORT wxPen;
  42 class WXDLLEXPORT wxRegion;
  43 class WXDLLEXPORT wxString;
  44
  45 // ---------------------------------------------------------------------------
  46 // constants
  47 // ---------------------------------------------------------------------------
  48
  49 // Bitmap flags
  50 enum
  51 {
  52     wxBITMAP_TYPE_BMP = 1,
  53     wxBITMAP_TYPE_BMP_RESOURCE,
  54     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  55     wxBITMAP_TYPE_ICO,
  56     wxBITMAP_TYPE_ICO_RESOURCE,
  57     wxBITMAP_TYPE_CUR,
  58     wxBITMAP_TYPE_CUR_RESOURCE,
  59     wxBITMAP_TYPE_XBM,
  60     wxBITMAP_TYPE_XBM_DATA,
  61     wxBITMAP_TYPE_XPM,
  62     wxBITMAP_TYPE_XPM_DATA,
  63     wxBITMAP_TYPE_TIF,
  64     wxBITMAP_TYPE_TIF_RESOURCE,
  65     wxBITMAP_TYPE_GIF,
  66     wxBITMAP_TYPE_GIF_RESOURCE,
  67     wxBITMAP_TYPE_PNG,
  68     wxBITMAP_TYPE_PNG_RESOURCE,
  69     wxBITMAP_TYPE_JPEG,
  70     wxBITMAP_TYPE_JPEG_RESOURCE,
  71     wxBITMAP_TYPE_ANY = 50
  72 };
  73
  74 // Standard cursors
  75 enum wxStockCursor
  76 {
  77     wxCURSOR_NONE,          // should be 0
  78     wxCURSOR_ARROW,
  79     wxCURSOR_BULLSEYE,
  80     wxCURSOR_CHAR,
  81     wxCURSOR_CROSS,
  82     wxCURSOR_HAND,
  83     wxCURSOR_IBEAM,
  84     wxCURSOR_LEFT_BUTTON,
  85     wxCURSOR_MAGNIFIER,
  86     wxCURSOR_MIDDLE_BUTTON,
  87     wxCURSOR_NO_ENTRY,
  88     wxCURSOR_PAINT_BRUSH,
  89     wxCURSOR_PENCIL,
  90     wxCURSOR_POINT_LEFT,
  91     wxCURSOR_POINT_RIGHT,
  92     wxCURSOR_QUESTION_ARROW,
  93     wxCURSOR_RIGHT_BUTTON,
  94     wxCURSOR_SIZENESW,
  95     wxCURSOR_SIZENS,
  96     wxCURSOR_SIZENWSE,
  97     wxCURSOR_SIZEWE,
  98     wxCURSOR_SIZING,
  99     wxCURSOR_SPRAYCAN,
 100     wxCURSOR_WAIT,
 101     wxCURSOR_WATCH,
 102     wxCURSOR_BLANK,
 103 #ifdef __X__
 104     // Not yet implemented for Windows
 105     wxCURSOR_CROSS_REVERSE,
 106     wxCURSOR_DOUBLE_ARROW,
 107     wxCURSOR_BASED_ARROW_UP,
 108     wxCURSOR_BASED_ARROW_DOWN,
 109 #endif // X11
 110
 111     wxCURSOR_MAX
 112 };
 113
 114 // ---------------------------------------------------------------------------
 115 // macros
 116 // ---------------------------------------------------------------------------
 117
 118 /* Useful macro for creating icons portably, for example:
 119
 120     wxIcon *icon = new wxICON(mondrian);
 121
 122   expands into:
 123
 124     wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
 125     wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 126  */
 127
 128 #ifdef __WXMSW__
 129     // Load from a resource
 130     #define wxICON(X) wxIcon("" #X "")
 131 #elif defined(__WXGTK__)
 132     // Initialize from an included XPM
 133     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 134 #elif defined(__WXMOTIF__)
 135     // Initialize from an included XPM
 136     #define wxICON(X) wxIcon( X##_xpm )
 137 #else
 138     // This will usually mean something on any platform
 139     #define wxICON(X) wxIcon("" #X "")
 140 #endif // platform
 141
 142 // ===========================================================================
 143 // classes
 144 // ===========================================================================
 145
 146 // ---------------------------------------------------------------------------
 147 // wxSize
 148 // ---------------------------------------------------------------------------
 149 class WXDLLEXPORT wxSize
 150 {
 151 public:
 152     // members are public for compatibility
 153     long x;
 154     long y;
 155
 156     // constructors
 157     wxSize() { x = y = 0; }
 158     wxSize(long xx, long yy) { Set(xx, yy); }
 159
 160     // no copy ctor or assignment operator - the defaults are ok
 161
 162     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 163
 164     // FIXME are these really useful? If they're, we should have += &c as well
 165     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
 166     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 167
 168     void Set(long xx, long yy) { x = xx; y = yy; }
 169
 170     long GetX() const { return x; }
 171     long GetY() const { return y; }
 172 };
 173
 174 // ---------------------------------------------------------------------------
 175 // Point classes: with real or integer coordinates
 176 // ---------------------------------------------------------------------------
 177 class WXDLLEXPORT wxRealPoint
 178 {
 179 public:
 180     double x;
 181     double y;
 182
 183     wxRealPoint() { x = y = 0.0; };
 184     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 185
 186     wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
 187     wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
 188
 189     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 190 };
 191
 192 class WXDLLEXPORT wxPoint
 193 {
 194 public:
 195 #if defined(__WXMSW__) && !defined(__WIN32__)
 196     int x;
 197     int y;
 198 #else
 199     long x;
 200     long y;
 201 #endif
 202
 203     wxPoint() { x = y = 0; };
 204     wxPoint(long xx, long yy) { x = xx; y = yy; };
 205
 206     // no copy ctor or assignment operator - the defaults are ok
 207
 208     bool operator==(const wxPoint& pt) const { return x == pt.x && y == pt.y; }
 209
 210     wxPoint operator + (const wxPoint& pt) { return wxPoint(x + pt.x, y + pt.y); }
 211     wxPoint operator - (const wxPoint& pt) { return wxPoint(x - pt.x, y - pt.y); }
 212 };
 213
 214 #if WXWIN_COMPATIBILITY
 215     #define wxIntPoint wxPoint
 216     #define wxRectangle wxRect
 217 #endif // WXWIN_COMPATIBILITY
 218
 219 // ---------------------------------------------------------------------------
 220 // wxRect
 221 // ---------------------------------------------------------------------------
 222
 223 class WXDLLEXPORT wxRect
 224 {
 225 public:
 226     wxRect();
 227     wxRect(long x, long y, long w, long h);
 228     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 229     wxRect(const wxPoint& pos, const wxSize& size);
 230     wxRect(const wxRect& rect);
 231
 232     long GetX() const { return x; }
 233     void SetX(long xx) { x = xx; }
 234
 235     long GetY() const { return y; }
 236     void SetY(long yy) { y = yy; }
 237
 238     long GetWidth() const { return width; }
 239     void SetWidth(long w) { width = w; }
 240
 241     long GetHeight() const { return height; }
 242     void SetHeight(long h) { height = h; }
 243
 244     wxPoint GetPosition() { return wxPoint(x, y); }
 245     wxSize GetSize() { return wxSize(width, height); }
 246
 247     long GetLeft()   const { return x; }
 248     long GetTop()    const { return y; }
 249     long GetBottom() const { return y + height; }
 250     long GetRight()  const { return x + width; }
 251
 252     wxRect& operator = (const wxRect& rect);
 253     bool operator == (const wxRect& rect);
 254     bool operator != (const wxRect& rect);
 255
 256 public:
 257     long x, y, width, height;
 258 };
 259
 260 // ---------------------------------------------------------------------------
 261 // Management of pens, brushes and fonts
 262 // ---------------------------------------------------------------------------
 263
 264 class WXDLLEXPORT wxPenList : public wxList
 265 {
 266     DECLARE_DYNAMIC_CLASS(wxPenList)
 267
 268 public:
 269     wxPenList() { }
 270     ~wxPenList();
 271
 272     void AddPen(wxPen *pen);
 273     void RemovePen(wxPen *pen);
 274     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
 275 };
 276
 277 class WXDLLEXPORT wxBrushList : public wxList
 278 {
 279     DECLARE_DYNAMIC_CLASS(wxBrushList)
 280
 281 public:
 282     wxBrushList() { }
 283     ~wxBrushList();
 284
 285     void AddBrush(wxBrush *brush);
 286     void RemoveBrush(wxBrush *brush);
 287     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 288 };
 289
 290 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 291
 292 class WXDLLEXPORT wxFontList : public wxList
 293 {
 294     DECLARE_DYNAMIC_CLASS(wxFontList)
 295
 296 public:
 297     wxFontList() { }
 298     ~wxFontList();
 299
 300     void AddFont(wxFont *font);
 301     void RemoveFont(wxFont *font);
 302     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
 303                              bool underline = FALSE,
 304                              const wxString& face = wxEmptyString);
 305 };
 306
 307 class WXDLLEXPORT wxColourDatabase : public wxList
 308 {
 309     DECLARE_CLASS(wxColourDatabase)
 310
 311 public:
 312     wxColourDatabase(int type);
 313     ~wxColourDatabase() ;
 314
 315     // Not const because it may add a name to the database
 316     wxColour *FindColour(const wxString& colour) ;
 317     wxString FindName(const wxColour& colour) const;
 318     void Initialize();
 319 };
 320
 321 class WXDLLEXPORT wxBitmapList : public wxList
 322 {
 323     DECLARE_DYNAMIC_CLASS(wxBitmapList)
 324
 325 public:
 326     wxBitmapList();
 327     ~wxBitmapList();
 328
 329     void AddBitmap(wxBitmap *bitmap);
 330     void RemoveBitmap(wxBitmap *bitmap);
 331 };
 332
 333 class WXDLLEXPORT wxResourceCache: public wxList
 334 {
 335 public:
 336     wxResourceCache() { }
 337     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 338     ~wxResourceCache();
 339
 340 private:
 341     DECLARE_DYNAMIC_CLASS(wxResourceCache)
 342 };
 343
 344 // ---------------------------------------------------------------------------
 345 // global variables
 346 // ---------------------------------------------------------------------------
 347
 348 // Lists of GDI objects
 349 WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
 350 WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
 351 WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
 352 WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
 353
 354 // Stock objects
 355 WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
 356 WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
 357 WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
 358 WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
 359
 360 WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
 361 WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
 362 WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
 363 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
 364 WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
 365 WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
 366 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
 367 WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
 368 WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
 369 WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
 370
 371 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
 372 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
 373 WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
 374 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
 375 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
 376 WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
 377 WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
 378 WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
 379 WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
 380 WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
 381
 382 WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
 383 WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
 384 WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
 385 WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
 386 WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
 387 WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
 388 WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
 389
 390 // 'Null' objects
 391 WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
 392 WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
 393 WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
 394 WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
 395 WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
 396 WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
 397 WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
 398 WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
 399
 400 // Stock cursors types
 401 WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
 402 WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
 403 WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
 404
 405 WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
 406
 407 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
 408
 409 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
 410 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
 411
 412 // The list of objects which should be deleted
 413 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
 414
 415 // ---------------------------------------------------------------------------
 416 // global functions
 417 // ---------------------------------------------------------------------------
 418
 419 // resource management
 420 extern void WXDLLEXPORT wxInitializeStockObjects();
 421 extern void WXDLLEXPORT wxInitializeStockLists();
 422 extern void WXDLLEXPORT wxDeleteStockObjects();
 423 extern void WXDLLEXPORT wxDeleteStockLists();
 424
 425 // is the display colour (or monochrome)?
 426 extern bool WXDLLEXPORT wxColourDisplay();
 427
 428 // Returns depth of screen
 429 extern int WXDLLEXPORT wxDisplayDepth();
 430 #define wxGetDisplayDepth wxDisplayDepth
 431
 432 // get the diaplay size
 433 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 434 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 435
 436 // set global cursor
 437 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 438
 439 #endif
 440     // _WX_GDICMNH__