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 #include "wx/font.h"
  30
  31 // ---------------------------------------------------------------------------
  32 // forward declarations
  33 // ---------------------------------------------------------------------------
  34
  35 class WXDLLEXPORT wxBitmap;
  36 class WXDLLEXPORT wxBrush;
  37 class WXDLLEXPORT wxColour;
  38 class WXDLLEXPORT wxCursor;
  39 class WXDLLEXPORT wxFont;
  40 class WXDLLEXPORT wxIcon;
  41 class WXDLLEXPORT wxPalette;
  42 class WXDLLEXPORT wxPen;
  43 class WXDLLEXPORT wxRegion;
  44 class WXDLLEXPORT wxString;
  45
  46 // ---------------------------------------------------------------------------
  47 // constants
  48 // ---------------------------------------------------------------------------
  49
  50 // Bitmap flags
  51 enum wxBitmapType
  52 {
  53     wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
  54     wxBITMAP_TYPE_BMP,
  55     wxBITMAP_TYPE_BMP_RESOURCE,
  56     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  57     wxBITMAP_TYPE_ICO,
  58     wxBITMAP_TYPE_ICO_RESOURCE,
  59     wxBITMAP_TYPE_CUR,
  60     wxBITMAP_TYPE_CUR_RESOURCE,
  61     wxBITMAP_TYPE_XBM,
  62     wxBITMAP_TYPE_XBM_DATA,
  63     wxBITMAP_TYPE_XPM,
  64     wxBITMAP_TYPE_XPM_DATA,
  65     wxBITMAP_TYPE_TIF,
  66     wxBITMAP_TYPE_TIF_RESOURCE,
  67     wxBITMAP_TYPE_GIF,
  68     wxBITMAP_TYPE_GIF_RESOURCE,
  69     wxBITMAP_TYPE_PNG,
  70     wxBITMAP_TYPE_PNG_RESOURCE,
  71     wxBITMAP_TYPE_JPEG,
  72     wxBITMAP_TYPE_JPEG_RESOURCE,
  73     wxBITMAP_TYPE_PNM,
  74     wxBITMAP_TYPE_PNM_RESOURCE,
  75     wxBITMAP_TYPE_PCX,
  76     wxBITMAP_TYPE_PCX_RESOURCE,
  77     wxBITMAP_TYPE_PICT,
  78     wxBITMAP_TYPE_PICT_RESOURCE,
  79     wxBITMAP_TYPE_ICON,
  80     wxBITMAP_TYPE_ICON_RESOURCE,
  81     wxBITMAP_TYPE_MACCURSOR,
  82     wxBITMAP_TYPE_MACCURSOR_RESOURCE,
  83     wxBITMAP_TYPE_ANY = 50
  84 };
  85
  86 // Standard cursors
  87 enum wxStockCursor
  88 {
  89     wxCURSOR_NONE,          // should be 0
  90     wxCURSOR_ARROW,
  91     wxCURSOR_BULLSEYE,
  92     wxCURSOR_CHAR,
  93     wxCURSOR_CROSS,
  94     wxCURSOR_HAND,
  95     wxCURSOR_IBEAM,
  96     wxCURSOR_LEFT_BUTTON,
  97     wxCURSOR_MAGNIFIER,
  98     wxCURSOR_MIDDLE_BUTTON,
  99     wxCURSOR_NO_ENTRY,
 100     wxCURSOR_PAINT_BRUSH,
 101     wxCURSOR_PENCIL,
 102     wxCURSOR_POINT_LEFT,
 103     wxCURSOR_POINT_RIGHT,
 104     wxCURSOR_QUESTION_ARROW,
 105     wxCURSOR_RIGHT_BUTTON,
 106     wxCURSOR_SIZENESW,
 107     wxCURSOR_SIZENS,
 108     wxCURSOR_SIZENWSE,
 109     wxCURSOR_SIZEWE,
 110     wxCURSOR_SIZING,
 111     wxCURSOR_SPRAYCAN,
 112     wxCURSOR_WAIT,
 113     wxCURSOR_WATCH,
 114     wxCURSOR_BLANK,
 115 #ifdef __WXGTK__
 116     wxCURSOR_DEFAULT, // standard X11 cursor
 117 #endif
 118 #ifdef __X__
 119     // Not yet implemented for Windows
 120     wxCURSOR_CROSS_REVERSE,
 121     wxCURSOR_DOUBLE_ARROW,
 122     wxCURSOR_BASED_ARROW_UP,
 123     wxCURSOR_BASED_ARROW_DOWN,
 124 #endif // X11
 125
 126     wxCURSOR_ARROWWAIT,
 127
 128     wxCURSOR_MAX
 129 };
 130
 131 #ifndef __WXGTK__
 132     #define wxCURSOR_DEFAULT wxCURSOR_ARROW
 133 #endif
 134
 135 // ---------------------------------------------------------------------------
 136 // macros
 137 // ---------------------------------------------------------------------------
 138
 139 /* Useful macro for creating icons portably, for example:
 140
 141     wxIcon *icon = new wxICON(mondrian);
 142
 143   expands into:
 144
 145     wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
 146     wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 147  */
 148
 149 #ifdef __WXMSW__
 150     // Load from a resource
 151     #define wxICON(X) wxIcon("" #X "")
 152 #elif defined(__WXPM__)
 153     // Load from a resource
 154     #define wxICON(X) wxIcon("" #X "")
 155 #elif defined(__WXMGL__)
 156     // Initialize from an included XPM
 157     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 158 #elif defined(__WXGTK__)
 159     // Initialize from an included XPM
 160     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 161 #elif defined(__WXMAC__)
 162     // Initialize from an included XPM
 163     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 164 #elif defined(__WXMOTIF__)
 165     // Initialize from an included XPM
 166     #define wxICON(X) wxIcon( X##_xpm )
 167 #else
 168     // This will usually mean something on any platform
 169     #define wxICON(X) wxIcon("" #X "")
 170 #endif // platform
 171
 172 /* Another macro: this one is for portable creation of bitmaps. We assume that
 173    under Unix bitmaps live in XPMs and under Windows they're in ressources.
 174  */
 175
 176 #if defined(__WXMSW__) || defined(__WXPM__)
 177     #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
 178 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
 179     // Initialize from an included XPM
 180     #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
 181 #else // other platforms
 182     #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
 183 #endif // platform
 184
 185 // ===========================================================================
 186 // classes
 187 // ===========================================================================
 188
 189 // ---------------------------------------------------------------------------
 190 // wxSize
 191 // ---------------------------------------------------------------------------
 192
 193 class WXDLLEXPORT wxSize
 194 {
 195 public:
 196     // members are public for compatibility (don't use them directly,
 197     // especially that there names were chosen very unfortunately - they should
 198     // have been called width and height)
 199     int x, y;
 200
 201     // constructors
 202     wxSize() { x = y = 0; }
 203     wxSize(int xx, int yy) { Set(xx, yy); }
 204
 205     // no copy ctor or assignment operator - the defaults are ok
 206
 207     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 208     bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
 209
 210     // FIXME are these really useful? If they're, we should have += &c as well
 211     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
 212     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 213
 214     // accessors
 215     void Set(int xx, int yy) { x = xx; y = yy; }
 216     void SetWidth(int w) { x = w; }
 217     void SetHeight(int h) { y = h; }
 218
 219     int GetWidth() const { return x; }
 220     int GetHeight() const { return y; }
 221
 222     // compatibility
 223     int GetX() const { return x; }
 224     int GetY() const { return y; }
 225 };
 226
 227 // ---------------------------------------------------------------------------
 228 // Point classes: with real or integer coordinates
 229 // ---------------------------------------------------------------------------
 230
 231 class WXDLLEXPORT wxRealPoint
 232 {
 233 public:
 234     double x;
 235     double y;
 236
 237     wxRealPoint() { x = y = 0.0; };
 238     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 239
 240     wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
 241     wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
 242
 243     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 244 };
 245
 246 class WXDLLEXPORT wxPoint
 247 {
 248 public:
 249     int x, y;
 250
 251     wxPoint() { x = y = 0; };
 252     wxPoint(int xx, int yy) { x = xx; y = yy; };
 253
 254     // no copy ctor or assignment operator - the defaults are ok
 255
 256     // comparison
 257     bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
 258     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 259
 260     // arithmetic operations (component wise)
 261     wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
 262     wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
 263
 264     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
 265     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 266 };
 267
 268 #if WXWIN_COMPATIBILITY
 269     #define wxIntPoint wxPoint
 270     #define wxRectangle wxRect
 271 #endif // WXWIN_COMPATIBILITY
 272
 273 // ---------------------------------------------------------------------------
 274 // wxRect
 275 // ---------------------------------------------------------------------------
 276
 277 class WXDLLEXPORT wxRect
 278 {
 279 public:
 280     wxRect() { x = y = width = height = 0; }
 281     wxRect(int xx, int yy, int ww, int hh)
 282         { x = xx; y = yy; width = ww; height = hh; }
 283     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 284     wxRect(const wxPoint& pos, const wxSize& size);
 285
 286     // default copy ctor and assignment operators ok
 287
 288     int GetX() const { return x; }
 289     void SetX(int xx) { x = xx; }
 290
 291     int GetY() const { return y; }
 292     void SetY(int yy) { y = yy; }
 293
 294     int GetWidth() const { return width; }
 295     void SetWidth(int w) { width = w; }
 296
 297     int GetHeight() const { return height; }
 298     void SetHeight(int h) { height = h; }
 299
 300     wxPoint GetPosition() const { return wxPoint(x, y); }
 301     wxSize GetSize() const { return wxSize(width, height); }
 302
 303     int GetLeft()   const { return x; }
 304     int GetTop()    const { return y; }
 305     int GetBottom() const { return y + height - 1; }
 306     int GetRight()  const { return x + width - 1; }
 307
 308     void SetLeft(int left) { x = left; }
 309     void SetRight(int right) { width = right - x + 1; }
 310     void SetTop(int top) { y = top; }
 311     void SetBottom(int bottom) { height = bottom - y + 1; }
 312
 313     // operations with rect
 314     wxRect& Inflate(wxCoord dx, wxCoord dy);
 315     wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
 316     wxRect Inflate(wxCoord dx, wxCoord dy) const
 317     {
 318         wxRect r = *this;
 319         r.Inflate(dx, dy);
 320         return r;
 321     }
 322
 323     wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
 324     wxRect& Deflate(wxCoord d) { return Inflate(-d); }
 325     wxRect Deflate(wxCoord dx, wxCoord dy) const
 326     {
 327         wxRect r = *this;
 328         r.Deflate(dx, dy);
 329         return r;
 330     }
 331
 332     void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
 333     void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
 334
 335     wxRect& Intersect(const wxRect& rect);
 336     wxRect Intersect(const wxRect& rect) const
 337     {
 338         wxRect r = *this;
 339         r.Intersect(rect);
 340         return r;
 341     }
 342
 343     wxRect operator+(const wxRect& rect) const;
 344     wxRect& operator+=(const wxRect& rect);
 345
 346     // compare rectangles
 347     bool operator==(const wxRect& rect) const;
 348     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 349
 350     // return TRUE if the point is (not strcitly) inside the rect
 351     bool Inside(int x, int y) const;
 352     bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
 353
 354     // return TRUE if the rectangles have a non empty intersection
 355     bool Intersects(const wxRect& rect) const;
 356
 357 public:
 358     int x, y, width, height;
 359 };
 360
 361 // ---------------------------------------------------------------------------
 362 // Management of pens, brushes and fonts
 363 // ---------------------------------------------------------------------------
 364
 365 typedef wxInt8 wxDash;
 366
 367 class WXDLLEXPORT wxPenList : public wxList
 368 {
 369     DECLARE_DYNAMIC_CLASS(wxPenList)
 370
 371 public:
 372     wxPenList() { }
 373     ~wxPenList();
 374
 375     void AddPen(wxPen *pen);
 376     void RemovePen(wxPen *pen);
 377     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
 378 };
 379
 380 class WXDLLEXPORT wxBrushList : public wxList
 381 {
 382     DECLARE_DYNAMIC_CLASS(wxBrushList)
 383
 384 public:
 385     wxBrushList() { }
 386     ~wxBrushList();
 387
 388     void AddBrush(wxBrush *brush);
 389     void RemoveBrush(wxBrush *brush);
 390     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 391 };
 392
 393 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 394
 395 class WXDLLEXPORT wxFontList : public wxList
 396 {
 397     DECLARE_DYNAMIC_CLASS(wxFontList)
 398
 399 public:
 400     wxFontList() { }
 401     ~wxFontList();
 402
 403     void AddFont(wxFont *font);
 404     void RemoveFont(wxFont *font);
 405     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
 406                              bool underline = FALSE,
 407                              const wxString& face = wxEmptyString,
 408                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 409 };
 410
 411 class WXDLLEXPORT wxColourDatabase : public wxList
 412 {
 413     DECLARE_CLASS(wxColourDatabase)
 414
 415 public:
 416     wxColourDatabase(int type);
 417     ~wxColourDatabase() ;
 418
 419     // Not const because it may add a name to the database
 420     wxColour *FindColour(const wxString& colour) ;
 421     wxString FindName(const wxColour& colour) const;
 422     void Initialize();
 423 #ifdef __WXPM__
 424     // PM keeps its own type of colour table
 425     long*                           m_palTable;
 426     size_t                          m_nSize;
 427 #endif
 428 };
 429
 430 class WXDLLEXPORT wxBitmapList : public wxList
 431 {
 432     DECLARE_DYNAMIC_CLASS(wxBitmapList)
 433
 434 public:
 435     wxBitmapList();
 436     ~wxBitmapList();
 437
 438     void AddBitmap(wxBitmap *bitmap);
 439     void RemoveBitmap(wxBitmap *bitmap);
 440 };
 441
 442 class WXDLLEXPORT wxResourceCache: public wxList
 443 {
 444 public:
 445     wxResourceCache() { }
 446     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 447     ~wxResourceCache();
 448
 449 private:
 450     DECLARE_DYNAMIC_CLASS(wxResourceCache)
 451 };
 452
 453 // ---------------------------------------------------------------------------
 454 // global variables
 455 // ---------------------------------------------------------------------------
 456
 457 // Lists of GDI objects
 458 WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
 459 WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
 460 WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
 461 WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
 462
 463 // Stock objects
 464 WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
 465 WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
 466 WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
 467 WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
 468
 469 WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
 470 WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
 471 WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
 472 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
 473 WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
 474 WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
 475 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
 476 WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
 477 WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
 478 WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
 479
 480 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
 481 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
 482 WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
 483 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
 484 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
 485 WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
 486 WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
 487 WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
 488 WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
 489 WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
 490
 491 WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
 492 WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
 493 WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
 494 WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
 495 WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
 496 WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
 497 WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
 498
 499 // 'Null' objects
 500 WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
 501 WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
 502 WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
 503 WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
 504 WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
 505 WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
 506 WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
 507 WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
 508
 509 // Stock cursors types
 510 WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
 511 WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
 512 WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
 513
 514 WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
 515
 516 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
 517
 518 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
 519 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
 520
 521 // The list of objects which should be deleted
 522 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
 523
 524 // ---------------------------------------------------------------------------
 525 // global functions
 526 // ---------------------------------------------------------------------------
 527
 528 // resource management
 529 extern void WXDLLEXPORT wxInitializeStockObjects();
 530 extern void WXDLLEXPORT wxInitializeStockLists();
 531 extern void WXDLLEXPORT wxDeleteStockObjects();
 532 extern void WXDLLEXPORT wxDeleteStockLists();
 533
 534 // is the display colour (or monochrome)?
 535 extern bool WXDLLEXPORT wxColourDisplay();
 536
 537 // Returns depth of screen
 538 extern int WXDLLEXPORT wxDisplayDepth();
 539 #define wxGetDisplayDepth wxDisplayDepth
 540
 541 // get the display size
 542 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 543 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 544 extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
 545 extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
 546
 547 // Get position and size of the display workarea
 548 extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
 549 extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
 550
 551 // set global cursor
 552 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 553
 554 #endif
 555     // _WX_GDICMNH__