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