[wxWidgets.git] / include / wx / gdicmn.h

/////////////////////////////////////////////////////////////////////////////
// Name:        gdicmn.h
// Purpose:     Common GDI classes, types and declarations
// Author:      Julian Smart
// Modified by:
// Created:     01/02/97
// RCS-ID:      $Id$
// Copyright:   (c)
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_GDICMNH__
#define _WX_GDICMNH__

// ---------------------------------------------------------------------------
// headers
// ---------------------------------------------------------------------------

#ifdef __GNUG__
    #pragma interface "gdicmn.h"
#endif

#include "wx/object.h"
#include "wx/list.h"
#include "wx/hash.h"
#include "wx/string.h"
#include "wx/setup.h"
#include "wx/colour.h"
#include "wx/font.h"

// ---------------------------------------------------------------------------
// forward declarations
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxBitmap;
class WXDLLEXPORT wxBrush;
class WXDLLEXPORT wxColour;
class WXDLLEXPORT wxCursor;
class WXDLLEXPORT wxFont;
class WXDLLEXPORT wxIcon;
class WXDLLEXPORT wxPalette;
class WXDLLEXPORT wxPen;
class WXDLLEXPORT wxRegion;
class WXDLLEXPORT wxString;

// ---------------------------------------------------------------------------
// constants
// ---------------------------------------------------------------------------

// Bitmap flags
enum
{
    wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
    wxBITMAP_TYPE_BMP,
    wxBITMAP_TYPE_BMP_RESOURCE,
    wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
    wxBITMAP_TYPE_ICO,
    wxBITMAP_TYPE_ICO_RESOURCE,
    wxBITMAP_TYPE_CUR,
    wxBITMAP_TYPE_CUR_RESOURCE,
    wxBITMAP_TYPE_XBM,
    wxBITMAP_TYPE_XBM_DATA,
    wxBITMAP_TYPE_XPM,
    wxBITMAP_TYPE_XPM_DATA,
    wxBITMAP_TYPE_TIF,
    wxBITMAP_TYPE_TIF_RESOURCE,
    wxBITMAP_TYPE_GIF,
    wxBITMAP_TYPE_GIF_RESOURCE,
    wxBITMAP_TYPE_PNG,
    wxBITMAP_TYPE_PNG_RESOURCE,
    wxBITMAP_TYPE_JPEG,
    wxBITMAP_TYPE_JPEG_RESOURCE,
    wxBITMAP_TYPE_PNM,
    wxBITMAP_TYPE_PNM_RESOURCE,
    wxBITMAP_TYPE_PCX,
    wxBITMAP_TYPE_PCX_RESOURCE,
    wxBITMAP_TYPE_PICT,
    wxBITMAP_TYPE_PICT_RESOURCE,
    wxBITMAP_TYPE_ICON,
    wxBITMAP_TYPE_ICON_RESOURCE,
    wxBITMAP_TYPE_MACCURSOR,
    wxBITMAP_TYPE_MACCURSOR_RESOURCE,
    wxBITMAP_TYPE_ANY = 50
};

// Standard cursors
enum wxStockCursor
{
    wxCURSOR_NONE,          // should be 0
    wxCURSOR_ARROW,
    wxCURSOR_BULLSEYE,
    wxCURSOR_CHAR,
    wxCURSOR_CROSS,
    wxCURSOR_HAND,
    wxCURSOR_IBEAM,
    wxCURSOR_LEFT_BUTTON,
    wxCURSOR_MAGNIFIER,
    wxCURSOR_MIDDLE_BUTTON,
    wxCURSOR_NO_ENTRY,
    wxCURSOR_PAINT_BRUSH,
    wxCURSOR_PENCIL,
    wxCURSOR_POINT_LEFT,
    wxCURSOR_POINT_RIGHT,
    wxCURSOR_QUESTION_ARROW,
    wxCURSOR_RIGHT_BUTTON,
    wxCURSOR_SIZENESW,
    wxCURSOR_SIZENS,
    wxCURSOR_SIZENWSE,
    wxCURSOR_SIZEWE,
    wxCURSOR_SIZING,
    wxCURSOR_SPRAYCAN,
    wxCURSOR_WAIT,
    wxCURSOR_WATCH,
    wxCURSOR_BLANK,
#ifdef __WXGTK__
    wxCURSOR_DEFAULT, // standard X11 cursor
#endif
#ifdef __X__
    // Not yet implemented for Windows
    wxCURSOR_CROSS_REVERSE,
    wxCURSOR_DOUBLE_ARROW,
    wxCURSOR_BASED_ARROW_UP,
    wxCURSOR_BASED_ARROW_DOWN,
#endif // X11

    wxCURSOR_MAX
};

// ---------------------------------------------------------------------------
// macros
// ---------------------------------------------------------------------------

/* Useful macro for creating icons portably, for example:

    wxIcon *icon = new wxICON(mondrian);

  expands into:

    wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
    wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 */

#ifdef __WXMSW__
    // Load from a resource
    #define wxICON(X) wxIcon("" #X "")
#elif defined(__WXPM__)
    // Load from a resource
    #define wxICON(X) wxIcon("" #X "")
#elif defined(__WXGTK__)
    // Initialize from an included XPM
    #define wxICON(X) wxIcon( (const char**) X##_xpm )
#elif defined(__WXMOTIF__)
    // Initialize from an included XPM
    #define wxICON(X) wxIcon( X##_xpm )
#else
    // This will usually mean something on any platform
    #define wxICON(X) wxIcon("" #X "")
#endif // platform

/* Another macro: this one is for portable creation of bitmaps. We assume that
   under Unix bitmaps live in XPMs and under Windows they're in ressources.
 */

#if defined(__WXMSW__) || defined(__WXPM__)
    #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
#else // !(Windows || OS2)
    #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
#endif // platform

// ===========================================================================
// classes
// ===========================================================================

// ---------------------------------------------------------------------------
// wxSize
// ---------------------------------------------------------------------------
class WXDLLEXPORT wxSize
{
public:
    // members are public for compatibility (don't use them directly,
    // especially that there names were chosen very unfortunately - they should
    // have been called width and height)
    int x, y;

    // constructors
    wxSize() { x = y = 0; }
    wxSize(int xx, int yy) { Set(xx, yy); }

    // no copy ctor or assignment operator - the defaults are ok
    bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }

    // FIXME are these really useful? If they're, we should have += &c as well
    wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
    wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }

    // accessors
    void Set(int xx, int yy) { x = xx; y = yy; }
    void SetWidth(int w) { x = w; }
    void SetHeight(int h) { y = h; }

    int GetWidth() const { return x; }
    int GetHeight() const { return y; }

    // compatibility
    int GetX() const { return x; }
    int GetY() const { return y; }
};

// ---------------------------------------------------------------------------
// Point classes: with real or integer coordinates
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxRealPoint
{
public:
    double x;
    double y;

    wxRealPoint() { x = y = 0.0; };
    wxRealPoint(double xx, double yy) { x = xx; y = yy; };

    wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
    wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }

    bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
};

class WXDLLEXPORT wxPoint
{
public:
    int x, y;

    wxPoint() { x = y = 0; };
    wxPoint(int xx, int yy) { x = xx; y = yy; };

    // no copy ctor or assignment operator - the defaults are ok

    // comparison
    bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
    bool operator!=(const wxPoint& p) const { return !(*this == p); }

    // arithmetic operations (component wise)
    wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
    wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }

    wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
    wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
};

#if WXWIN_COMPATIBILITY
    #define wxIntPoint wxPoint
    #define wxRectangle wxRect
#endif // WXWIN_COMPATIBILITY

// ---------------------------------------------------------------------------
// wxRect
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxRect
{
public:
    wxRect() { x = y = width = height = 0; }
    wxRect(int xx, int yy, int ww, int hh)
        { x = xx; y = yy; width = ww; height = hh; }
    wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
    wxRect(const wxPoint& pos, const wxSize& size);

    // default copy ctor and assignment operators ok

    int GetX() const { return x; }
    void SetX(int xx) { x = xx; }

    int GetY() const { return y; }
    void SetY(int yy) { y = yy; }

    int GetWidth() const { return width; }
    void SetWidth(int w) { width = w; }

    int GetHeight() const { return height; }
    void SetHeight(int h) { height = h; }

    wxPoint GetPosition() const { return wxPoint(x, y); }
    wxSize GetSize() const { return wxSize(width, height); }

    // MFC-like functions

    int GetLeft()   const { return x; }
    int GetTop()    const { return y; }
    int GetBottom() const { return y + height - 1; }
    int GetRight()  const { return x + width - 1; }

    void SetLeft(int left) { x = left; }
    void SetRight(int right) { width = right - x + 1; }
    void SetTop(int top) { y = top; }
    void SetBottom(int bottom) { height = bottom - y + 1; }

    bool operator==(const wxRect& rect) const;
    bool operator!=(const wxRect& rect) const { return !(*this == rect); }

    bool Inside(int cx, int cy) const;
    wxRect operator + (const wxRect& rect) const;
    const wxRect& operator += (const wxRect& rect);

public:
    int x, y, width, height;
};

// ---------------------------------------------------------------------------
// Management of pens, brushes and fonts
// ---------------------------------------------------------------------------

class WXDLLEXPORT wxPenList : public wxList
{
    DECLARE_DYNAMIC_CLASS(wxPenList)

public:
    wxPenList() { }
    ~wxPenList();

    void AddPen(wxPen *pen);
    void RemovePen(wxPen *pen);
    wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
};

class WXDLLEXPORT wxBrushList : public wxList
{
    DECLARE_DYNAMIC_CLASS(wxBrushList)

public:
    wxBrushList() { }
    ~wxBrushList();

    void AddBrush(wxBrush *brush);
    void RemoveBrush(wxBrush *brush);
    wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
};

WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;

class WXDLLEXPORT wxFontList : public wxList
{
    DECLARE_DYNAMIC_CLASS(wxFontList)

public:
    wxFontList() { }
    ~wxFontList();

    void AddFont(wxFont *font);
    void RemoveFont(wxFont *font);
    wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
                             bool underline = FALSE,
                             const wxString& face = wxEmptyString,
                             wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
};

class WXDLLEXPORT wxColourDatabase : public wxList
{
    DECLARE_CLASS(wxColourDatabase)

public:
    wxColourDatabase(int type);
    ~wxColourDatabase() ;

    // Not const because it may add a name to the database
    wxColour *FindColour(const wxString& colour) ;
    wxString FindName(const wxColour& colour) const;
    void Initialize();
};

class WXDLLEXPORT wxBitmapList : public wxList
{
    DECLARE_DYNAMIC_CLASS(wxBitmapList)

public:
    wxBitmapList();
    ~wxBitmapList();

    void AddBitmap(wxBitmap *bitmap);
    void RemoveBitmap(wxBitmap *bitmap);
};

class WXDLLEXPORT wxResourceCache: public wxList
{
public:
    wxResourceCache() { }
    wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
    ~wxResourceCache();

private:
    DECLARE_DYNAMIC_CLASS(wxResourceCache)
};

// ---------------------------------------------------------------------------
// global variables
// ---------------------------------------------------------------------------

// Lists of GDI objects
WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;

// Stock objects
WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;

WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;

WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;

WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;

// 'Null' objects
WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;

// Stock cursors types
WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;

WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;

WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;

WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;

// The list of objects which should be deleted
WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;

// ---------------------------------------------------------------------------
// global functions
// ---------------------------------------------------------------------------

// resource management
extern void WXDLLEXPORT wxInitializeStockObjects();
extern void WXDLLEXPORT wxInitializeStockLists();
extern void WXDLLEXPORT wxDeleteStockObjects();
extern void WXDLLEXPORT wxDeleteStockLists();

// is the display colour (or monochrome)?
extern bool WXDLLEXPORT wxColourDisplay();

// Returns depth of screen
extern int WXDLLEXPORT wxDisplayDepth();
#define wxGetDisplayDepth wxDisplayDepth

// get the diaplay size
extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
extern wxSize WXDLLEXPORT wxGetDisplaySize();

// set global cursor
extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);

#endif
    // _WX_GDICMNH__
Commit	Line	Data
c801d85f KB	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)
f03fc89f	9	// Licence: wxWindows licence
c801d85f KB	10	/////////////////////////////////////////////////////////////////////////////
c801d85f KB	11
34138703 JS	12	#ifndef _WX_GDICMNH__
34138703 JS	13	#define _WX_GDICMNH__
c801d85f	14
f03fc89f VZ	15	// ---------------------------------------------------------------------------
	16	// headers
	17	// ---------------------------------------------------------------------------
	18
c801d85f	19	#ifdef __GNUG__
f03fc89f	20	#pragma interface "gdicmn.h"
c801d85f KB	21	#endif
	22
	23	#include "wx/object.h"
	24	#include "wx/list.h"
	25	#include "wx/hash.h"
34138703	26	#include "wx/string.h"
c801d85f	27	#include "wx/setup.h"
34138703	28	#include "wx/colour.h"
37bebc11	29	#include "wx/font.h"
c801d85f	30
f03fc89f VZ	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	{
6d167489 VZ	53	wxBITMAP_TYPE_INVALID, // should be == 0 for compatibility!
6d167489 VZ	54	wxBITMAP_TYPE_BMP,
f03fc89f VZ	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,
bcc46c75 SB	73	wxBITMAP_TYPE_PNM,
bcc46c75 SB	74	wxBITMAP_TYPE_PNM_RESOURCE,
6523d119 GRG	75	wxBITMAP_TYPE_PCX,
6523d119 GRG	76	wxBITMAP_TYPE_PCX_RESOURCE,
6d167489 VZ	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,
f03fc89f VZ	83	wxBITMAP_TYPE_ANY = 50
	84	};
	85
c801d85f	86	// Standard cursors
f03fc89f VZ	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,
ae53c98c KB	115	#ifdef __WXGTK__
	116	wxCURSOR_DEFAULT, // standard X11 cursor
	117	#endif
c801d85f	118	#ifdef __X__
f03fc89f VZ	119	// Not yet implemented for Windows
	120	wxCURSOR_CROSS_REVERSE,
	121	wxCURSOR_DOUBLE_ARROW,
	122	wxCURSOR_BASED_ARROW_UP,
ea804aad	123	wxCURSOR_BASED_ARROW_DOWN,
f03fc89f VZ	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 "")
1777b9bb DW	146	#elif defined(__WXPM__)
	147	// Load from a resource
	148	#define wxICON(X) wxIcon("" #X "")
f03fc89f VZ	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
0c5d3e1c VZ	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
f03fc89f VZ	170	// ===========================================================================
	171	// classes
	172	// ===========================================================================
c801d85f	173
f03fc89f VZ	174	// ---------------------------------------------------------------------------
	175	// wxSize
	176	// ---------------------------------------------------------------------------
6a6c0a8b	177	class WXDLLEXPORT wxSize
c801d85f KB	178	{
c801d85f KB	179	public:
cc775580 VZ	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)
72cdf4c9	183	int x, y;
f03fc89f VZ	184
	185	// constructors
	186	wxSize() { x = y = 0; }
72cdf4c9	187	wxSize(int xx, int yy) { Set(xx, yy); }
f03fc89f VZ	188
f03fc89f VZ	189	// no copy ctor or assignment operator - the defaults are ok
f03fc89f VZ	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
cc775580	196	// accessors
72cdf4c9 VZ	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; }
cc775580	200
72cdf4c9 VZ	201	int GetWidth() const { return x; }
72cdf4c9 VZ	202	int GetHeight() const { return y; }
f03fc89f	203
cc775580	204	// compatibility
72cdf4c9 VZ	205	int GetX() const { return x; }
72cdf4c9 VZ	206	int GetY() const { return y; }
c801d85f KB	207	};
c801d85f KB	208
f03fc89f VZ	209	// ---------------------------------------------------------------------------
	210	// Point classes: with real or integer coordinates
	211	// ---------------------------------------------------------------------------
764a3a49	212
6a6c0a8b	213	class WXDLLEXPORT wxRealPoint
c801d85f	214	{
f03fc89f VZ	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; }
c801d85f KB	226	};
c801d85f KB	227
6a6c0a8b	228	class WXDLLEXPORT wxPoint
c801d85f	229	{
f03fc89f	230	public:
72cdf4c9	231	int x, y;
6a6c0a8b	232
f03fc89f	233	wxPoint() { x = y = 0; };
72cdf4c9	234	wxPoint(int xx, int yy) { x = xx; y = yy; };
f03fc89f VZ	235
f03fc89f VZ	236	// no copy ctor or assignment operator - the defaults are ok
6a6c0a8b	237
764a3a49 VZ	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); }
f03fc89f	245
764a3a49 VZ	246	wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
764a3a49 VZ	247	wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
c801d85f KB	248	};
	249
	250	#if WXWIN_COMPATIBILITY
f03fc89f VZ	251	#define wxIntPoint wxPoint
	252	#define wxRectangle wxRect
	253	#endif // WXWIN_COMPATIBILITY
	254
	255	// ---------------------------------------------------------------------------
	256	// wxRect
	257	// ---------------------------------------------------------------------------
c801d85f	258
6a6c0a8b JS	259	class WXDLLEXPORT wxRect
6a6c0a8b JS	260	{
c801d85f	261	public:
a23fd0e1	262	wxRect() { x = y = width = height = 0; }
72cdf4c9	263	wxRect(int xx, int yy, int ww, int hh)
a23fd0e1	264	{ x = xx; y = yy; width = ww; height = hh; }
f03fc89f VZ	265	wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
f03fc89f VZ	266	wxRect(const wxPoint& pos, const wxSize& size);
a23fd0e1 VZ	267
a23fd0e1 VZ	268	// default copy ctor and assignment operators ok
c801d85f	269
72cdf4c9 VZ	270	int GetX() const { return x; }
72cdf4c9 VZ	271	void SetX(int xx) { x = xx; }
c801d85f	272
72cdf4c9 VZ	273	int GetY() const { return y; }
72cdf4c9 VZ	274	void SetY(int yy) { y = yy; }
c801d85f	275
72cdf4c9 VZ	276	int GetWidth() const { return width; }
72cdf4c9 VZ	277	void SetWidth(int w) { width = w; }
c801d85f	278
72cdf4c9 VZ	279	int GetHeight() const { return height; }
72cdf4c9 VZ	280	void SetHeight(int h) { height = h; }
f03fc89f	281
dcb44466 JS	282	wxPoint GetPosition() const { return wxPoint(x, y); }
dcb44466 JS	283	wxSize GetSize() const { return wxSize(width, height); }
f03fc89f	284
f3c0f9e7 JS	285	// MFC-like functions
f3c0f9e7 JS	286
72cdf4c9 VZ	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; }
f03fc89f	291
72cdf4c9 VZ	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; }
dcb44466	296
764a3a49 VZ	297	bool operator==(const wxRect& rect) const;
764a3a49 VZ	298	bool operator!=(const wxRect& rect) const { return !(*this == rect); }
f03fc89f	299
7742598f	300	bool Inside(int cx, int cy) const;
dcb44466 JS	301	wxRect operator + (const wxRect& rect) const;
dcb44466 JS	302	const wxRect& operator += (const wxRect& rect);
72cdf4c9	303
f03fc89f	304	public:
72cdf4c9	305	int x, y, width, height;
f03fc89f	306	};
c801d85f	307
f03fc89f	308	// ---------------------------------------------------------------------------
c801d85f	309	// Management of pens, brushes and fonts
f03fc89f VZ	310	// ---------------------------------------------------------------------------
	311
	312	class WXDLLEXPORT wxPenList : public wxList
c801d85f	313	{
f03fc89f VZ	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);
c801d85f KB	323	};
c801d85f KB	324
f03fc89f	325	class WXDLLEXPORT wxBrushList : public wxList
c801d85f	326	{
f03fc89f VZ	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);
c801d85f KB	336	};
c801d85f KB	337
9d2f3c71	338	WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
c801d85f	339
f03fc89f	340	class WXDLLEXPORT wxFontList : public wxList
c801d85f	341	{
f03fc89f VZ	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,
37bebc11 RD	352	const wxString& face = wxEmptyString,
37bebc11 RD	353	wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
c801d85f KB	354	};
c801d85f KB	355
f03fc89f	356	class WXDLLEXPORT wxColourDatabase : public wxList
c801d85f	357	{
f03fc89f VZ	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();
c801d85f KB	368	};
c801d85f KB	369
f03fc89f	370	class WXDLLEXPORT wxBitmapList : public wxList
c801d85f	371	{
f03fc89f	372	DECLARE_DYNAMIC_CLASS(wxBitmapList)
c801d85f	373
f03fc89f VZ	374	public:
	375	wxBitmapList();
	376	~wxBitmapList();
	377
	378	void AddBitmap(wxBitmap *bitmap);
	379	void RemoveBitmap(wxBitmap *bitmap);
c801d85f KB	380	};
c801d85f KB	381
f03fc89f VZ	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
c801d85f	397	// Lists of GDI objects
f03fc89f VZ	398	WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
	399	WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
	400	WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
	401	WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
c801d85f KB	402
c801d85f KB	403	// Stock objects
f03fc89f VZ	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;
c801d85f KB	438
c801d85f KB	439	// 'Null' objects
f03fc89f VZ	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;
c801d85f KB	448
c801d85f KB	449	// Stock cursors types
f03fc89f VZ	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;
c801d85f	457
f03fc89f VZ	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
6a6c0a8b	469	extern void WXDLLEXPORT wxInitializeStockObjects();
a3622daa	470	extern void WXDLLEXPORT wxInitializeStockLists();
6a6c0a8b	471	extern void WXDLLEXPORT wxDeleteStockObjects();
a3622daa	472	extern void WXDLLEXPORT wxDeleteStockLists();
c801d85f	473
f03fc89f	474	// is the display colour (or monochrome)?
6a6c0a8b	475	extern bool WXDLLEXPORT wxColourDisplay();
c801d85f KB	476
c801d85f KB	477	// Returns depth of screen
6a6c0a8b JS	478	extern int WXDLLEXPORT wxDisplayDepth();
6a6c0a8b JS	479	#define wxGetDisplayDepth wxDisplayDepth
c801d85f	480
f03fc89f	481	// get the diaplay size
c801d85f	482	extern void WXDLLEXPORT wxDisplaySize(int width, int height);
6a6c0a8b	483	extern wxSize WXDLLEXPORT wxGetDisplaySize();
c801d85f	484
f03fc89f	485	// set global cursor
c801d85f KB	486	extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
c801d85f KB	487
c801d85f	488	#endif
34138703	489	// _WX_GDICMNH__