wxRichTextStyleDefinition Class Reference
[Rich Text]

#include <wx/richtext/richtextstyles.h>

Inheritance diagram for wxRichTextStyleDefinition:

wxObject wxRichTextCharacterStyleDefinition wxRichTextParagraphStyleDefinition wxRichTextListStyleDefinition

List of all members.


Detailed Description

This is a base class for paragraph and character styles.

Library:  wxRichText

Category:  Rich Text

Public Member Functions

 wxRichTextStyleDefinition (const wxString &name=wxEmptyString)
virtual ~wxRichTextStyleDefinition ()
const wxStringGetBaseStyle () const
const wxStringGetDescription () const
const wxStringGetName () const
virtual wxTextAttr GetStyleMergedWithBase (const wxRichTextStyleSheet *sheet) const
void SetBaseStyle (const wxString &name)
void SetDescription (const wxString &descr)
void SetName (const wxString &name)
void SetStyle (const wxTextAttr &style)
wxTextAttr GetStyle () const
const wxTextAttr GetStyle () const

Constructor & Destructor Documentation

wxRichTextStyleDefinition::wxRichTextStyleDefinition ( const wxString name = wxEmptyString  ) 

Constructor.

virtual wxRichTextStyleDefinition::~wxRichTextStyleDefinition (  )  [virtual]

Destructor.


Member Function Documentation

const wxString& wxRichTextStyleDefinition::GetBaseStyle (  )  const

Returns the style on which this style is based.

const wxString& wxRichTextStyleDefinition::GetDescription (  )  const

Returns the style's description.

const wxString& wxRichTextStyleDefinition::GetName (  )  const

Returns the style name.

wxTextAttr wxRichTextStyleDefinition::GetStyle (  )  const

Returns the attributes associated with this style.

const wxTextAttr wxRichTextStyleDefinition::GetStyle (  )  const

Returns the attributes associated with this style.

virtual wxTextAttr wxRichTextStyleDefinition::GetStyleMergedWithBase ( const wxRichTextStyleSheet sheet  )  const [virtual]

Returns the style attributes combined with the attributes of the specified base style, if any. This function works recursively.

void wxRichTextStyleDefinition::SetBaseStyle ( const wxString name  ) 

Sets the name of the style that this style is based on.

void wxRichTextStyleDefinition::SetDescription ( const wxString descr  ) 

Sets the style description.

void wxRichTextStyleDefinition::SetName ( const wxString name  ) 

Sets the name of the style.

void wxRichTextStyleDefinition::SetStyle ( const wxTextAttr style  ) 

Sets the attributes for this style.



wxWidgets logo

[ top ]