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
  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_MAX
 127 };
 128
 129 // ---------------------------------------------------------------------------
 130 // macros
 131 // ---------------------------------------------------------------------------
 132
 133 /* Useful macro for creating icons portably, for example:
 134
 135     wxIcon *icon = new wxICON(mondrian);
 136
 137   expands into:
 138
 139     wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
 140     wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 141  */
 142
 143 #ifdef __WXMSW__
 144     // Load from a resource
 145     #define wxICON(X) wxIcon("" #X "")
 146 #elif defined(__WXPM__)
 147     // Load from a resource
 148     #define wxICON(X) wxIcon("" #X "")
 149 #elif defined(__WXGTK__)
 150     // Initialize from an included XPM
 151     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 152 #elif defined(__WXMOTIF__)
 153     // Initialize from an included XPM
 154     #define wxICON(X) wxIcon( X##_xpm )
 155 #else
 156     // This will usually mean something on any platform
 157     #define wxICON(X) wxIcon("" #X "")
 158 #endif // platform
 159
 160 /* Another macro: this one is for portable creation of bitmaps. We assume that
 161    under Unix bitmaps live in XPMs and under Windows they're in ressources.
 162  */
 163
 164 #if defined(__WXMSW__) || defined(__WXPM__)
 165     #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
 166 #elif defined(__WXGTK__)
 167     // Initialize from an included XPM
 168     #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
 169 #else // !(Windows || OS2)
 170     #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
 171 #endif // platform
 172
 173 // ===========================================================================
 174 // classes
 175 // ===========================================================================
 176
 177 // ---------------------------------------------------------------------------
 178 // wxSize
 179 // ---------------------------------------------------------------------------
 180 class WXDLLEXPORT wxSize
 181 {
 182 public:
 183     // members are public for compatibility (don't use them directly,
 184     // especially that there names were chosen very unfortunately - they should
 185     // have been called width and height)
 186     int x, y;
 187
 188     // constructors
 189     wxSize() { x = y = 0; }
 190     wxSize(int xx, int yy) { Set(xx, yy); }
 191
 192     // no copy ctor or assignment operator - the defaults are ok
 193     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 194
 195     // FIXME are these really useful? If they're, we should have += &c as well
 196     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
 197     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 198
 199     // accessors
 200     void Set(int xx, int yy) { x = xx; y = yy; }
 201     void SetWidth(int w) { x = w; }
 202     void SetHeight(int h) { y = h; }
 203
 204     int GetWidth() const { return x; }
 205     int GetHeight() const { return y; }
 206
 207     // compatibility
 208     int GetX() const { return x; }
 209     int GetY() const { return y; }
 210 };
 211
 212 // ---------------------------------------------------------------------------
 213 // Point classes: with real or integer coordinates
 214 // ---------------------------------------------------------------------------
 215
 216 class WXDLLEXPORT wxRealPoint
 217 {
 218 public:
 219     double x;
 220     double y;
 221
 222     wxRealPoint() { x = y = 0.0; };
 223     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 224
 225     wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
 226     wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
 227
 228     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 229 };
 230
 231 class WXDLLEXPORT wxPoint
 232 {
 233 public:
 234     int x, y;
 235
 236     wxPoint() { x = y = 0; };
 237     wxPoint(int xx, int yy) { x = xx; y = yy; };
 238
 239     // no copy ctor or assignment operator - the defaults are ok
 240
 241     // comparison
 242     bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
 243     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 244
 245     // arithmetic operations (component wise)
 246     wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
 247     wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }
 248
 249     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
 250     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 251 };
 252
 253 #if WXWIN_COMPATIBILITY
 254     #define wxIntPoint wxPoint
 255     #define wxRectangle wxRect
 256 #endif // WXWIN_COMPATIBILITY
 257
 258 // ---------------------------------------------------------------------------
 259 // wxRect
 260 // ---------------------------------------------------------------------------
 261
 262 class WXDLLEXPORT wxRect
 263 {
 264 public:
 265     wxRect() { x = y = width = height = 0; }
 266     wxRect(int xx, int yy, int ww, int hh)
 267         { x = xx; y = yy; width = ww; height = hh; }
 268     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 269     wxRect(const wxPoint& pos, const wxSize& size);
 270
 271     // default copy ctor and assignment operators ok
 272
 273     int GetX() const { return x; }
 274     void SetX(int xx) { x = xx; }
 275
 276     int GetY() const { return y; }
 277     void SetY(int yy) { y = yy; }
 278
 279     int GetWidth() const { return width; }
 280     void SetWidth(int w) { width = w; }
 281
 282     int GetHeight() const { return height; }
 283     void SetHeight(int h) { height = h; }
 284
 285     wxPoint GetPosition() const { return wxPoint(x, y); }
 286     wxSize GetSize() const { return wxSize(width, height); }
 287
 288     // MFC-like functions
 289
 290     int GetLeft()   const { return x; }
 291     int GetTop()    const { return y; }
 292     int GetBottom() const { return y + height - 1; }
 293     int GetRight()  const { return x + width - 1; }
 294
 295     void SetLeft(int left) { x = left; }
 296     void SetRight(int right) { width = right - x + 1; }
 297     void SetTop(int top) { y = top; }
 298     void SetBottom(int bottom) { height = bottom - y + 1; }
 299
 300     bool operator==(const wxRect& rect) const;
 301     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 302
 303     bool Inside(int cx, int cy) const;
 304     wxRect operator + (const wxRect& rect) const;
 305     const wxRect& operator += (const wxRect& rect);
 306
 307 public:
 308     int x, y, width, height;
 309 };
 310
 311 // ---------------------------------------------------------------------------
 312 // Management of pens, brushes and fonts
 313 // ---------------------------------------------------------------------------
 314
 315 class WXDLLEXPORT wxPenList : public wxList
 316 {
 317     DECLARE_DYNAMIC_CLASS(wxPenList)
 318
 319 public:
 320     wxPenList() { }
 321     ~wxPenList();
 322
 323     void AddPen(wxPen *pen);
 324     void RemovePen(wxPen *pen);
 325     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
 326 };
 327
 328 class WXDLLEXPORT wxBrushList : public wxList
 329 {
 330     DECLARE_DYNAMIC_CLASS(wxBrushList)
 331
 332 public:
 333     wxBrushList() { }
 334     ~wxBrushList();
 335
 336     void AddBrush(wxBrush *brush);
 337     void RemoveBrush(wxBrush *brush);
 338     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 339 };
 340
 341 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 342
 343 class WXDLLEXPORT wxFontList : public wxList
 344 {
 345     DECLARE_DYNAMIC_CLASS(wxFontList)
 346
 347 public:
 348     wxFontList() { }
 349     ~wxFontList();
 350
 351     void AddFont(wxFont *font);
 352     void RemoveFont(wxFont *font);
 353     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
 354                              bool underline = FALSE,
 355                              const wxString& face = wxEmptyString,
 356                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 357 };
 358
 359 class WXDLLEXPORT wxColourDatabase : public wxList
 360 {
 361     DECLARE_CLASS(wxColourDatabase)
 362
 363 public:
 364     wxColourDatabase(int type);
 365     ~wxColourDatabase() ;
 366
 367     // Not const because it may add a name to the database
 368     wxColour *FindColour(const wxString& colour) ;
 369     wxString FindName(const wxColour& colour) const;
 370     void Initialize();
 371 };
 372
 373 class WXDLLEXPORT wxBitmapList : public wxList
 374 {
 375     DECLARE_DYNAMIC_CLASS(wxBitmapList)
 376
 377 public:
 378     wxBitmapList();
 379     ~wxBitmapList();
 380
 381     void AddBitmap(wxBitmap *bitmap);
 382     void RemoveBitmap(wxBitmap *bitmap);
 383 };
 384
 385 class WXDLLEXPORT wxResourceCache: public wxList
 386 {
 387 public:
 388     wxResourceCache() { }
 389     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 390     ~wxResourceCache();
 391
 392 private:
 393     DECLARE_DYNAMIC_CLASS(wxResourceCache)
 394 };
 395
 396 // ---------------------------------------------------------------------------
 397 // global variables
 398 // ---------------------------------------------------------------------------
 399
 400 // Lists of GDI objects
 401 WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
 402 WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
 403 WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
 404 WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
 405
 406 // Stock objects
 407 WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
 408 WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
 409 WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
 410 WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
 411
 412 WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
 413 WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
 414 WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
 415 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
 416 WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
 417 WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
 418 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
 419 WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
 420 WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
 421 WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
 422
 423 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
 424 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
 425 WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
 426 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
 427 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
 428 WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
 429 WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
 430 WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
 431 WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
 432 WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
 433
 434 WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
 435 WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
 436 WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
 437 WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
 438 WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
 439 WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
 440 WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
 441
 442 // 'Null' objects
 443 WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
 444 WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
 445 WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
 446 WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
 447 WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
 448 WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
 449 WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
 450 WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
 451
 452 // Stock cursors types
 453 WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
 454 WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
 455 WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
 456
 457 WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
 458
 459 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
 460
 461 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
 462 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
 463
 464 // The list of objects which should be deleted
 465 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
 466
 467 // ---------------------------------------------------------------------------
 468 // global functions
 469 // ---------------------------------------------------------------------------
 470
 471 // resource management
 472 extern void WXDLLEXPORT wxInitializeStockObjects();
 473 extern void WXDLLEXPORT wxInitializeStockLists();
 474 extern void WXDLLEXPORT wxDeleteStockObjects();
 475 extern void WXDLLEXPORT wxDeleteStockLists();
 476
 477 // is the display colour (or monochrome)?
 478 extern bool WXDLLEXPORT wxColourDisplay();
 479
 480 // Returns depth of screen
 481 extern int WXDLLEXPORT wxDisplayDepth();
 482 #define wxGetDisplayDepth wxDisplayDepth
 483
 484 // get the diaplay size
 485 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 486 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 487
 488 // set global cursor
 489 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 490
 491 #endif
 492     // _WX_GDICMNH__