[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"

// ---------------------------------------------------------------------------
// 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_BMP = 1,
    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_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);
};

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