Version: 3.1.2
wxRichTextProperties Class Reference

#include <wx/richtext/richtextbuffer.h>

+ Inheritance diagram for wxRichTextProperties:

Detailed Description

A simple property class using wxVariants.

This is used to give each rich text object the ability to store custom properties that can be used by the application.

Library:  wxRichText
Category:  Rich Text
See also
wxRichTextBuffer, wxRichTextObject, wxRichTextCtrl

Public Member Functions

 wxRichTextProperties ()
 Default constructor. More...
 
 wxRichTextProperties (const wxRichTextProperties &props)
 Copy constructor. More...
 
void operator= (const wxRichTextProperties &props)
 Assignment operator. More...
 
bool operator== (const wxRichTextProperties &props) const
 Equality operator. More...
 
void Copy (const wxRichTextProperties &props)
 Copies from props. More...
 
const wxVariantoperator[] (size_t idx) const
 Returns the variant at the given index. More...
 
wxVariantoperator[] (size_t idx)
 Returns the variant at the given index. More...
 
void Clear ()
 Clears the properties. More...
 
const wxRichTextVariantArray & GetProperties () const
 Returns the array of variants implementing the properties. More...
 
wxRichTextVariantArray & GetProperties ()
 Returns the array of variants implementing the properties. More...
 
void SetProperties (const wxRichTextVariantArray &props)
 Sets the array of variants. More...
 
wxArrayString GetPropertyNames () const
 Returns all the property names. More...
 
size_t GetCount () const
 Returns a count of the properties. More...
 
bool HasProperty (const wxString &name) const
 Returns true if the given property is found. More...
 
int Find (const wxString &name) const
 Finds the given property. More...
 
bool Remove (const wxString &name)
 Removes the given property. More...
 
const wxVariantGetProperty (const wxString &name) const
 Gets the property variant by name. More...
 
wxVariantFindOrCreateProperty (const wxString &name)
 Finds or creates a property with the given name, returning a pointer to the variant. More...
 
wxString GetPropertyString (const wxString &name) const
 Gets the value of the named property as a string. More...
 
long GetPropertyLong (const wxString &name) const
 Gets the value of the named property as a long integer. More...
 
bool GetPropertyBool (const wxString &name) const
 Gets the value of the named property as a boolean. More...
 
double GetPropertyDouble (const wxString &name) const
 Gets the value of the named property as a double. More...
 
void SetProperty (const wxVariant &variant)
 Sets the property by passing a variant which contains a name and value. More...
 
void SetProperty (const wxString &name, const wxVariant &variant)
 Sets a property by name and variant. More...
 
void SetProperty (const wxString &name, const wxString &value)
 Sets a property by name and string value. More...
 
void SetProperty (const wxString &name, const wxChar *value)
 Sets a property by name and wxChar* value. More...
 
void SetProperty (const wxString &name, long value)
 Sets property by name and long integer value. More...
 
void SetProperty (const wxString &name, double value)
 Sets property by name and double value. More...
 
void SetProperty (const wxString &name, bool value)
 Sets property by name and boolean value. More...
 
void RemoveProperties (const wxRichTextProperties &properties)
 Removes the given properties from these properties. More...
 
void MergeProperties (const wxRichTextProperties &properties)
 Merges the given properties with these properties. 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...
 

Protected Attributes

wxRichTextVariantArray m_properties
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. 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...
 

Constructor & Destructor Documentation

wxRichTextProperties::wxRichTextProperties ( )
inline

Default constructor.

wxRichTextProperties::wxRichTextProperties ( const wxRichTextProperties props)
inline

Copy constructor.

Member Function Documentation

void wxRichTextProperties::Clear ( )
inline

Clears the properties.

void wxRichTextProperties::Copy ( const wxRichTextProperties props)
inline

Copies from props.

int wxRichTextProperties::Find ( const wxString name) const

Finds the given property.

wxVariant* wxRichTextProperties::FindOrCreateProperty ( const wxString name)

Finds or creates a property with the given name, returning a pointer to the variant.

size_t wxRichTextProperties::GetCount ( ) const
inline

Returns a count of the properties.

const wxRichTextVariantArray& wxRichTextProperties::GetProperties ( ) const
inline

Returns the array of variants implementing the properties.

wxRichTextVariantArray& wxRichTextProperties::GetProperties ( )
inline

Returns the array of variants implementing the properties.

const wxVariant& wxRichTextProperties::GetProperty ( const wxString name) const

Gets the property variant by name.

bool wxRichTextProperties::GetPropertyBool ( const wxString name) const

Gets the value of the named property as a boolean.

double wxRichTextProperties::GetPropertyDouble ( const wxString name) const

Gets the value of the named property as a double.

long wxRichTextProperties::GetPropertyLong ( const wxString name) const

Gets the value of the named property as a long integer.

wxArrayString wxRichTextProperties::GetPropertyNames ( ) const

Returns all the property names.

wxString wxRichTextProperties::GetPropertyString ( const wxString name) const

Gets the value of the named property as a string.

bool wxRichTextProperties::HasProperty ( const wxString name) const
inline

Returns true if the given property is found.

void wxRichTextProperties::MergeProperties ( const wxRichTextProperties properties)

Merges the given properties with these properties.

void wxRichTextProperties::operator= ( const wxRichTextProperties props)
inline

Assignment operator.

bool wxRichTextProperties::operator== ( const wxRichTextProperties props) const

Equality operator.

const wxVariant& wxRichTextProperties::operator[] ( size_t  idx) const
inline

Returns the variant at the given index.

wxVariant& wxRichTextProperties::operator[] ( size_t  idx)
inline

Returns the variant at the given index.

bool wxRichTextProperties::Remove ( const wxString name)

Removes the given property.

void wxRichTextProperties::RemoveProperties ( const wxRichTextProperties properties)

Removes the given properties from these properties.

void wxRichTextProperties::SetProperties ( const wxRichTextVariantArray &  props)
inline

Sets the array of variants.

void wxRichTextProperties::SetProperty ( const wxVariant variant)

Sets the property by passing a variant which contains a name and value.

void wxRichTextProperties::SetProperty ( const wxString name,
const wxVariant variant 
)

Sets a property by name and variant.

void wxRichTextProperties::SetProperty ( const wxString name,
const wxString value 
)

Sets a property by name and string value.

void wxRichTextProperties::SetProperty ( const wxString name,
const wxChar value 
)

Sets a property by name and wxChar* value.

void wxRichTextProperties::SetProperty ( const wxString name,
long  value 
)

Sets property by name and long integer value.

void wxRichTextProperties::SetProperty ( const wxString name,
double  value 
)

Sets property by name and double value.

void wxRichTextProperties::SetProperty ( const wxString name,
bool  value 
)

Sets property by name and boolean value.

Member Data Documentation

wxRichTextVariantArray wxRichTextProperties::m_properties
protected