casa::PlotMSAnnotator Class Reference

Subclass of PlotMouseTool for drawing/managing annotations on the plot canvases of PlotMSApp. More...

#include <PlotMSAnnotator.h>

Inheritance diagram for casa::PlotMSAnnotator:

Public Types
enum	Mode { TEXT, RECTANGLE }
	Static //. More...
Public Member Functions
	PlotMSAnnotator (PlotMSPlotter *parent, Mode startingMode=TEXT)
	Non-Static //.
	~PlotMSAnnotator ()
	Destructor.
Mode	drawingMode () const
	Gets/Sets the current drawing mode.
void	setDrawingMode (Mode mode)
PlotFontPtr	textFont () const
	Gets/Sets the current text properties (null means default for PlotAnnotation object).
void	setTextFont (const PlotFontPtr font)
PlotLinePtr	textOutline () const
void	setTextOutline (const PlotLinePtr outline)
PlotAreaFillPtr	textBackground () const
void	setTextBackground (const PlotAreaFillPtr background)
PlotLinePtr	rectangleLine () const
	Gets/Sets the current rectangle properties (null means default for PlotShapeRectangle object).
void	setRectangleLine (const PlotLinePtr line)
PlotAreaFillPtr	rectangleAreaFill () const
void	setRectangleAreaFill (const PlotAreaFillPtr fill)
void	clearText (PlotCanvas *canvas=NULL)
	Clears all text/rectangle annotations off the given canvas.
void	clearRectangles (PlotCanvas *canvas=NULL)
void	clearAll (PlotCanvas *canvas=NULL)
void	setActive (bool isActive=true)
	Overrides PlotTool::setActive().
void	handleMouseEvent (const PlotEvent &event)
	Implements PlotMouseTool::handleMouseEvent().
void	plotsChanged (const PlotMSPlotManager &manager)
	Implements PlotMSPlotManagerWatcher::plotChanged().
Protected Member Functions
void	setActions (QAction annotateAction, const QMap< PlotMSAction::Type, QAction > &actionMap, PlotFactoryPtr factory)
	Sets the annotate and mode actions and the factory to the given.
void	attach (PlotCanvas *canvas)
	Overrides PlotTool::attach().
void	detach ()
	Overrides PlotTool::detach().
Private Member Functions
void	setDefaults ()
	Sets properties to their defaults.
Private Attributes
PlotFactoryPtr	itsFactory_
	Parent.
Mode	itsMode_
	Current drawing mode.
QAction *	itsAnnotateAction_
	Actions to keep updated.
QMap< Mode, QAction * >	itsModeActions_
QMultiMap< PlotCanvas *, PlotAnnotationPtr >	itsAText_
	Text annotations.
PlotFontPtr	itsTextFont_
	Current text properties.
PlotLinePtr	itsTextOutline_
PlotAreaFillPtr	itsTextFill_
QMultiMap< PlotCanvas *, PlotShapeRectanglePtr >	itsARect_
	Rectangle annotations.
PlotLinePtr	itsRectLine_
	Current rectangle properties.
PlotAreaFillPtr	itsRectFill_
PlotMSPlotter *	guiParent
Friends
class	PlotMSPlotter

Detailed Description

Subclass of PlotMouseTool for drawing/managing annotations on the plot canvases of PlotMSApp.

Definition at line 44 of file PlotMSAnnotator.h.

Member Enumeration Documentation

enum casa::PlotMSAnnotator::Mode

Static //.

Drawing mode for the annotator.

Enumerator:

TEXT
RECTANGLE

Definition at line 53 of file PlotMSAnnotator.h.

Constructor & Destructor Documentation

casa::PlotMSAnnotator::PlotMSAnnotator	(	PlotMSPlotter *	parent,
		Mode	startingMode = `TEXT`
	)

Non-Static //.

Constructor which takes the PlotMS parent and optional starting mode.

casa::PlotMSAnnotator::~PlotMSAnnotator ( )

Destructor.

Member Function Documentation

void casa::PlotMSAnnotator::attach ( PlotCanvas * canvas ) [protected, virtual]

Overrides PlotTool::attach().

Reimplemented from casa::PlotTool.

void casa::PlotMSAnnotator::clearAll ( PlotCanvas * canvas = NULL )

void casa::PlotMSAnnotator::clearRectangles ( PlotCanvas * canvas = NULL )

void casa::PlotMSAnnotator::clearText ( PlotCanvas * canvas = NULL )

Clears all text/rectangle annotations off the given canvas.

If the given canvas is NULL, then it clears them from all canvases.

void casa::PlotMSAnnotator::detach ( ) [protected, virtual]

Overrides PlotTool::detach().

Reimplemented from casa::PlotTool.

Mode casa::PlotMSAnnotator::drawingMode ( ) const

Gets/Sets the current drawing mode.

void casa::PlotMSAnnotator::handleMouseEvent ( const PlotEvent & event ) [virtual]

Implements PlotMouseTool::handleMouseEvent().

Implements casa::PlotMouseTool.

void casa::PlotMSAnnotator::plotsChanged ( const PlotMSPlotManager & manager ) [virtual]

Implements PlotMSPlotManagerWatcher::plotChanged().

Removes annotations that are attached to canvases that no longer exist.

Implements casa::PlotMSPlotManagerWatcher.

PlotAreaFillPtr casa::PlotMSAnnotator::rectangleAreaFill ( ) const

PlotLinePtr casa::PlotMSAnnotator::rectangleLine ( ) const

Gets/Sets the current rectangle properties (null means default for PlotShapeRectangle object).

Only applies to future rectangle annotations.

void casa::PlotMSAnnotator::setActions	(	QAction *	annotateAction,
		const QMap< PlotMSAction::Type, QAction * > &	actionMap,
		PlotFactoryPtr	factory
	)			`[protected]`