git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: fontdata.h
	3	// Purpose: interface of wxFontData
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxFontData
	11
	12	This class holds a variety of information related to font dialogs.
	13
	14	@library{wxcore}
	15	@category{cmndlg,data}
	16
	17	@see @ref overview_cmndlg_font, wxFont, wxFontDialog
	18	*/
	19	class wxFontData : public wxObject
	20	{
	21	public:
	22	/**
	23	Constructor. Initializes @e fontColour to black, @e showHelp to @false,
	24	@e allowSymbols to @true, @e enableEffects to @true, @e minSize to 0
	25	and @e maxSize to 0.
	26	*/
	27	wxFontData();
	28
	29	/**
	30	Enables or disables "effects" under Windows or generic only. This
	31	refers to the controls for manipulating colour, strikeout and underline
	32	properties.
	33
	34	The default value is @true.
	35	*/
	36	void EnableEffects(bool enable);
	37
	38	/**
	39	Under Windows, returns a flag determining whether symbol fonts can be
	40	selected. Has no effect on other platforms.
	41
	42	The default value is @true.
	43	*/
	44	bool GetAllowSymbols() const;
	45
	46	/**
	47	Gets the font chosen by the user if the user pressed OK
	48	(wxFontDialog::ShowModal() returned wxID_OK).
	49	*/
	50	wxFont GetChosenFont() const;
	51
	52	/**
	53	Gets the colour associated with the font dialog.
	54
	55	The default value is black.
	56	*/
	57	const wxColour& GetColour() const;
	58
	59	/**
	60	Determines whether "effects" are enabled under Windows. This refers to
	61	the controls for manipulating colour, strikeout and underline
	62	properties.
	63
	64	The default value is @true.
	65	*/
	66	bool GetEnableEffects() const;
	67
	68	/**
	69	Gets the font that will be initially used by the font dialog. This
	70	should have previously been set by the application.
	71	*/
	72	wxFont GetInitialFont() const;
	73
	74	/**
	75	Returns @true if the Help button will be shown (Windows only).
	76
	77	The default value is @false.
	78	*/
	79	bool GetShowHelp() const;
	80
	81	/**
	82	Under Windows, determines whether symbol fonts can be selected. Has no
	83	effect on other platforms.
	84
	85	The default value is @true.
	86	*/
	87	void SetAllowSymbols(bool allowSymbols);
	88
	89	/**
	90	Sets the font that will be returned to the user (for internal use
	91	only).
	92	*/
	93	void SetChosenFont(const wxFont& font);
	94
	95	/**
	96	Sets the colour that will be used for the font foreground colour.
	97
	98	The default colour is black.
	99	*/
	100	void SetColour(const wxColour& colour);
	101
	102	/**
	103	Sets the font that will be initially used by the font dialog.
	104	*/
	105	void SetInitialFont(const wxFont& font);
	106
	107	/**
	108	Sets the valid range for the font point size (Windows only).
	109
	110	The default is 0, 0 (unrestricted range).
	111	*/
	112	void SetRange(int min, int max);
	113
	114	/**
	115	Determines whether the Help button will be displayed in the font dialog
	116	(Windows only).
	117
	118	The default value is @false.
	119	*/
	120	void SetShowHelp(bool showHelp);
	121
	122	/**
	123	Assignment operator for the font data.
	124	*/
	125	wxFontData& operator =(const wxFontData& data);
	126	};