#include <wx/richtext/richtextbuffer.h>

Inheritance diagram for wxRichTextAttr:

Detailed Description

A class representing enhanced attributes for rich text objects.

This adds a wxTextBoxAttr member to the basic wxTextAttr class.

See Also: wxTextAttr, wxTextBoxAttr, wxRichTextCtrl

Public Member Functions
	wxRichTextAttr (const wxTextAttr &attr)
	Constructor taking a wxTextAttr.

	wxRichTextAttr (const wxRichTextAttr &attr)
	Copy constructor.

	wxRichTextAttr ()
	Default constructor.

void	Copy (const wxRichTextAttr &attr)
	Copy function.

void	operator= (const wxRichTextAttr &attr)
	Assignment operator.

void	operator= (const wxTextAttr &attr)
	Assignment operator.

bool	operator== (const wxRichTextAttr &attr) const
	Equality test.

bool	EqPartial (const wxRichTextAttr &attr, bool weakTest=true) const
	Partial equality test.

bool	Apply (const wxRichTextAttr &style, const wxRichTextAttr *compareWith=NULL)
	Merges the given attributes.

void	CollectCommonAttributes (const wxRichTextAttr &attr, wxRichTextAttr &clashingAttr, wxRichTextAttr &absentAttr)
	Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.

bool	RemoveStyle (const wxRichTextAttr &attr)
	Removes the specified attributes from this object.

wxTextBoxAttr &	GetTextBoxAttr ()
	Returns the text box attributes.

const wxTextBoxAttr &	GetTextBoxAttr () const

void	SetTextBoxAttr (const wxTextBoxAttr &attr)
	Set the text box attributes.

bool	IsDefault () const
	Returns true if no attributes are set.

Public Member Functions inherited from wxTextAttr
bool	Apply (const wxTextAttr &style, const wxTextAttr *compareWith=NULL)
	Applies the attributes in style to the original object, but not those attributes from style that are the same as those in compareWith (if passed).

void	Merge (const wxTextAttr &overlay)
	Copies all defined/valid properties from overlay to current object.

bool	EqPartial (const wxTextAttr &attr, bool weakTest=true) const
	Partial equality test.

void	operator= (const wxTextAttr &attr)
	Assignment from a wxTextAttr object.

	wxTextAttr ()
	Constructors.

	wxTextAttr (const wxColour &colText, const wxColour &colBack=wxNullColour, const wxFont &font=wxNullFont, wxTextAttrAlignment alignment=wxTEXT_ALIGNMENT_DEFAULT)
	Constructors.

	wxTextAttr (const wxTextAttr &attr)
	Constructors.

wxTextAttrAlignment	GetAlignment () const
	Returns the alignment flags.

const wxColour &	GetBackgroundColour () const
	Returns the background colour.

const wxString &	GetBulletFont () const
	Returns a string containing the name of the font associated with the bullet symbol.

const wxString &	GetBulletName () const
	Returns the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.

int	GetBulletNumber () const
	Returns the bullet number.

int	GetBulletStyle () const
	Returns the bullet style.

const wxString &	GetBulletText () const
	Returns the bullet text, which could be a symbol, or (for example) cached outline text.

const wxString &	GetCharacterStyleName () const
	Returns the name of the character style.

long	GetFlags () const
	Returns flags indicating which attributes are applicable.

wxFont	GetFont () const
	Creates and returns a font specified by the font attributes in the wxTextAttr object.

bool	GetFontAttributes (const wxFont &font, int flags=wxTEXT_ATTR_FONT)
	Gets the font attributes from the given font, using only the attributes specified by flags.

wxFontEncoding	GetFontEncoding () const
	Returns the font encoding.

const wxString &	GetFontFaceName () const
	Returns the font face name.

wxFontFamily	GetFontFamily () const
	Returns the font family.

int	GetFontSize () const
	Returns the font size in points.

wxFontStyle	GetFontStyle () const
	Returns the font style.

bool	GetFontUnderlined () const
	Returns true if the font is underlined.

wxFontWeight	GetFontWeight () const
	Returns the font weight.

long	GetLeftIndent () const
	Returns the left indent in tenths of a millimetre.

long	GetLeftSubIndent () const
	Returns the left sub-indent in tenths of a millimetre.

int	GetLineSpacing () const
	Returns the line spacing value, one of wxTextAttrLineSpacing values.

const wxString &	GetListStyleName () const
	Returns the name of the list style.

int	GetOutlineLevel () const
	Returns the outline level.

int	GetParagraphSpacingAfter () const
	Returns the space in tenths of a millimeter after the paragraph.

int	GetParagraphSpacingBefore () const
	Returns the space in tenths of a millimeter before the paragraph.

const wxString &	GetParagraphStyleName () const
	Returns the name of the paragraph style.

long	GetRightIndent () const
	Returns the right indent in tenths of a millimeter.

const wxArrayInt &	GetTabs () const
	Returns an array of tab stops, each expressed in tenths of a millimeter.

const wxColour &	GetTextColour () const
	Returns the text foreground colour.

int	GetTextEffectFlags () const
	Returns the text effect bits of interest.

int	GetTextEffects () const
	Returns the text effects, a bit list of styles.

const wxString &	GetURL () const
	Returns the URL for the content.

bool	HasAlignment () const
	Returns true if the attribute object specifies alignment.

bool	HasBackgroundColour () const
	Returns true if the attribute object specifies a background colour.

bool	HasBulletName () const
	Returns true if the attribute object specifies a standard bullet name.

bool	HasBulletNumber () const
	Returns true if the attribute object specifies a bullet number.

bool	HasBulletStyle () const
	Returns true if the attribute object specifies a bullet style.

bool	HasBulletText () const
	Returns true if the attribute object specifies bullet text (usually specifying a symbol).

bool	HasCharacterStyleName () const
	Returns true if the attribute object specifies a character style name.

bool	HasFlag (long flag) const
	Returns true if the flag is present in the attribute object's flag bitlist.

bool	HasFont () const
	Returns true if the attribute object specifies any font attributes.

bool	HasFontEncoding () const
	Returns true if the attribute object specifies an encoding.

bool	HasFontFaceName () const
	Returns true if the attribute object specifies a font face name.

bool	HasFontFamily () const
	Returns true if the attribute object specifies a font family.

bool	HasFontItalic () const
	Returns true if the attribute object specifies italic style.

bool	HasFontSize () const
	Returns true if the attribute object specifies a font point or pixel size.

bool	HasFontPointSize () const
	Returns true if the attribute object specifies a font point size.

bool	HasFontPixelSize () const
	Returns true if the attribute object specifies a font pixel size.

bool	HasFontUnderlined () const
	Returns true if the attribute object specifies either underlining or no underlining.

bool	HasFontWeight () const
	Returns true if the attribute object specifies font weight (bold, light or normal).

bool	HasLeftIndent () const
	Returns true if the attribute object specifies a left indent.

bool	HasLineSpacing () const
	Returns true if the attribute object specifies line spacing.

bool	HasListStyleName () const
	Returns true if the attribute object specifies a list style name.

bool	HasOutlineLevel () const
	Returns true if the attribute object specifies an outline level.

bool	HasPageBreak () const
	Returns true if the attribute object specifies a page break before this paragraph.

bool	HasParagraphSpacingAfter () const
	Returns true if the attribute object specifies spacing after a paragraph.

bool	HasParagraphSpacingBefore () const
	Returns true if the attribute object specifies spacing before a paragraph.

bool	HasParagraphStyleName () const
	Returns true if the attribute object specifies a paragraph style name.

bool	HasRightIndent () const
	Returns true if the attribute object specifies a right indent.

bool	HasTabs () const
	Returns true if the attribute object specifies tab stops.

bool	HasTextColour () const
	Returns true if the attribute object specifies a text foreground colour.

bool	HasTextEffects () const
	Returns true if the attribute object specifies text effects.

bool	HasURL () const
	Returns true if the attribute object specifies a URL.

bool	IsCharacterStyle () const
	Returns true if the object represents a character style, that is, the flags specify a font or a text background or foreground colour.

bool	IsDefault () const
	Returns false if we have any attributes set, true otherwise.

bool	IsParagraphStyle () const
	Returns true if the object represents a paragraph style, that is, the flags specify alignment, indentation, tabs, paragraph spacing, or bullet style.

void	SetAlignment (wxTextAttrAlignment alignment)
	Sets the paragraph alignment.

void	SetBackgroundColour (const wxColour &colBack)
	Sets the background colour.

void	SetBulletFont (const wxString &font)
	Sets the name of the font associated with the bullet symbol.

void	SetBulletName (const wxString &name)
	Sets the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.

void	SetBulletNumber (int n)
	Sets the bullet number.

void	SetBulletStyle (int style)
	Sets the bullet style.

void	SetBulletText (const wxString &text)
	Sets the bullet text, which could be a symbol, or (for example) cached outline text.

void	SetCharacterStyleName (const wxString &name)
	Sets the character style name.

void	SetFlags (long flags)
	Sets the flags determining which styles are being specified.

void	SetFont (const wxFont &font, int flags=wxTEXT_ATTR_FONT &~wxTEXT_ATTR_FONT_PIXEL_SIZE)
	Sets the attributes for the given font.

void	SetFontEncoding (wxFontEncoding encoding)
	Sets the font encoding.

void	SetFontFaceName (const wxString &faceName)
	Sets the font face name.

void	SetFontFamily (wxFontFamily family)
	Sets the font family.

void	SetFontSize (int pointSize)
	Sets the font size in points.

void	SetFontPointSize (int pointSize)
	Sets the font size in points.

void	SetFontPixelSize (int pixelSize)
	Sets the font size in pixels.

void	SetFontStyle (wxFontStyle fontStyle)
	Sets the font style (normal, italic or slanted).

void	SetFontUnderlined (bool underlined)
	Sets the font underlining.

void	SetFontWeight (wxFontWeight fontWeight)
	Sets the font weight.

void	SetLeftIndent (int indent, int subIndent=0)
	Sets the left indent and left subindent in tenths of a millimetre.

void	SetLineSpacing (int spacing)
	Sets the line spacing.

void	SetListStyleName (const wxString &name)
	Sets the list style name.

void	SetOutlineLevel (int level)
	Specifies the outline level.

void	SetPageBreak (bool pageBreak=true)
	Specifies a page break before this paragraph.

void	SetParagraphSpacingAfter (int spacing)
	Sets the spacing after a paragraph, in tenths of a millimetre.

void	SetParagraphSpacingBefore (int spacing)
	Sets the spacing before a paragraph, in tenths of a millimetre.

void	SetParagraphStyleName (const wxString &name)
	Sets the name of the paragraph style.

void	SetRightIndent (int indent)
	Sets the right indent in tenths of a millimetre.

void	SetTabs (const wxArrayInt &tabs)
	Sets the tab stops, expressed in tenths of a millimetre.

void	SetTextColour (const wxColour &colText)
	Sets the text foreground colour.

void	SetTextEffectFlags (int flags)
	Sets the text effect bits of interest.

void	SetTextEffects (int effects)
	Sets the text effects, a bit list of styles.

void	SetURL (const wxString &url)
	Sets the URL for the content.

Public Attributes
wxTextBoxAttr	m_textBoxAttr

Additional Inherited Members
Static Public Member Functions inherited from wxTextAttr
static wxTextAttr	Merge (const wxTextAttr &base, const wxTextAttr &overlay)
	Creates a new `wxTextAttr` which is a merge of base and overlay.

Constructor & Destructor Documentation

wxRichTextAttr::wxRichTextAttr ( const wxTextAttr & attr )

inline

Constructor taking a wxTextAttr.

wxRichTextAttr::wxRichTextAttr ( const wxRichTextAttr & attr )

inline

Copy constructor.

wxRichTextAttr::wxRichTextAttr ( )

inline

Default constructor.

Member Function Documentation

bool wxRichTextAttr::Apply	(	const wxRichTextAttr &	style,
		const wxRichTextAttr *	compareWith = `NULL`
	)

Merges the given attributes.

If compareWith is non-NULL, then it will be used to mask out those attributes that are the same in style and compareWith, for situations where we don't want to explicitly set inherited attributes.

void wxRichTextAttr::CollectCommonAttributes	(	const wxRichTextAttr &	attr,
		wxRichTextAttr &	clashingAttr,
		wxRichTextAttr &	absentAttr
	)

Collects the attributes that are common to a range of content, building up a note of which attributes are absent in some objects and which clash in some objects.

void wxRichTextAttr::Copy ( const wxRichTextAttr & attr )

Copy function.

bool wxRichTextAttr::EqPartial	(	const wxRichTextAttr &	attr,
		bool	weakTest = `true`
	)		const

Partial equality test.

If weakTest is true, attributes of this object do not have to be present if those attributes of attr are present. If weakTest is false, the function will fail if an attribute is present in attr but not in this object.

wxTextBoxAttr& wxRichTextAttr::GetTextBoxAttr ( )

inline

Returns the text box attributes.

const wxTextBoxAttr& wxRichTextAttr::GetTextBoxAttr ( ) const

inline

bool wxRichTextAttr::IsDefault ( ) const

inline

Returns true if no attributes are set.

void wxRichTextAttr::operator= ( const wxRichTextAttr & attr )

inline

Assignment operator.

void wxRichTextAttr::operator= ( const wxTextAttr & attr )

inline

Assignment operator.

bool wxRichTextAttr::operator== ( const wxRichTextAttr & attr ) const

Equality test.

bool wxRichTextAttr::RemoveStyle ( const wxRichTextAttr & attr )

Removes the specified attributes from this object.

void wxRichTextAttr::SetTextBoxAttr ( const wxTextBoxAttr & attr )

inline

Set the text box attributes.

Member Data Documentation

wxTextBoxAttr wxRichTextAttr::m_textBoxAttr

Detailed Description

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation