Text Class Reference

A text object that can be displayed in a plot. More...

#include <Text.h>

Inheritance diagram for Text:

List of all members.

Public Member Functions
virtual double	getXLocation () const =0
virtual double	getYLocation () const =0
virtual const LocationType &	getLocation () const =0
virtual std::string	getText () const =0
virtual ColorType	getColor () const =0
virtual bool	hit (LocationType point) const =0
virtual void	setLocation (const LocationType &location)=0
virtual void	setLocation (double dX, double dY)=0
virtual void	setText (const std::string &strText)=0
virtual void	setColor (const ColorType &clrText)=0
Static Public Member Functions
static const std::string &	signalLocationChanged ()
static const std::string &	signalColorChanged ()
static const std::string &	signalTextChanged ()
Protected Member Functions
virtual	~Text ()

---

Detailed Description

A text object that can be displayed in a plot.

This subclass of Subject will notify upon the following conditions:

• The following methods are called: setLocation(), setText(), setColor().
• Everything else documented in PlotObject.

See also:

Text

Definition at line 28 of file Text.h.

---

Constructor & Destructor Documentation

virtual Text::~Text

(

)

[protected, virtual]

This should be destroyed by calling PlotView::deleteObject.

Definition at line 132 of file Text.h.

---

Member Function Documentation

static const std::string& Text::signalLocationChanged

(

)

[static]

Emitted with any<LocationType> when the text is moved.

Definition at line 34 of file Text.h.

static const std::string& Text::signalColorChanged

(

)

[static]

Emitted with any<ColorType> when the color is changed.

Definition at line 38 of file Text.h.

static const std::string& Text::signalTextChanged

(

)

[static]

Emitted with any<std::string> when the text is changed.

Definition at line 42 of file Text.h.

virtual double Text::getXLocation

(

)

const [pure virtual]

Returns the texts x location.

Returns:

The x location

virtual double Text::getYLocation

(

)

const [pure virtual]

Returns the texts y location.

Returns:

The y location

virtual const LocationType& Text::getLocation

(

)

const [pure virtual]

Returns the text location.

Returns:

The text location

See also:

LocationType

virtual std::string Text::getText

(

)

const [pure virtual]

Returns the text.

Returns:

The text

virtual ColorType Text::getColor

(

)

const [pure virtual]

Returns the text color.

Returns:

The text color

virtual bool Text::hit

(

LocationType

point

)

const [pure virtual]

Determines if this plot object resides at this point, most likely a mouse click.

Parameters:

point

The location of the mouse click

Returns:

True if the plot object is at this point

virtual void Text::setLocation

(

const LocationType &

location

)

[pure virtual]

Sets the text location.

Parameters:

location

The new location

See also:

LocationType

Subject Notifications:

This method will notify signalLocationChanged with any<LocationType>.

virtual void Text::setLocation	(	double	dX,
		double	dY
	)			[pure virtual]

Sets the text location.

Parameters:

	dX	The x location
	dY	The y location

Subject Notifications:

This method will notify signalLocationChanged with any<LocationType>.

virtual void Text::setText

(

const std::string &

strText

)

[pure virtual]

Sets the text.

Parameters:

strText

The new text

Subject Notifications:

This method will notify signalTextChanged with any<std::string>.

virtual void Text::setColor

(

const ColorType &

clrText

)

[pure virtual]

Sets the text color.

Parameters:

clrText

The new color

Subject Notifications:

This method will notify signalColorChanged with any<ColorType>.