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