Version: 3.1.2
wxRichTextStyleDefinition Class Reference

#include <wx/richtext/richtextstyles.h>

+ Inheritance diagram for wxRichTextStyleDefinition:

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)
 Constructor. More...
 
virtual ~wxRichTextStyleDefinition ()
 Destructor. More...
 
const wxStringGetBaseStyle () const
 Returns the style on which this style is based. More...
 
const wxStringGetDescription () const
 Returns the style's description. More...
 
const wxStringGetName () const
 Returns the style name. More...
 
virtual wxRichTextAttr GetStyleMergedWithBase (const wxRichTextStyleSheet *sheet) const
 Returns the style attributes combined with the attributes of the specified base style, if any. More...
 
void SetBaseStyle (const wxString &name)
 Sets the name of the style that this style is based on. More...
 
void SetDescription (const wxString &descr)
 Sets the style description. More...
 
void SetName (const wxString &name)
 Sets the name of the style. More...
 
void SetStyle (const wxRichTextAttr &style)
 Sets the attributes for this style. More...
 
wxRichTextPropertiesGetProperties ()
 Returns the definition's properties. More...
 
const wxRichTextPropertiesGetProperties () const
 Returns the definition's properties. More...
 
void SetProperties (const wxRichTextProperties &props)
 Sets the definition's properties. More...
 
wxRichTextAttr GetStyle () const
 Returns the attributes associated with this style. More...
 
const wxRichTextAttr GetStyle () const
 Returns the attributes associated with this style. More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

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.

wxRichTextProperties& wxRichTextStyleDefinition::GetProperties ( )

Returns the definition's properties.

const wxRichTextProperties& wxRichTextStyleDefinition::GetProperties ( ) const

Returns the definition's properties.

wxRichTextAttr wxRichTextStyleDefinition::GetStyle ( ) const

Returns the attributes associated with this style.

const wxRichTextAttr wxRichTextStyleDefinition::GetStyle ( ) const

Returns the attributes associated with this style.

virtual wxRichTextAttr 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::SetProperties ( const wxRichTextProperties props)

Sets the definition's properties.

void wxRichTextStyleDefinition::SetStyle ( const wxRichTextAttr style)

Sets the attributes for this style.