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