#include <wx/textctrl.h>

Inheritance diagram for wxTextAttr:

Detailed Description

wxTextAttr represents the character and paragraph attributes, or style, for a range of text in a wxTextCtrl or wxRichTextCtrl.

When setting up a wxTextAttr object, pass a bitlist mask to wxTextAttr::SetFlags() to indicate which style elements should be changed. As a convenience, when you call a setter such as SetFont, the relevant bit will be set.

Library: wxCore

Category: Rich Text

See Also: wxTextCtrl, wxRichTextCtrl

Public Member Functions
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.

GetXXX functions
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.

HasXXX and IsXXX functions
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.

SetXXX functions
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.

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

Constructor & Destructor Documentation

wxTextAttr::wxTextAttr ( )

Constructors.

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

Constructors.

wxTextAttr::wxTextAttr ( const wxTextAttr & attr )

Constructors.

Member Function Documentation

bool wxTextAttr::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).

bool wxTextAttr::EqPartial	(	const wxTextAttr &	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.

wxTextAttrAlignment wxTextAttr::GetAlignment ( ) const

Returns the alignment flags.

See wxTextAttrAlignment for a list of available styles.

const wxColour& wxTextAttr::GetBackgroundColour ( ) const

Returns the background colour.

const wxString& wxTextAttr::GetBulletFont ( ) const

Returns a string containing the name of the font associated with the bullet symbol.

Only valid for attributes with wxTEXT_ATTR_BULLET_SYMBOL.

const wxString& wxTextAttr::GetBulletName ( ) const

Returns the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.

Currently the following standard bullet names are supported:

standard/circle
standard/square
standard/diamond
standard/triangle

Note: For wxRichTextCtrl users only: if you wish your rich text controls to support further bullet graphics, you can derive a class from wxRichTextRenderer or wxRichTextStdRenderer, override DrawStandardBullet and EnumerateStandardBulletNames, and set an instance of the class using wxRichTextBuffer::SetRenderer.

int wxTextAttr::GetBulletNumber ( ) const

Returns the bullet number.

int wxTextAttr::GetBulletStyle ( ) const

Returns the bullet style.

See wxTextAttrBulletStyle for a list of available styles.

const wxString& wxTextAttr::GetBulletText ( ) const

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

const wxString& wxTextAttr::GetCharacterStyleName ( ) const

Returns the name of the character style.

long wxTextAttr::GetFlags ( ) const

Returns flags indicating which attributes are applicable.

See SetFlags() for a list of available flags.

wxFont wxTextAttr::GetFont ( ) const

Creates and returns a font specified by the font attributes in the wxTextAttr object.

Note that wxTextAttr does not store a wxFont object, so this is only a temporary font.

For greater efficiency, access the font attributes directly.

bool wxTextAttr::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 wxTextAttr::GetFontEncoding ( ) const

Returns the font encoding.

const wxString& wxTextAttr::GetFontFaceName ( ) const

Returns the font face name.

wxFontFamily wxTextAttr::GetFontFamily ( ) const

Returns the font family.

int wxTextAttr::GetFontSize ( ) const

Returns the font size in points.

wxFontStyle wxTextAttr::GetFontStyle ( ) const

Returns the font style.

bool wxTextAttr::GetFontUnderlined ( ) const

Returns true if the font is underlined.

wxFontWeight wxTextAttr::GetFontWeight ( ) const

Returns the font weight.

long wxTextAttr::GetLeftIndent ( ) const

Returns the left indent in tenths of a millimetre.

long wxTextAttr::GetLeftSubIndent ( ) const

Returns the left sub-indent in tenths of a millimetre.

int wxTextAttr::GetLineSpacing ( ) const

Returns the line spacing value, one of wxTextAttrLineSpacing values.

const wxString& wxTextAttr::GetListStyleName ( ) const

Returns the name of the list style.

int wxTextAttr::GetOutlineLevel ( ) const

Returns the outline level.

int wxTextAttr::GetParagraphSpacingAfter ( ) const

Returns the space in tenths of a millimeter after the paragraph.

int wxTextAttr::GetParagraphSpacingBefore ( ) const

Returns the space in tenths of a millimeter before the paragraph.

const wxString& wxTextAttr::GetParagraphStyleName ( ) const

Returns the name of the paragraph style.

long wxTextAttr::GetRightIndent ( ) const

Returns the right indent in tenths of a millimeter.

const wxArrayInt& wxTextAttr::GetTabs ( ) const

Returns an array of tab stops, each expressed in tenths of a millimeter.

Each stop is measured from the left margin and therefore each value must be larger than the last.

const wxColour& wxTextAttr::GetTextColour ( ) const

Returns the text foreground colour.

int wxTextAttr::GetTextEffectFlags ( ) const

Returns the text effect bits of interest.

See SetFlags() for further information.

int wxTextAttr::GetTextEffects ( ) const

Returns the text effects, a bit list of styles.

See SetTextEffects() for details.

const wxString& wxTextAttr::GetURL ( ) const

Returns the URL for the content.

Content with wxTEXT_ATTR_URL style causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent when the content is clicked.

bool wxTextAttr::HasAlignment ( ) const

Returns true if the attribute object specifies alignment.

bool wxTextAttr::HasBackgroundColour ( ) const

Returns true if the attribute object specifies a background colour.

bool wxTextAttr::HasBulletName ( ) const

Returns true if the attribute object specifies a standard bullet name.

bool wxTextAttr::HasBulletNumber ( ) const

Returns true if the attribute object specifies a bullet number.

bool wxTextAttr::HasBulletStyle ( ) const

Returns true if the attribute object specifies a bullet style.

bool wxTextAttr::HasBulletText ( ) const

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

bool wxTextAttr::HasCharacterStyleName ( ) const

Returns true if the attribute object specifies a character style name.

bool wxTextAttr::HasFlag ( long flag ) const

Returns true if the flag is present in the attribute object's flag bitlist.

bool wxTextAttr::HasFont ( ) const

Returns true if the attribute object specifies any font attributes.

bool wxTextAttr::HasFontEncoding ( ) const

Returns true if the attribute object specifies an encoding.

bool wxTextAttr::HasFontFaceName ( ) const

Returns true if the attribute object specifies a font face name.

bool wxTextAttr::HasFontFamily ( ) const

Returns true if the attribute object specifies a font family.

bool wxTextAttr::HasFontItalic ( ) const

Returns true if the attribute object specifies italic style.

bool wxTextAttr::HasFontPixelSize ( ) const

Returns true if the attribute object specifies a font pixel size.

bool wxTextAttr::HasFontPointSize ( ) const

Returns true if the attribute object specifies a font point size.

bool wxTextAttr::HasFontSize ( ) const

Returns true if the attribute object specifies a font point or pixel size.

bool wxTextAttr::HasFontUnderlined ( ) const

Returns true if the attribute object specifies either underlining or no underlining.

bool wxTextAttr::HasFontWeight ( ) const

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

bool wxTextAttr::HasLeftIndent ( ) const

Returns true if the attribute object specifies a left indent.

bool wxTextAttr::HasLineSpacing ( ) const

Returns true if the attribute object specifies line spacing.

bool wxTextAttr::HasListStyleName ( ) const

Returns true if the attribute object specifies a list style name.

bool wxTextAttr::HasOutlineLevel ( ) const

Returns true if the attribute object specifies an outline level.

bool wxTextAttr::HasPageBreak ( ) const

Returns true if the attribute object specifies a page break before this paragraph.

bool wxTextAttr::HasParagraphSpacingAfter ( ) const

Returns true if the attribute object specifies spacing after a paragraph.

bool wxTextAttr::HasParagraphSpacingBefore ( ) const

Returns true if the attribute object specifies spacing before a paragraph.

bool wxTextAttr::HasParagraphStyleName ( ) const

Returns true if the attribute object specifies a paragraph style name.

bool wxTextAttr::HasRightIndent ( ) const

Returns true if the attribute object specifies a right indent.

bool wxTextAttr::HasTabs ( ) const

Returns true if the attribute object specifies tab stops.

bool wxTextAttr::HasTextColour ( ) const

Returns true if the attribute object specifies a text foreground colour.

bool wxTextAttr::HasTextEffects ( ) const

Returns true if the attribute object specifies text effects.

bool wxTextAttr::HasURL ( ) const

Returns true if the attribute object specifies a URL.

bool wxTextAttr::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 wxTextAttr::IsDefault ( ) const

Returns false if we have any attributes set, true otherwise.

bool wxTextAttr::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 wxTextAttr::Merge ( const wxTextAttr & overlay )

Copies all defined/valid properties from overlay to current object.

static wxTextAttr wxTextAttr::Merge	(	const wxTextAttr &	base,
		const wxTextAttr &	overlay
	)

static

Creates a new wxTextAttr which is a merge of base and overlay.

Properties defined in overlay take precedence over those in base. Properties undefined/invalid in both are undefined in the result.

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

Assignment from a wxTextAttr object.

void wxTextAttr::SetAlignment ( wxTextAttrAlignment alignment )

Sets the paragraph alignment.

See wxTextAttrAlignment enumeration values.

Of these, wxTEXT_ALIGNMENT_JUSTIFIED is unimplemented. In future justification may be supported when printing or previewing, only.

void wxTextAttr::SetBackgroundColour ( const wxColour & colBack )

Sets the background colour.

void wxTextAttr::SetBulletFont ( const wxString & font )

Sets the name of the font associated with the bullet symbol.

Only valid for attributes with wxTEXT_ATTR_BULLET_SYMBOL.

void wxTextAttr::SetBulletName ( const wxString & name )

Sets the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.

See GetBulletName() for a list of supported names, and how to expand the range of supported types.

void wxTextAttr::SetBulletNumber ( int n )

Sets the bullet number.

void wxTextAttr::SetBulletStyle ( int style )

Sets the bullet style.

The wxTextAttrBulletStyle enumeration values are all supported, except for wxTEXT_ATTR_BULLET_STYLE_BITMAP.

void wxTextAttr::SetBulletText ( const wxString & text )

Sets the bullet text, which could be a symbol, or (for example) cached outline text.

void wxTextAttr::SetCharacterStyleName ( const wxString & name )

Sets the character style name.

void wxTextAttr::SetFlags ( long flags )

Sets the flags determining which styles are being specified.

The wxTextAttrFlags values can be passed in a bitlist.

void wxTextAttr::SetFont	(	const wxFont &	font,
		int	flags = `wxTEXT_ATTR_FONT &~wxTEXT_ATTR_FONT_PIXEL_SIZE`
	)

Sets the attributes for the given font.

Note that wxTextAttr does not store an actual wxFont object.

void wxTextAttr::SetFontEncoding ( wxFontEncoding encoding )

Sets the font encoding.

void wxTextAttr::SetFontFaceName ( const wxString & faceName )

Sets the font face name.

void wxTextAttr::SetFontFamily ( wxFontFamily family )

Sets the font family.

void wxTextAttr::SetFontPixelSize ( int pixelSize )

Sets the font size in pixels.

void wxTextAttr::SetFontPointSize ( int pointSize )

Sets the font size in points.

void wxTextAttr::SetFontSize ( int pointSize )

Sets the font size in points.

void wxTextAttr::SetFontStyle ( wxFontStyle fontStyle )

Sets the font style (normal, italic or slanted).

void wxTextAttr::SetFontUnderlined ( bool underlined )

Sets the font underlining.

void wxTextAttr::SetFontWeight ( wxFontWeight fontWeight )

Sets the font weight.

void wxTextAttr::SetLeftIndent	(	int	indent,
		int	subIndent = `0`
	)

Sets the left indent and left subindent in tenths of a millimetre.

The sub-indent is an offset from the left of the paragraph, and is used for all but the first line in a paragraph.

A positive value will cause the first line to appear to the left of the subsequent lines, and a negative value will cause the first line to be indented relative to the subsequent lines.

wxRichTextBuffer uses indentation to render a bulleted item. The left indent is the distance between the margin and the bullet. The content of the paragraph, including the first line, starts at leftMargin + leftSubIndent. So the distance between the left edge of the bullet and the left of the actual paragraph is leftSubIndent.

void wxTextAttr::SetLineSpacing ( int spacing )

Sets the line spacing.

spacing is a multiple, where 10 means single-spacing, 15 means 1.5 spacing, and 20 means double spacing. The wxTextAttrLineSpacing values are defined for convenience.

void wxTextAttr::SetListStyleName ( const wxString & name )

Sets the list style name.

void wxTextAttr::SetOutlineLevel ( int level )

Specifies the outline level.

Zero represents normal text. At present, the outline level is not used, but may be used in future for determining list levels and for applications that need to store document structure information.

void wxTextAttr::SetPageBreak ( bool pageBreak = true )

Specifies a page break before this paragraph.

void wxTextAttr::SetParagraphSpacingAfter ( int spacing )

Sets the spacing after a paragraph, in tenths of a millimetre.

void wxTextAttr::SetParagraphSpacingBefore ( int spacing )

Sets the spacing before a paragraph, in tenths of a millimetre.

void wxTextAttr::SetParagraphStyleName ( const wxString & name )

Sets the name of the paragraph style.

void wxTextAttr::SetRightIndent ( int indent )

Sets the right indent in tenths of a millimetre.

void wxTextAttr::SetTabs ( const wxArrayInt & tabs )

Sets the tab stops, expressed in tenths of a millimetre.

Each stop is measured from the left margin and therefore each value must be larger than the last.

void wxTextAttr::SetTextColour ( const wxColour & colText )

Sets the text foreground colour.

void wxTextAttr::SetTextEffectFlags ( int flags )

Sets the text effect bits of interest.

You should also pass wxTEXT_ATTR_EFFECTS to SetFlags(). See SetFlags() for further information.

void wxTextAttr::SetTextEffects ( int effects )

Sets the text effects, a bit list of styles.

The wxTextAttrEffects enumeration values can be used.

Of these, only wxTEXT_ATTR_EFFECT_CAPITALS, wxTEXT_ATTR_EFFECT_STRIKETHROUGH, wxTEXT_ATTR_EFFECT_SUPERSCRIPT and wxTEXT_ATTR_EFFECT_SUBSCRIPT are implemented.

wxTEXT_ATTR_EFFECT_CAPITALS capitalises text when displayed (leaving the case of the actual buffer text unchanged), and wxTEXT_ATTR_EFFECT_STRIKETHROUGH draws a line through text.

To set effects, you should also pass wxTEXT_ATTR_EFFECTS to SetFlags(), and call SetTextEffectFlags() with the styles (taken from the above set) that you are interested in setting.

void wxTextAttr::SetURL ( const wxString & url )

Sets the URL for the content.

Sets the wxTEXT_ATTR_URL style; content with this style causes wxRichTextCtrl to show a hand cursor over it, and wxRichTextCtrl generates a wxTextUrlEvent when the content is clicked.

Detailed Description

Public Member Functions

Static Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation