TextPoint Struct Reference

#include <TextModel.h>

Inherits XmlExportable.

Inheritance diagram for TextPoint:

[legend]Collaboration diagram for TextPoint:

[legend]List of all members.

---

Detailed Description

Text point type for use in a SparseModel.

This represents a piece of text at a given time and y-value in the [0,1) range (indicative of height on the window). Intended for casual textual annotations.

Definition at line 29 of file TextModel.h.

Public Member Functions
	TextPoint (long _frame)
	TextPoint (long _frame, float _height, QString _label)
int	getDimensions () const
QString	getLabel () const
void	toXml (QTextStream &stream, QString indent="", QString extraAttributes="") const
	Stream this exportable object out to XML on a text stream.
QString	toDelimitedDataString (QString delimiter, size_t sampleRate) const
virtual QString	toXmlString (QString indent="", QString extraAttributes="") const
	Convert this exportable object to XML in a string.
Static Public Member Functions
static QString	encodeEntities (QString)
static QString	encodeColour (QColor)
static int	getObjectExportId (const void *)
Public Attributes
long	frame
float	height
QString	label
Classes
struct	Comparator
struct	OrderComparator

---

Constructor & Destructor Documentation

TextPoint::TextPoint

(

long

_frame

)

[inline]

Definition at line 32 of file TextModel.h.

TextPoint::TextPoint	(	long	_frame,
		float	_height,
		QString	_label
	)			[inline]

Definition at line 33 of file TextModel.h.

---

Member Function Documentation

int TextPoint::getDimensions

(

)

const [inline]

Definition at line 36 of file TextModel.h.

QString TextPoint::getLabel

(

)

const [inline]

Definition at line 42 of file TextModel.h.

References label.

void TextPoint::toXml	(	QTextStream &	stream,
		QString	indent = "",
		QString	extraAttributes = ""
	)			const [inline, virtual]

Stream this exportable object out to XML on a text stream.

Implements XmlExportable.

Definition at line 44 of file TextModel.h.

References XmlExportable::encodeEntities(), frame, height, and label.

QString TextPoint::toDelimitedDataString	(	QString	delimiter,
		size_t	sampleRate
	)			const [inline]

Definition at line 52 of file TextModel.h.

References frame, RealTime::frame2RealTime(), height, label, and RealTime::toString().

QString XmlExportable::toXmlString	(	QString	indent = "",
		QString	extraAttributes = ""
	)			const [virtual, inherited]

Convert this exportable object to XML in a string.

The default implementation calls toXml and returns the result as a string. Do not override this unless you really know what you're doing.

Definition at line 25 of file XmlExportable.cpp.

References XmlExportable::toXml().

Referenced by LayerFactory::setLayerDefaultProperties().

QString XmlExportable::encodeEntities

(

QString

)

[static, inherited]

Definition at line 41 of file XmlExportable.cpp.

Referenced by AudioGenerator::getDefaultPlayPluginConfiguration(), SVFileReader::readPlugin(), Layer::toBriefXml(), WaveFileModel::toXml(), Transform::toXml(), toXml(), PluginXml::toXml(), Model::toXml(), Layer::toXml(), ImagePoint::toXml(), and Document::writeBackwardCompatibleDerivation().

QString XmlExportable::encodeColour

(

QColor

)

[static, inherited]

Definition at line 54 of file XmlExportable.cpp.

Referenced by ColourDatabase::getStringValues().

int XmlExportable::getObjectExportId

(

const void *

)

[static, inherited]

Definition at line 71 of file XmlExportable.cpp.

Referenced by FFTDataServer::generateFileBasename(), View::getTextLabelHeight(), Layer::toBriefXml(), SparseModel< PointType >::toXml(), Model::toXml(), Layer::toXml(), EditableDenseThreeDimensionalModel::toXml(), Document::toXml(), and Document::writeBackwardCompatibleDerivation().

---

Member Data Documentation

long TextPoint::frame

Definition at line 38 of file TextModel.h.

Referenced by TextLayer::moveSelection(), TextPoint::OrderComparator::operator()(), TextPoint::Comparator::operator()(), toDelimitedDataString(), and toXml().

float TextPoint::height

Definition at line 39 of file TextModel.h.

Referenced by TextPoint::Comparator::operator()(), toDelimitedDataString(), and toXml().

QString TextPoint::label

Definition at line 40 of file TextModel.h.

Referenced by getLabel(), TextPoint::Comparator::operator()(), toDelimitedDataString(), and toXml().

---

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

• TextModel.h

---