GlsTextCharAttr Class Reference

#include <gls_text.h>

Inheritance diagram for GlsTextCharAttr:

Public Types
typedef DistiAttributeDictionaryAttribute	_BaseClass
	Deprecated typedef for the base class.
typedef DistiAttributeDictionaryAttribute	BaseClass
	Typedef for the base class.
Public Types inherited from DistiAttributeBase
typedef unsigned int	CallbackID
	Type for unique identifiers.

Public Member Functions
	GlsTextCharAttr (const AttributeName &name, GlsText *text)
virtual bool	OkToWrite () const override
virtual std::ostream &	WriteValue (std::ostream &outstr) override
virtual std::istream &	ReadValue (std::istream &instr) override
Public Member Functions inherited from DistiAttributeDictionaryAttribute
	DistiAttributeDictionaryAttribute (const AttributeName &name, DistiAttribDict *dict)
virtual bool	OkToWrite () const override
virtual void	Add (DistiAttributeBase *attr)
virtual std::ostream &	WriteValue (std::ostream &outstr) override
virtual std::istream &	ReadValue (std::istream &instr) override
Public Member Functions inherited from DistiAttributeBase
	DistiAttributeBase (CallbackMethodCallerBase *callback, const AttributeName &name, bool localStorage)
virtual DistiAttributeBase &	operator= (const DistiAttributeBase &oldClass)
const AttributeName &	Name () const
AttributeName &	Name ()
bool	LocalStorage () const
virtual bool	Copyable () const
virtual bool	OkToWrite () const
virtual bool	ValueChanged ()
virtual void	ResetValueChanged ()
virtual std::string	ValueString ()
virtual void	ValueString (const std::string &s)
virtual long	ValueInt ()
virtual void	ValueInt (long val)
virtual double	ValueFloat ()
virtual void	ValueFloat (double val)
virtual void	CallCallback ()
	Calls callback CallType3 if it has been set.
virtual std::ostream &	WriteValue (std::ostream &outstr)=0
virtual std::istream &	ReadValue (std::istream &instr)=0
virtual bool	operator== (const DistiAttributeBase &r)
template<class valType >
DistiAttributeBase &	operator<< (const valType &val)
template<class valType >
DistiAttributeBase &	operator>> (valType &val)
virtual CallbackID	RegisterObserver (AttributeObserver *observer)
virtual void	UnregisterObserver (CallbackID id)
virtual void	NotifyObservers ()
Public Member Functions inherited from WeakReferenceableMixin
void	AddWeakReference (WeakReference *weakRef) override
void	NotifyWeakReferenceDestroyed (WeakReference *ref) override
virtual void	AddWeakReference (WeakReference *weakRef)=0
virtual void	NotifyWeakReferenceDestroyed (WeakReference *weakReference)=0

Protected Attributes
GlsText *	_text
	Observing pointer to the text object holding the attributes.
GlsText::CharAttr_t	_charAttr
	Character attribute structure to apply to text.
Protected Attributes inherited from DistiAttributeDictionaryAttribute
DistiAttribDict *	_dict
	An observing pointer to a dictionary of attributes.
Protected Attributes inherited from DistiAttributeBase
AttributeName	_name
CallbackMethodCallerBase *	_callback
ScopedPtr< DistiAttributeObserverList >	_observerList
bool	_localStorage
Protected Attributes inherited from WeakReferenceableMixin
DynamicArray< WeakReference * > *	_weakRefs

Additional Inherited Members
Protected Member Functions inherited from WeakReferenceableMixin
	WeakReferenceableMixin ()
virtual	~WeakReferenceableMixin ()

Detailed Description

Attributes of a text character. NOTE: Use of this attribute is deprecated. Instead use individual top-level attributes such as ("FauxBold" and "TextColor").

Constructor & Destructor Documentation

GlsTextCharAttr()

GlsTextCharAttr	(	const AttributeName &	name,
		GlsText *	text
	)

Constructor

Parameters

name	The name to use for this attribute.
text	The text object associated with this attribute.

Member Function Documentation

OkToWrite()

virtual bool OkToWrite ( ) const

inlineoverridevirtual

This SHOULD be overriden by any derived objects that may not be ready to write at any point. The reason for this is the data is often written "NAME: VALUE". If Value is not available, we don't want to write "NAME: " first, so before writing "NAME: ", OkToWrite() can be called to see if it will have a valid value.

Returns

True if this object is ready to have its WriteValue() called.

Reimplemented from DistiAttributeDictionaryAttribute.

ReadValue()

virtual std::istream & ReadValue ( std::istream &  instr )

inlineoverridevirtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to read the data from the stream. The value read could be encoded for being read from a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for encoding the value themselves, or using WriteValue which should perform encoding to maintain symmetry.

Parameters

instr

The stream to read from.

Returns

The input stream in its current state.

Reimplemented from DistiAttributeDictionaryAttribute.

WriteValue()

virtual std::ostream & WriteValue ( std::ostream &  outstr )

inlineoverridevirtual

Pure virtual because this is specific to the data type to be contained. This should be overridden to write the data to the stream. The value written could be encoded for writing to a file as a single string, or have its own special encoding specific to its underlying type. In the case of attribute strings, this will be the GLS file encoded value. The user is responsible for decoding the value themselves, or using ReadValue which should perform decoding to maintain symmetry.

Parameters

outstr

The stream to write to.

Returns

The output stream in its current state.

Reimplemented from DistiAttributeDictionaryAttribute.

---

The documentation for this class was generated from the following file:

• gls_text.h