wxTextAttr

Methods

• wxTextAttr
  Constructors.
• Apply
  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).
• GetAlignment
  Returns the alignment flags.
• GetBackgroundColour
  Returns the background colour.
• GetBulletFont
  Returns a string containing the name of the font associated with the bullet symbol.
• GetBulletName
  Returns the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.
• GetBulletNumber
  Returns the bullet number.
• GetBulletStyle
  Returns the bullet style.
• GetBulletText
  Returns the bullet text, which could be a symbol, or (for example) cached outline text.
• GetCharacterStyleName
  Returns the name of the character style.
• GetFlags
  Returns flags indicating which attributes are applicable.
• GetFont
  Creates and returns a font specified by the font attributes in the wxTextAttr object.
• GetFontAttributes
  Gets the font attributes from the given font, using only the attributes specified by flags.
• GetFontEncoding
  Returns the font encoding.
• GetFontFaceName
  Returns the font face name.
• GetFontFamily
  Returns the font family.
• GetFontSize
  Returns the font size in points.
• GetFontStyle
  Returns the font style.
• GetFontUnderlined
  Returns true if the font is underlined.
• GetFontWeight
  Returns the font weight.
• GetLeftIndent
  Returns the left indent in tenths of a millimetre.
• GetLeftSubIndent
  Returns the left sub-indent in tenths of a millimetre.
• GetLineSpacing
  Returns the line spacing value, one of wxTextAttrLineSpacing values.
• GetListStyleName
  Returns the name of the list style.
• GetOutlineLevel
  Returns the outline level.
• GetParagraphSpacingAfter
  Returns the space in tenths of a millimeter after the paragraph.
• GetParagraphSpacingBefore
  Returns the space in tenths of a millimeter before the paragraph.
• GetParagraphStyleName
  Returns the name of the paragraph style.
• GetRightIndent
  Returns the right indent in tenths of a millimeter.
• GetTextColour
  Returns the text foreground colour.
• GetTextEffectFlags
  Returns the text effect bits of interest.
• GetTextEffects
  Returns the text effects, a bit list of styles.
• GetURL
  Returns the URL for the content.
• HasAlignment
  Returns true if the attribute object specifies alignment.
• HasBackgroundColour
  Returns true if the attribute object specifies a background colour.
• HasBulletName
  Returns true if the attribute object specifies a standard bullet name.
• HasBulletNumber
  Returns true if the attribute object specifies a bullet number.
• HasBulletStyle
  Returns true if the attribute object specifies a bullet style.
• HasBulletText
  Returns true if the attribute object specifies bullet text (usually specifying a symbol).
• HasCharacterStyleName
  Returns true if the attribute object specifies a character style name.
• HasFlag
  Returns true if the flag is present in the attribute object's flag bitlist.
• HasFont
  Returns true if the attribute object specifies any font attributes.
• HasFontEncoding
  Returns true if the attribute object specifies an encoding.
• HasFontFaceName
  Returns true if the attribute object specifies a font face name.
• HasFontFamily
  Returns true if the attribute object specifies a font family.
• HasFontItalic
  Returns true if the attribute object specifies italic style.
• HasFontSize
  Returns true if the attribute object specifies a font point size.
• HasFontUnderlined
  Returns true if the attribute object specifies either underlining or no underlining.
• HasFontWeight
  Returns true if the attribute object specifies font weight (bold, light or normal).
• HasLeftIndent
  Returns true if the attribute object specifies a left indent.
• HasLineSpacing
  Returns true if the attribute object specifies line spacing.
• HasListStyleName
  Returns true if the attribute object specifies a list style name.
• HasOutlineLevel
  Returns true if the attribute object specifies an outline level.
• HasPageBreak
  Returns true if the attribute object specifies a page break before this paragraph.
• HasParagraphSpacingAfter
  Returns true if the attribute object specifies spacing after a paragraph.
• HasParagraphSpacingBefore
  Returns true if the attribute object specifies spacing before a paragraph.
• HasParagraphStyleName
  Returns true if the attribute object specifies a paragraph style name.
• HasRightIndent
  Returns true if the attribute object specifies a right indent.
• HasTabs
  Returns true if the attribute object specifies tab stops.
• HasTextColour
  Returns true if the attribute object specifies a text foreground colour.
• HasTextEffects
  Returns true if the attribute object specifies text effects.
• HasURL
  Returns true if the attribute object specifies a URL.
• IsCharacterStyle
  Returns true if the object represents a character style, that is, the flags specify a font or a text background or foreground colour.
• IsDefault
  Returns false if we have any attributes set, true otherwise.
• IsParagraphStyle
  Returns true if the object represents a paragraph style, that is, the flags specify alignment, indentation, tabs, paragraph spacing, or bullet style.
• Merge
  Copies all defined/valid properties from overlay to current object.
• SetAlignment
  Sets the paragraph alignment.
• SetBackgroundColour
  Sets the background colour.
• SetBulletFont
  Sets the name of the font associated with the bullet symbol.
• SetBulletName
  Sets the standard bullet name, applicable if the bullet style is wxTEXT_ATTR_BULLET_STYLE_STANDARD.
• SetBulletNumber
  Sets the bullet number.
• SetBulletStyle
  Sets the bullet style.
• SetBulletText
  Sets the bullet text, which could be a symbol, or (for example) cached outline text.
• SetCharacterStyleName
  Sets the character style name.
• SetFlags
  Sets the flags determining which styles are being specified.
• SetFont
  Sets the attributes for the given font.
• SetFontEncoding
  Sets the font encoding.
• SetFontFaceName
  Sets the font face name.
• SetFontFamily
  Sets the font family.
• SetFontSize
  Sets the font size in points.
• SetFontStyle
  Sets the font style (normal, italic or slanted).
• SetFontUnderlined
  Sets the font underlining.
• SetFontWeight
  Sets the font weight.
• SetLeftIndent
  Sets the left indent and left subindent in tenths of a millimetre.
• SetLineSpacing
  Sets the line spacing.
• SetListStyleName
  Sets the list style name.
• SetOutlineLevel
  Specifies the outline level.
• SetPageBreak
  Specifies a page break before this paragraph.
• SetParagraphSpacingAfter
  Sets the spacing after a paragraph, in tenths of a millimetre.
• SetParagraphSpacingBefore
  Sets the spacing before a paragraph, in tenths of a millimetre.
• SetParagraphStyleName
  Sets the name of the paragraph style.
• SetRightIndent
  Sets the right indent in tenths of a millimetre.
• SetTextColour
  Sets the text foreground colour.
• SetTextEffectFlags
  Sets the text effect bits of interest.
• SetTextEffects
  Sets the text effects, a bit list of styles.
• SetURL
  Sets the URL for the content.

wxTextAttr

wxTextAttr ( wxTextAttr $attr )

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

Constructors.
wxTextAttr ( )

Constructors.

Apply

bool Apply ( wxTextAttr $style, 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).

GetAlignment

wxTextAttrAlignment GetAlignment ( )

Returns the alignment flags.

GetBackgroundColour

wxColour GetBackgroundColour ( )

Returns the background colour.

GetBulletFont

string GetBulletFont ( )

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

GetBulletName

string GetBulletName ( )

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

GetBulletNumber

integer GetBulletNumber ( )

Returns the bullet number.

GetBulletStyle

integer GetBulletStyle ( )

Returns the bullet style.

GetBulletText

string GetBulletText ( )

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

GetCharacterStyleName

string GetCharacterStyleName ( )

Returns the name of the character style.

GetFlags

integer GetFlags ( )

Returns flags indicating which attributes are applicable.

GetFont

wxFont GetFont ( )

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

GetFontAttributes

bool GetFontAttributes ( wxFont $font, integer $flags=wxTEXT_ATTR_FONT )

Gets the font attributes from the given font, using only the attributes specified by flags.

GetFontEncoding

wxFontEncoding GetFontEncoding ( )

Returns the font encoding.

GetFontFaceName

string GetFontFaceName ( )

Returns the font face name.

GetFontFamily

wxFontFamily GetFontFamily ( )

Returns the font family.

GetFontSize

integer GetFontSize ( )

Returns the font size in points.

GetFontStyle

wxFontStyle GetFontStyle ( )

Returns the font style.

GetFontUnderlined

bool GetFontUnderlined ( )

Returns true if the font is underlined.

GetFontWeight

wxFontWeight GetFontWeight ( )

Returns the font weight.

GetLeftIndent

integer GetLeftIndent ( )

Returns the left indent in tenths of a millimetre.

GetLeftSubIndent

integer GetLeftSubIndent ( )

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

GetLineSpacing

integer GetLineSpacing ( )

Returns the line spacing value, one of wxTextAttrLineSpacing values.

GetListStyleName

string GetListStyleName ( )

Returns the name of the list style.

GetOutlineLevel

integer GetOutlineLevel ( )

Returns the outline level.

GetParagraphSpacingAfter

integer GetParagraphSpacingAfter ( )

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

GetParagraphSpacingBefore

integer GetParagraphSpacingBefore ( )

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

GetParagraphStyleName

string GetParagraphStyleName ( )

Returns the name of the paragraph style.

GetRightIndent

integer GetRightIndent ( )

Returns the right indent in tenths of a millimeter.

GetTextColour

wxColour GetTextColour ( )

Returns the text foreground colour.

GetTextEffectFlags

integer GetTextEffectFlags ( )

Returns the text effect bits of interest.

GetTextEffects

integer GetTextEffects ( )

Returns the text effects, a bit list of styles.

GetURL

string GetURL ( )

Returns the URL for the content.

HasAlignment

bool HasAlignment ( )

Returns true if the attribute object specifies alignment.

HasBackgroundColour

bool HasBackgroundColour ( )

Returns true if the attribute object specifies a background colour.

HasBulletName

bool HasBulletName ( )

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

HasBulletNumber

bool HasBulletNumber ( )

Returns true if the attribute object specifies a bullet number.

HasBulletStyle

bool HasBulletStyle ( )

Returns true if the attribute object specifies a bullet style.

HasBulletText

bool HasBulletText ( )

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

HasCharacterStyleName

bool HasCharacterStyleName ( )

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

HasFlag

bool HasFlag ( integer $flag )

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

HasFont

bool HasFont ( )

Returns true if the attribute object specifies any font attributes.

HasFontEncoding

bool HasFontEncoding ( )

Returns true if the attribute object specifies an encoding.

HasFontFaceName

bool HasFontFaceName ( )

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

HasFontFamily

bool HasFontFamily ( )

Returns true if the attribute object specifies a font family.

HasFontItalic

bool HasFontItalic ( )

Returns true if the attribute object specifies italic style.

HasFontSize

bool HasFontSize ( )

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

HasFontUnderlined

bool HasFontUnderlined ( )

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

HasFontWeight

bool HasFontWeight ( )

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

HasLeftIndent

bool HasLeftIndent ( )

Returns true if the attribute object specifies a left indent.

HasLineSpacing

bool HasLineSpacing ( )

Returns true if the attribute object specifies line spacing.

HasListStyleName

bool HasListStyleName ( )

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

HasOutlineLevel

bool HasOutlineLevel ( )

Returns true if the attribute object specifies an outline level.

HasPageBreak

bool HasPageBreak ( )

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

HasParagraphSpacingAfter

bool HasParagraphSpacingAfter ( )

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

HasParagraphSpacingBefore

bool HasParagraphSpacingBefore ( )

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

HasParagraphStyleName

bool HasParagraphStyleName ( )

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

HasRightIndent

bool HasRightIndent ( )

Returns true if the attribute object specifies a right indent.

HasTabs

bool HasTabs ( )

Returns true if the attribute object specifies tab stops.

HasTextColour

bool HasTextColour ( )

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

HasTextEffects

bool HasTextEffects ( )

Returns true if the attribute object specifies text effects.

HasURL

bool HasURL ( )

Returns true if the attribute object specifies a URL.

IsCharacterStyle

bool IsCharacterStyle ( )

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

IsDefault

bool IsDefault ( )

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

IsParagraphStyle

bool IsParagraphStyle ( )

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

Merge

Merge ( wxTextAttr $overlay )

Copies all defined/valid properties from overlay to current object.
static wxTextAttr Merge ( wxTextAttr $base, wxTextAttr $overlay )

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

SetAlignment

SetAlignment ( wxTextAttrAlignment $alignment )

Sets the paragraph alignment.

SetBackgroundColour

SetBackgroundColour ( wxColour $colBack )

Sets the background colour.

SetBulletFont

SetBulletFont ( string $font )

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

SetBulletName

SetBulletName ( string $name )

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

SetBulletNumber

SetBulletNumber ( integer $n )

Sets the bullet number.

SetBulletStyle

SetBulletStyle ( integer $style )

Sets the bullet style.

SetBulletText

SetBulletText ( string $text )

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

SetCharacterStyleName

SetCharacterStyleName ( string $name )

Sets the character style name.

SetFlags

SetFlags ( integer $flags )

Sets the flags determining which styles are being specified.

SetFont

SetFont ( wxFont $font, integer $flags=wxTEXT_ATTR_FONT )

Sets the attributes for the given font.

SetFontEncoding

SetFontEncoding ( wxFontEncoding $encoding )

Sets the font encoding.

SetFontFaceName

SetFontFaceName ( string $faceName )

Sets the font face name.

SetFontFamily

SetFontFamily ( wxFontFamily $family )

Sets the font family.

SetFontSize

SetFontSize ( integer $pointSize )

Sets the font size in points.

SetFontStyle

SetFontStyle ( wxFontStyle $fontStyle )

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

SetFontUnderlined

SetFontUnderlined ( bool $underlined )

Sets the font underlining.

SetFontWeight

SetFontWeight ( wxFontWeight $fontWeight )

Sets the font weight.

SetLeftIndent

SetLeftIndent ( integer $indent, integer $subIndent )

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

SetLineSpacing

SetLineSpacing ( integer $spacing )

Sets the line spacing.

SetListStyleName

SetListStyleName ( string $name )

Sets the list style name.

SetOutlineLevel

SetOutlineLevel ( integer $level )

Specifies the outline level.

SetPageBreak

SetPageBreak ( bool $pageBreak=true )

Specifies a page break before this paragraph.

SetParagraphSpacingAfter

SetParagraphSpacingAfter ( integer $spacing )

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

SetParagraphSpacingBefore

SetParagraphSpacingBefore ( integer $spacing )

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

SetParagraphStyleName

SetParagraphStyleName ( string $name )

Sets the name of the paragraph style.

SetRightIndent

SetRightIndent ( integer $indent )

Sets the right indent in tenths of a millimetre.

SetTextColour

SetTextColour ( wxColour $colText )

Sets the text foreground colour.

SetTextEffectFlags

SetTextEffectFlags ( integer $flags )

Sets the text effect bits of interest.

SetTextEffects

SetTextEffects ( integer $effects )

Sets the text effects, a bit list of styles.

SetURL

SetURL ( string $url )

Sets the URL for the content.