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