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

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/font.h
// Purpose:     wxFontBase class: the interface of wxFont
// Author:      Vadim Zeitlin
// Modified by:
// Created:     20.09.99
// RCS-ID:      $Id$
// Copyright:   (c) wxWindows team
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_FONT_H_BASE_
#define _WX_FONT_H_BASE_

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

#include "wx/defs.h"        // for wxDEFAULT &c
#include "wx/gdiobj.h"      // the base class

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

class WXDLLEXPORT wxFontBase;
class WXDLLEXPORT wxFont;

// ----------------------------------------------------------------------------
// font constants
// ----------------------------------------------------------------------------

// standard font families
enum wxFontFamily
{
    wxFONTFAMILY_DEFAULT = wxDEFAULT,
    wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
    wxFONTFAMILY_ROMAN = wxROMAN,
    wxFONTFAMILY_SCRIPT = wxSCRIPT,
    wxFONTFAMILY_SWISS = wxSWISS,
    wxFONTFAMILY_MODERN = wxMODERN,
    wxFONTFAMILY_TELETYPE = wxTELETYPE,
    wxFONTFAMILY_MAX
};

// font styles
enum wxFontStyle
{
    wxFONTSTYLE_NORMAL = wxNORMAL,
    wxFONTSTYLE_ITALIC = wxITALIC,
    wxFONTSTYLE_SLANT = wxSLANT,
    wxFONTSTYLE_MAX
};

// font weights
enum wxFontWeight
{
    wxFONTWEIGHT_NORMAL = wxNORMAL,
    wxFONTWEIGHT_LIGHT = wxLIGHT,
    wxFONTWEIGHT_BOLD = wxBOLD,
    wxFONTWEIGHT_MAX
};

// font encodings
enum wxFontEncoding
{
    wxFONTENCODING_SYSTEM = -1,     // system default
    wxFONTENCODING_DEFAULT,         // current default encoding

    // ISO8859 standard defines a number of single-byte charsets
    wxFONTENCODING_ISO8859_1,       // West European (Latin1)
    wxFONTENCODING_ISO8859_2,       // Central and East European (Latin2)
    wxFONTENCODING_ISO8859_3,       // Esperanto (Latin3)
    wxFONTENCODING_ISO8859_4,       // Baltic languages (Estonian) (Latin4)
    wxFONTENCODING_ISO8859_5,       // Cyrillic
    wxFONTENCODING_ISO8859_6,       // Arabic
    wxFONTENCODING_ISO8859_7,       // Greek
    wxFONTENCODING_ISO8859_8,       // Hebrew
    wxFONTENCODING_ISO8859_9,       // Turkish (Latin5)
    wxFONTENCODING_ISO8859_10,      // Variation of Latin4 (Latin6)
    wxFONTENCODING_ISO8859_11,      // Thai
    wxFONTENCODING_ISO8859_12,      // doesn't exist currently, but put it
                                    // here anyhow to make all ISO8859
                                    // consecutive numbers
    wxFONTENCODING_ISO8859_13,      // Latin7
    wxFONTENCODING_ISO8859_14,      // Latin8
    wxFONTENCODING_ISO8859_15,      // Latin9 (a.k.a. Latin0, includes euro)

    // Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
    wxFONTENCODING_KOI8,            // we don't support any of KOI8 variants
    wxFONTENCODING_ALTERNATIVE,     // same as MS-DOS CP866
    wxFONTENCODING_BULGARIAN,       // used under Linux in Bulgaria

    // what would we do without Microsoft? They have their own encodings
        // for DOS
    wxFONTENCODING_CP437,           // original MS-DOS codepage
    wxFONTENCODING_CP850,           // CP437 merged with Latin1
    wxFONTENCODING_CP852,           // CP437 merged with Latin2
    wxFONTENCODING_CP855,           // another cyrillic encoding
    wxFONTENCODING_CP866,           // and another one
        // and for Windows
    wxFONTENCODING_CP1250,          // WinLatin2
    wxFONTENCODING_CP1251,          // WinCyrillic
    wxFONTENCODING_CP1252,          // WinLatin1

    wxFONTENCODING_MAX
};

// ----------------------------------------------------------------------------
// wxFontBase represents a font object
// ----------------------------------------------------------------------------

class wxFontBase : public wxGDIObject
{
public:
    // creator function
    static wxFont *New(
        int pointSize,              // size of the font in points
        int family,                 // see wxFontFamily enum
        int style,                  // see wxFontStyle enum
        int weight,                 // see wxFontWeight enum
        bool underlined = FALSE,    // not underlined by default
        const wxString& face = wxEmptyString,              // facename
        wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...

    // was the font successfully created?
    bool Ok() const { return m_refData != NULL; }

    // comparison
    bool operator == (const wxFont& font) const;
    bool operator != (const wxFont& font) const;

    // accessors: get the font characteristics
    virtual int GetPointSize() const = 0;
    virtual int GetFamily() const = 0;
    virtual int GetStyle() const = 0;
    virtual int GetWeight() const = 0;
    virtual bool GetUnderlined() const = 0;
    virtual wxString GetFaceName() const = 0;
    virtual wxFontEncoding GetEncoding() const = 0;

    // change the font characteristics
    virtual void SetPointSize( int pointSize ) = 0;
    virtual void SetFamily( int family ) = 0;
    virtual void SetStyle( int style ) = 0;
    virtual void SetWeight( int weight ) = 0;
    virtual void SetFaceName( const wxString& faceName ) = 0;
    virtual void SetUnderlined( bool underlined ) = 0;
    virtual void SetEncoding(wxFontEncoding encoding) = 0;

    // translate the fonts into human-readable string (i.e. GetStyleString()
    // will return "wxITALIC" for an italic font, ...)
    wxString GetFamilyString() const;
    wxString GetStyleString() const;
    wxString GetWeightString() const;

    // the default encoding is used for creating all fonts with default
    // encoding parameter
    static wxFontEncoding GetDefaultEncoding()
        { return ms_encodingDefault; }
    static void SetDefaultEncoding(wxFontEncoding encoding)
        { ms_encodingDefault = encoding; }

protected:
    // get the internal data
    class WXDLLEXPORT wxFontRefData *GetFontData() const
        { return (wxFontRefData *)m_refData; }

private:
    // the currently default encoding: by default, it's the default system
    // encoding, but may be changed by the application using
    // SetDefaultEncoding() to make all subsequent fonts created without
    // specifing encoding parameter using this encoding
    static wxFontEncoding ms_encodingDefault;
};

// include the real class declaration
#if defined(__WXMSW__)
    #include "wx/msw/font.h"
#elif defined(__WXMOTIF__)
    #include "wx/motif/font.h"
#elif defined(__WXGTK__)
    #include "wx/gtk/font.h"
#elif defined(__WXQT__)
    #include "wx/qt/font.h"
#elif defined(__WXMAC__)
    #include "wx/mac/font.h"
#elif defined(__WXPM__)
    #include "wx/os2/font.h"
#elif defined(__WXSTUBS__)
    #include "wx/stubs/font.h"
#endif

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

#define M_FONTDATA GetFontData()

#endif
    // _WX_FONT_H_BASE_
Commit	Line	Data
0c5d3e1c VZ	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: wx/font.h
	3	// Purpose: wxFontBase class: the interface of wxFont
	4	// Author: Vadim Zeitlin
	5	// Modified by:
	6	// Created: 20.09.99
	7	// RCS-ID: $Id$
	8	// Copyright: (c) wxWindows team
	9	// Licence: wxWindows license
	10	/////////////////////////////////////////////////////////////////////////////
	11
34138703 JS	12	#ifndef _WX_FONT_H_BASE_
34138703 JS	13	#define _WX_FONT_H_BASE_
c801d85f	14
0c5d3e1c VZ	15	// ----------------------------------------------------------------------------
	16	// headers
	17	// ----------------------------------------------------------------------------
	18
	19	#include "wx/defs.h" // for wxDEFAULT &c
	20	#include "wx/gdiobj.h" // the base class
	21
	22	// ----------------------------------------------------------------------------
	23	// forward declarations
	24	// ----------------------------------------------------------------------------
	25
	26	class WXDLLEXPORT wxFontBase;
	27	class WXDLLEXPORT wxFont;
	28
	29	// ----------------------------------------------------------------------------
	30	// font constants
	31	// ----------------------------------------------------------------------------
	32
	33	// standard font families
	34	enum wxFontFamily
	35	{
	36	wxFONTFAMILY_DEFAULT = wxDEFAULT,
	37	wxFONTFAMILY_DECORATIVE = wxDECORATIVE,
	38	wxFONTFAMILY_ROMAN = wxROMAN,
	39	wxFONTFAMILY_SCRIPT = wxSCRIPT,
	40	wxFONTFAMILY_SWISS = wxSWISS,
	41	wxFONTFAMILY_MODERN = wxMODERN,
	42	wxFONTFAMILY_TELETYPE = wxTELETYPE,
	43	wxFONTFAMILY_MAX
	44	};
	45
	46	// font styles
	47	enum wxFontStyle
	48	{
	49	wxFONTSTYLE_NORMAL = wxNORMAL,
	50	wxFONTSTYLE_ITALIC = wxITALIC,
	51	wxFONTSTYLE_SLANT = wxSLANT,
	52	wxFONTSTYLE_MAX
	53	};
	54
	55	// font weights
	56	enum wxFontWeight
	57	{
	58	wxFONTWEIGHT_NORMAL = wxNORMAL,
	59	wxFONTWEIGHT_LIGHT = wxLIGHT,
	60	wxFONTWEIGHT_BOLD = wxBOLD,
	61	wxFONTWEIGHT_MAX
	62	};
	63
	64	// font encodings
	65	enum wxFontEncoding
	66	{
	67	wxFONTENCODING_SYSTEM = -1, // system default
	68	wxFONTENCODING_DEFAULT, // current default encoding
	69
	70	// ISO8859 standard defines a number of single-byte charsets
	71	wxFONTENCODING_ISO8859_1, // West European (Latin1)
	72	wxFONTENCODING_ISO8859_2, // Central and East European (Latin2)
	73	wxFONTENCODING_ISO8859_3, // Esperanto (Latin3)
	74	wxFONTENCODING_ISO8859_4, // Baltic languages (Estonian) (Latin4)
	75	wxFONTENCODING_ISO8859_5, // Cyrillic
	76	wxFONTENCODING_ISO8859_6, // Arabic
	77	wxFONTENCODING_ISO8859_7, // Greek
	78	wxFONTENCODING_ISO8859_8, // Hebrew
79	wxFONTENCODING_ISO8859_9, // Turkish (Latin5)
80	wxFONTENCODING_ISO8859_10, // Variation of Latin4 (Latin6)
81	wxFONTENCODING_ISO8859_11, // Thai
82	wxFONTENCODING_ISO8859_12, // doesn't exist currently, but put it
83	// here anyhow to make all ISO8859
84	// consecutive numbers
85	wxFONTENCODING_ISO8859_13, // Latin7
86	wxFONTENCODING_ISO8859_14, // Latin8
87	wxFONTENCODING_ISO8859_15, // Latin9 (a.k.a. Latin0, includes euro)
88
89	// Cyrillic charset soup (see http://czyborra.com/charsets/cyrillic.html)
90	wxFONTENCODING_KOI8, // we don't support any of KOI8 variants
91	wxFONTENCODING_ALTERNATIVE, // same as MS-DOS CP866
92	wxFONTENCODING_BULGARIAN, // used under Linux in Bulgaria
93
94	// what would we do without Microsoft? They have their own encodings
95	// for DOS
96	wxFONTENCODING_CP437, // original MS-DOS codepage
97	wxFONTENCODING_CP850, // CP437 merged with Latin1
98	wxFONTENCODING_CP852, // CP437 merged with Latin2
99	wxFONTENCODING_CP855, // another cyrillic encoding
b9b3ccd9	100	wxFONTENCODING_CP866, // and another one
0c5d3e1c VZ	101	// and for Windows
	102	wxFONTENCODING_CP1250, // WinLatin2
	103	wxFONTENCODING_CP1251, // WinCyrillic
	104	wxFONTENCODING_CP1252, // WinLatin1
	105
	106	wxFONTENCODING_MAX
	107	};
	108
	109	// ----------------------------------------------------------------------------
	110	// wxFontBase represents a font object
	111	// ----------------------------------------------------------------------------
	112
	113	class wxFontBase : public wxGDIObject
	114	{
	115	public:
	116	// creator function
	117	static wxFont *New(
	118	int pointSize, // size of the font in points
	119	int family, // see wxFontFamily enum
	120	int style, // see wxFontStyle enum
	121	int weight, // see wxFontWeight enum
	122	bool underlined = FALSE, // not underlined by default
	123	const wxString& face = wxEmptyString, // facename
	124	wxFontEncoding encoding = wxFONTENCODING_DEFAULT); // ISO8859-X, ...
	125
	126	// was the font successfully created?
	127	bool Ok() const { return m_refData != NULL; }
	128
	129	// comparison
	130	bool operator == (const wxFont& font) const;
	131	bool operator != (const wxFont& font) const;
	132
	133	// accessors: get the font characteristics
	134	virtual int GetPointSize() const = 0;
	135	virtual int GetFamily() const = 0;
	136	virtual int GetStyle() const = 0;
	137	virtual int GetWeight() const = 0;
	138	virtual bool GetUnderlined() const = 0;
	139	virtual wxString GetFaceName() const = 0;
	140	virtual wxFontEncoding GetEncoding() const = 0;
	141
	142	// change the font characteristics
	143	virtual void SetPointSize( int pointSize ) = 0;
	144	virtual void SetFamily( int family ) = 0;
	145	virtual void SetStyle( int style ) = 0;
	146	virtual void SetWeight( int weight ) = 0;
	147	virtual void SetFaceName( const wxString& faceName ) = 0;
	148	virtual void SetUnderlined( bool underlined ) = 0;
	149	virtual void SetEncoding(wxFontEncoding encoding) = 0;
	150
	151	// translate the fonts into human-readable string (i.e. GetStyleString()
	152	// will return "wxITALIC" for an italic font, ...)
	153	wxString GetFamilyString() const;
	154	wxString GetStyleString() const;
	155	wxString GetWeightString() const;
	156
	157	// the default encoding is used for creating all fonts with default
	158	// encoding parameter
	159	static wxFontEncoding GetDefaultEncoding()
	160	{ return ms_encodingDefault; }
	161	static void SetDefaultEncoding(wxFontEncoding encoding)
	162	{ ms_encodingDefault = encoding; }
	163
	164	protected:
165	// get the internal data
166	class WXDLLEXPORT wxFontRefData *GetFontData() const
167	{ return (wxFontRefData *)m_refData; }
168
169	private:
170	// the currently default encoding: by default, it's the default system
171	// encoding, but may be changed by the application using
172	// SetDefaultEncoding() to make all subsequent fonts created without
173	// specifing encoding parameter using this encoding
174	static wxFontEncoding ms_encodingDefault;
175	};
176
177	// include the real class declaration
2049ba38	178	#if defined(__WXMSW__)
0c5d3e1c	179	#include "wx/msw/font.h"
2049ba38	180	#elif defined(__WXMOTIF__)
0c5d3e1c	181	#include "wx/motif/font.h"
2049ba38	182	#elif defined(__WXGTK__)
0c5d3e1c	183	#include "wx/gtk/font.h"
b4e76e0d	184	#elif defined(__WXQT__)
0c5d3e1c	185	#include "wx/qt/font.h"
34138703	186	#elif defined(__WXMAC__)
0c5d3e1c	187	#include "wx/mac/font.h"
1777b9bb	188	#elif defined(__WXPM__)
0c5d3e1c	189	#include "wx/os2/font.h"
34138703	190	#elif defined(__WXSTUBS__)
0c5d3e1c	191	#include "wx/stubs/font.h"
c801d85f KB	192	#endif
c801d85f KB	193
0c5d3e1c VZ	194	// ----------------------------------------------------------------------------
	195	// macros
	196	// ----------------------------------------------------------------------------
	197
0c5d3e1c VZ	198	#define M_FONTDATA GetFontData()
0c5d3e1c VZ	199
c801d85f	200	#endif
34138703	201	// _WX_FONT_H_BASE_