DtSymbolDescriptor Class Reference

Descriptors provide a layer of abstraction which the programmer can use to specify the type of symbol to be used for a given key. More...

Inheritance diagram for DtSymbolDescriptor:

Public Member Functions
	DtSymbolDescriptor ()
	default constructor
virtual	~DtSymbolDescriptor ()
	destructor
	DtSymbolDescriptor (const DtSymbolDescriptor &orig)
	copy constructor
virtual DtSymbolDescriptor &	operator= (const DtSymbolDescriptor &rhs)
	assignment operator
virtual bool	operator== (const DtSymbolDescriptor &rhs) const
	equality operators
virtual bool	operator!= (const DtSymbolDescriptor &rhs) const
virtual QString	secondaryInfo () const
	Used for drawer keys that need a second key, such as fontname for text items.
virtual DtSymbol *	createSymbol (DtSymbolDrawer &drawer, const DtEntityMapperKey &key) const =0
void	setColor (const QColor &color)
const QColor &	color () const
void	setTransparencyLevel (int)
int	transparencyLevel () const
void	setOptionalColorParameter (int)
int	optionalColorParameter () const
void	setWriteOut (bool)
bool	writeOut () const
virtual DtSymbolDescriptor *	clone ()=0
virtual QString	descriptorInformation () const
	Called from toFileString(). Fills in specific information for descriptor.
Public Member Functions inherited from DtDescriptor
	DtDescriptor ()
	default constructor
virtual	~DtDescriptor ()
	destructor
	DtDescriptor (const DtDescriptor &orig)
	copy constructor
virtual DtDescriptor &	operator= (const DtDescriptor &rhs)
	assignment operator
virtual bool	operator== (const DtDescriptor &) const
	equality operators
virtual bool	operator!= (const DtDescriptor &) const
virtual const QString &	key () const
virtual void	setKey (const QString &s)
virtual const QString &	keyword () const
virtual void	setKeyword (const QString &s)
virtual QString	type () const =0
virtual QString	info () const =0
virtual QString	descriptorString () const
	Returns a string that can be written to file. Returns an mtl representation.

Protected Member Functions
virtual void	setupOptionSymbolInformation (DtSymbol *mainSymbol) const
Protected Member Functions inherited from DtDescriptor
virtual QString	descriptorType () const
	Returns type(), however, can return a different value.

Protected Attributes
QColor	myColor
int	myTransparencyLevel
int	myOptionalColorParameter
bool	myOptionalData
bool	myWriteOut
Protected Attributes inherited from DtDescriptor
QString	myKey
QString	myKeyword

Detailed Description

Descriptors provide a layer of abstraction which the programmer can use to specify the type of symbol to be used for a given key.

Unlike symbols, descriptors are for generic objects, not specific instances to be drawn on the screen.

For example key "something meaningful" might always be mapped to true type string "S", while "another key" maps to bitmap "B". So, to display 3 "something meaningful" objects on the screen, one would create 3 symbols of subtype true type string and set the additional instance data such as position.

Descriptors are typically used to hold data read from configuration files.

Constructor & Destructor Documentation

DtSymbolDescriptor::DtSymbolDescriptor ( )

inline

default constructor

virtual DtSymbolDescriptor::~DtSymbolDescriptor ( )

inlinevirtual

destructor

DtSymbolDescriptor::DtSymbolDescriptor ( const DtSymbolDescriptor &  orig )

inline

copy constructor

Member Function Documentation

virtual DtSymbolDescriptor& DtSymbolDescriptor::operator= ( const DtSymbolDescriptor &  rhs )

inlinevirtual

assignment operator

Reimplemented in DtUnicodeTTFSymbolDescriptor, DtBmpSymbolDescriptor, DtTtfSymbolDescriptor, DtMMMSymbolDescriptor, DtCircleSymbolDescriptor, DtOverlaySymbolDescriptor, DtBoxSymbolDescriptor, DtMlsSymbolDescriptor, and DtPolygonSymbolDescriptor.

References myColor, myOptionalColorParameter, myOptionalData, myTransparencyLevel, myWriteOut, and DtDescriptor::operator=().

virtual bool DtSymbolDescriptor::operator== ( const DtSymbolDescriptor &  rhs ) const

inlinevirtual

equality operators

Reimplemented in DtUnicodeTTFSymbolDescriptor, DtBmpSymbolDescriptor, DtTtfSymbolDescriptor, DtMMMSymbolDescriptor, DtCircleSymbolDescriptor, DtOverlaySymbolDescriptor, DtBoxSymbolDescriptor, DtMlsSymbolDescriptor, and DtPolygonSymbolDescriptor.

References myColor, myOptionalColorParameter, myOptionalData, myTransparencyLevel, and myWriteOut.

virtual bool DtSymbolDescriptor::operator!= ( const DtSymbolDescriptor &  rhs ) const

inlinevirtual

virtual QString DtSymbolDescriptor::secondaryInfo ( ) const

inlinevirtual

Used for drawer keys that need a second key, such as fontname for text items.

Reimplemented in DtTtfSymbolDescriptor, and DtOverlaySymbolDescriptor.

virtual DtSymbol* DtSymbolDescriptor::createSymbol ( DtSymbolDrawer &  drawer, const DtEntityMapperKey &  key  ) const

pure virtual

Implemented in DtUnicodeTTFSymbolDescriptor, DtBmpSymbolDescriptor, DtOverlaySymbolDescriptor, DtTtfSymbolDescriptor, DtMMMSymbolDescriptor, DtCircleSymbolDescriptor, DtBoxSymbolDescriptor, DtMlsSymbolDescriptor, DtPolygonSymbolDescriptor, and DtTtsSymbolDescriptor.

void DtSymbolDescriptor::setColor ( const QColor &  color )

inline

References color(), myColor, and myOptionalData.

const QColor & DtSymbolDescriptor::color ( ) const

inline

References myColor.

Referenced by setColor().

void DtSymbolDescriptor::setTransparencyLevel ( int  i )

inline

References myOptionalData, and myTransparencyLevel.

int DtSymbolDescriptor::transparencyLevel ( ) const

inline

References myTransparencyLevel.

void DtSymbolDescriptor::setOptionalColorParameter ( int  i )

inline

References myOptionalColorParameter, and myOptionalData.

int DtSymbolDescriptor::optionalColorParameter ( ) const

inline

References myOptionalColorParameter.

void DtSymbolDescriptor::setWriteOut ( bool  b )

inline

References myWriteOut.

bool DtSymbolDescriptor::writeOut ( ) const

inline

References myWriteOut.

virtual DtSymbolDescriptor* DtSymbolDescriptor::clone ( )

pure virtual

Implemented in DtUnicodeTTFSymbolDescriptor, DtOverlaySymbolDescriptor, DtTtfSymbolDescriptor, DtCircleSymbolDescriptor, DtBmpSymbolDescriptor, DtMlsSymbolDescriptor, DtMMMSymbolDescriptor, DtPolygonSymbolDescriptor, DtBoxSymbolDescriptor, and DtTtsSymbolDescriptor.

virtual QString DtSymbolDescriptor::descriptorInformation ( ) const

inlinevirtual

Called from toFileString(). Fills in specific information for descriptor.

Implements DtDescriptor.

Reimplemented in DtUnicodeTTFSymbolDescriptor, DtOverlaySymbolDescriptor, DtTtfSymbolDescriptor, DtCircleSymbolDescriptor, DtBmpSymbolDescriptor, DtMlsSymbolDescriptor, DtMMMSymbolDescriptor, and DtPolygonSymbolDescriptor.

void DtSymbolDescriptor::setupOptionSymbolInformation ( DtSymbol *  mainSymbol ) const

inlineprotectedvirtual

Reimplemented in DtMMMSymbolDescriptor.

References myColor, myTransparencyLevel, DtSymbol::setColor(), and DtSymbol::setTransparencyLevel().

Member Data Documentation

QColor DtSymbolDescriptor::myColor

protected

Referenced by color(), operator=(), operator==(), setColor(), and setupOptionSymbolInformation().

int DtSymbolDescriptor::myTransparencyLevel

protected

Referenced by operator=(), operator==(), setTransparencyLevel(), setupOptionSymbolInformation(), and transparencyLevel().

int DtSymbolDescriptor::myOptionalColorParameter

protected

Referenced by operator=(), operator==(), optionalColorParameter(), and setOptionalColorParameter().

bool DtSymbolDescriptor::myOptionalData

protected

Referenced by operator=(), operator==(), setColor(), setOptionalColorParameter(), and setTransparencyLevel().

bool DtSymbolDescriptor::myWriteOut

protected

Referenced by operator=(), operator==(), setWriteOut(), and writeOut().

---

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

• include/symbolMapper/symbolDesc.h