Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
TextRepBase Class Reference

A base class for representations that draws a value as text. More...

#include <TextRepBase.h>

Inheritance diagram for TextRepBase:
Inheritance graph
[legend]
Collaboration diagram for TextRepBase:
Collaboration graph
[legend]

Public Member Functions

virtual RepBaseclone ()=0
 Returns a copy of the object.
virtual const Colorcolor () const
 Returns the representation's color.
virtual void displayError (ViewBase &view)
 Display an error message.
virtual void drawProjectedValues (ProjectorBase &projector, ViewBase &view)=0
 Draws the values from the projector to the view.
virtual void drawProjectedValues (const DataSource *ntuple, TransformBase *transform, ViewBase *view)
 As a convenience for implementors of derived classes of this class, the implementation here does nothing but satisfy the pure virtual function in the base class.
virtual const ColorgetColor () const
 Get the color of the representation.
virtual unsigned int getStyle () const
 Returns the style of the point representation.
const std::string & getText () const
 Gets the text.
virtual const BinToColorgetValueTransform () const
 Returns the value transform.
virtual bool isSelected () const
 Returns true if representation is in selected state, otherwise returns false.
const std::string & name () const
 Returns the name of the representation.
virtual void setColor (const Color &)
 Sets the color of the representation.
virtual void setErrorOn (hippodraw::Axes::Type axis, bool yes=true)
 Sets the error representation on specified axis, if any, to yes.
virtual void setHighLighted (bool yes)
 Sets the highlighted state of the point representation.
virtual void setSelected (bool yes=true)
 Sets the representation to be selected if yes is true, otherwise set it to be deselected.
virtual void setSize (float value)
 Sets the size of the representation.
virtual void setStyle (unsigned int style)
 Sets the symbol of the representation.
void setText (const std::string &text)
 Sets the text.
virtual void setValueTransform (BinToColor *)
 Sets the value transform.
float size () const
 Returns the size of the representation.
virtual bool uses (Color::Value) const
 Returns true if receiving object uses a Color::Value as a property, otherwise returns false.
virtual bool uses (hippodraw::Line::Style) const
 Returns true if receiving object uses a hippodraw::Line::Style as a property, otherwise returns false.
virtual bool uses (hippodraw::Symbol::Type) const
 Returns true if receiving object uses a hippodraw::Symbol::Type as a property, otherwise returns false.
virtual bool xError () const
 Returns true if the point representation displays error on the X axis.
virtual bool yError () const
 Returns true if the point representation displays error on the Y axis.

Protected Member Functions

 TextRepBase (const char *name)
 The following constructor takes the name and size as arguments.

Protected Attributes

Color m_color
 The color of the representation.
bool m_desel
 A flag to indicate the representation is de-selected.
bool m_highlite
 Sets the state of highlighting.
std::string m_name
 The name of the representation.
float m_size
 The size of the representation.
std::string m_text
 The text to be displayed before the statistics.

Static Protected Attributes

static const Color s_desel_color
 The color of the representation when it is de-selected.

Detailed Description

A base class for representations that draws a value as text.

Bug:
@@@ On Mac OS X, he bounding box is not big enough.
Author
Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu

Definition at line 27 of file TextRepBase.h.

Constructor & Destructor Documentation

TextRepBase ( const char *  name)
protected

The following constructor takes the name and size as arguments.

Definition at line 21 of file TextRepBase.cxx.

Member Function Documentation

virtual RepBase* clone ( )
pure virtual

Returns a copy of the object.

Implements RepBase.

Implemented in AverageTextRep, FuncParmRep, FuncChiRep, BoxTextRep, OverflowTextRep, TotalTextRep, and UnderflowTextRep.

const Color & color ( ) const
virtualinherited
void displayError ( ViewBase view)
virtualinherited

Display an error message.

Display an error message instead of drawing a point. This base class implementation displays a message with the name of the RepBase object.

Definition at line 161 of file RepBase.cxx.

References ViewBase::drawText(), RepBase::m_name, and RepBase::m_size.

virtual void drawProjectedValues ( ProjectorBase projector,
ViewBase view 
)
pure virtual

Draws the values from the projector to the view.

Implemented in AverageTextRep, FuncParmRep, FuncChiRep, BoxTextRep, OverflowTextRep, TotalTextRep, and UnderflowTextRep.

void drawProjectedValues ( const DataSource ntuple,
TransformBase transform,
ViewBase view 
)
virtual

As a convenience for implementors of derived classes of this class, the implementation here does nothing but satisfy the pure virtual function in the base class.

See Also
RepBase::drawProjectedValues for details of what might be done.

Implements RepBase.

Definition at line 28 of file TextRepBase.cxx.

const Color & getColor ( ) const
virtualinherited

Get the color of the representation.

Definition at line 58 of file RepBase.cxx.

References RepBase::m_color.

Referenced by PointRepXML::createElement().

unsigned int getStyle ( ) const
virtualinherited

Returns the style of the point representation.

Derived class should override this member function if they support styles. This base class implementation returns 0.

Reimplemented in SymbolPointRep, LinePointRep, and ColumnPointRep.

Definition at line 110 of file RepBase.cxx.

Referenced by PointRepXML::setAttributes().

const std::string & getText ( ) const
inherited

Gets the text.

Definition at line 139 of file RepBase.cxx.

References RepBase::m_text.

Referenced by PointRepXML::setAttributes().

const BinToColor * getValueTransform ( ) const
virtualinherited

Returns the value transform.

A value transform changes a binary value to some graphical representations such as color. The implementation in this base class returns a null pointer. Derived classes that implement value transform should return a pointer to the object it uses.

Reimplemented in ContourPointRep, ColorBoxPointRep, and ColorSymbolPointRep.

Definition at line 147 of file RepBase.cxx.

Referenced by PointRepXML::createElement().

bool isSelected ( ) const
virtualinherited

Returns true if representation is in selected state, otherwise returns false.

Definition at line 79 of file RepBase.cxx.

References RepBase::m_desel.

Referenced by DataRep::isSelected().

const string & name ( ) const
inherited
void setColor ( const Color color)
virtualinherited
void setErrorOn ( hippodraw::Axes::Type  axis,
bool  yes = true 
)
virtualinherited

Sets the error representation on specified axis, if any, to yes.

Reimplemented in SymbolPointRep, and ColumnPointRep.

Definition at line 129 of file RepBase.cxx.

Referenced by PointRepXML::createObject().

void setHighLighted ( bool  yes)
virtualinherited

Sets the highlighted state of the point representation.

If yes is true, then the point representation should show the non highlighted regions in some fashion, typically using light gray color instead of its normal color.

See Also
setSelected (bool)
m_ranges.

Definition at line 86 of file RepBase.cxx.

References RepBase::m_highlite.

void setSelected ( bool  yes = true)
virtualinherited

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

Reimplemented in PointRepBase.

Definition at line 72 of file RepBase.cxx.

References RepBase::m_desel.

Referenced by PointRepBase::setSelected(), and DataRep::setSelected().

void setSize ( float  value)
virtualinherited

Sets the size of the representation.

Derived classes may use this method to set the size of the point representation and any of its components.

Reimplemented in SymbolPointRep, and ColumnPointRep.

Definition at line 96 of file RepBase.cxx.

References RepBase::m_size, and RepBase::size().

Referenced by PointRepXML::createObject(), and DataRep::setRepSize().

void setStyle ( unsigned int  style)
virtualinherited

Sets the symbol of the representation.

Derived classes may use this method to set the style of the representation, if they have various styles. This base class implementation does nothing.

Reimplemented in SymbolPointRep, LinePointRep, and ColumnPointRep.

Definition at line 103 of file RepBase.cxx.

Referenced by DataRep::setRepStyle().

void setText ( const std::string &  text)
inherited

Sets the text.

Definition at line 133 of file RepBase.cxx.

References RepBase::m_text.

Referenced by PointRepXML::createObject(), and DisplayController::createTextDataRep().

void setValueTransform ( BinToColor )
virtualinherited

Sets the value transform.

The implementation in this base class does nothing. Derived classes that implement a value transform should override this method and take possession of the received object.

Todo:
Should have base class that doesn't know about color and BinToColor class should derive from it.

Reimplemented in ContourPointRep, ColorBoxPointRep, and ColorSymbolPointRep.

Definition at line 154 of file RepBase.cxx.

float size ( ) const
inherited
bool uses ( Color::Value  ) const
virtualinherited

Returns true if receiving object uses a Color::Value as a property, otherwise returns false.

This base class implementation returns true as most derived classes use a Color::Value as a property. Derived classes that do not, such as those that represent a value in color, should override this member function and return false.

Reimplemented in ColorBoxPointRep, and ColorSymbolPointRep.

Definition at line 171 of file RepBase.cxx.

bool uses ( hippodraw::Line::Style  ) const
virtualinherited

Returns true if receiving object uses a hippodraw::Line::Style as a property, otherwise returns false.

This base class implementation returns false. Derived classes that use hippodraw::Line::Style should override this member function and return true.

Reimplemented in LinePointRep, and ColumnPointRep.

Definition at line 178 of file RepBase.cxx.

bool uses ( hippodraw::Symbol::Type  ) const
virtualinherited

Returns true if receiving object uses a hippodraw::Symbol::Type as a property, otherwise returns false.

This base class implementation returns false. Derived classes that use hippodraw::Symbol::Type should override this member function and return true.

Reimplemented in SymbolPointRep.

Definition at line 185 of file RepBase.cxx.

bool xError ( ) const
virtualinherited

Returns true if the point representation displays error on the X axis.

The default implementation returns false. May be overridden by derived classes.

Reimplemented in SymbolPointRep.

Definition at line 116 of file RepBase.cxx.

Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

bool yError ( ) const
virtualinherited

Returns true if the point representation displays error on the Y axis.

The default implementation returns false. May be overridden by derived classes.

Reimplemented in SymbolPointRep, and ColumnPointRep.

Definition at line 122 of file RepBase.cxx.

Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

Member Data Documentation

Color m_color
protectedinherited
bool m_desel
protectedinherited
bool m_highlite
protectedinherited

Sets the state of highlighting.

Definition at line 70 of file RepBase.h.

Referenced by RepBase::setHighLighted().

std::string m_name
protectedinherited
float m_size
protectedinherited
std::string m_text
protectedinherited

The text to be displayed before the statistics.

Definition at line 54 of file RepBase.h.

Referenced by BoxTextRep::drawProjectedValues(), RepBase::getText(), and RepBase::setText().

const Color s_desel_color
staticprotectedinherited

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

Generated for HippoDraw Class Library by doxygen