casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Protected Attributes | List of all members
casa::PlotFont Class Referenceabstract

Abstract class for fonts. More...

#include <PlotOptions.h>

Public Member Functions

 PlotFont ()
 Constructor. More...
 
virtual ~PlotFont ()
 Destructor. More...
 
virtual double pointSize () const =0
 ABSTRACT METHODS //. More...
 
virtual void setPointSize (double size)=0
 Sets the point size of this font to the given. More...
 
virtual int pixelSize () const =0
 Returns the pixel size of this font, or -1 if the size was set in points. More...
 
virtual void setPixelSize (int size)=0
 Sets the pixel size of this font to the given. More...
 
virtual casacore::String fontFamily () const =0
 Returns the font family. More...
 
virtual void setFontFamily (const casacore::String &font)=0
 Sets the font family to the given. More...
 
virtual PlotColorPtr color () const =0
 Returns a copy of the color for this font. More...
 
virtual void setColor (const PlotColor &color)=0
 Sets the color of this font to the given. More...
 
virtual bool italics () const =0
 Gets/sets whether this font is italicized, bolded, and/or underlined, respectively. More...
 
virtual void setItalics (bool i=true)=0
 
virtual bool bold () const =0
 
virtual void setBold (bool b=true)=0
 
virtual bool underline () const =0
 
virtual void setUnderline (bool u=true)=0
 
virtual void setColor (const PlotColorPtr c)
 CONVENIENCE METHODS //. More...
 
virtual void setColor (const casacore::String &col)
 
virtual casacore::Record toRecord () const
 RECORD METHODS //. More...
 
virtual void fromRecord (const casacore::Record &record)
 
virtual PlotFontoperator= (const PlotFont &rh)
 OPERATORS //. More...
 
virtual bool operator== (const PlotFont &rh) const
 Returns true if this PlotFont is equal to the given; false otherwise. More...
 
virtual bool operator!= (const PlotFont &rh) const
 Returns true if this PlotFont is NOT equal to the given; false otherwise. More...
 

Static Protected Attributes

static const casacore::String REC_POINTSIZE
 casacore::Record key names. More...
 
static const casacore::String REC_PIXELSIZE
 
static const casacore::String REC_FAMILY
 
static const casacore::String REC_COLOR
 
static const casacore::String REC_ITALICS
 
static const casacore::String REC_BOLD
 
static const casacore::String REC_UNDERLINE
 

Detailed Description

Abstract class for fonts.

A font has a family, size, color, bold, italics, and underline properties.

Definition at line 200 of file PlotOptions.h.

Constructor & Destructor Documentation

casa::PlotFont::PlotFont ( )

Constructor.

virtual casa::PlotFont::~PlotFont ( )
virtual

Destructor.

Member Function Documentation

virtual bool casa::PlotFont::bold ( ) const
pure virtual
virtual PlotColorPtr casa::PlotFont::color ( ) const
pure virtual

Returns a copy of the color for this font.

virtual casacore::String casa::PlotFont::fontFamily ( ) const
pure virtual

Returns the font family.

virtual void casa::PlotFont::fromRecord ( const casacore::Record record)
virtual
virtual bool casa::PlotFont::italics ( ) const
pure virtual

Gets/sets whether this font is italicized, bolded, and/or underlined, respectively.

virtual bool casa::PlotFont::operator!= ( const PlotFont rh) const
virtual

Returns true if this PlotFont is NOT equal to the given; false otherwise.

virtual PlotFont& casa::PlotFont::operator= ( const PlotFont rh)
virtual

OPERATORS //.

Assigns the value of the given PlotFont to this one.

virtual bool casa::PlotFont::operator== ( const PlotFont rh) const
virtual

Returns true if this PlotFont is equal to the given; false otherwise.

virtual int casa::PlotFont::pixelSize ( ) const
pure virtual

Returns the pixel size of this font, or -1 if the size was set in points.

virtual double casa::PlotFont::pointSize ( ) const
pure virtual

ABSTRACT METHODS //.

Returns the point size of this font, or -1 if the size was set in pixels.

virtual void casa::PlotFont::setBold ( bool  b = true)
pure virtual
virtual void casa::PlotFont::setColor ( const PlotColor color)
pure virtual

Sets the color of this font to the given.

virtual void casa::PlotFont::setColor ( const PlotColorPtr  c)
virtual

CONVENIENCE METHODS //.

Convenience methods for setting color.

virtual void casa::PlotFont::setColor ( const casacore::String col)
virtual
virtual void casa::PlotFont::setFontFamily ( const casacore::String font)
pure virtual

Sets the font family to the given.

virtual void casa::PlotFont::setItalics ( bool  i = true)
pure virtual
virtual void casa::PlotFont::setPixelSize ( int  size)
pure virtual

Sets the pixel size of this font to the given.

virtual void casa::PlotFont::setPointSize ( double  size)
pure virtual

Sets the point size of this font to the given.

virtual void casa::PlotFont::setUnderline ( bool  u = true)
pure virtual
virtual casacore::Record casa::PlotFont::toRecord ( ) const
virtual

RECORD METHODS //.

Gets/Sets the color as a Record.

virtual bool casa::PlotFont::underline ( ) const
pure virtual

Member Data Documentation

const casacore::String casa::PlotFont::REC_BOLD
staticprotected

Definition at line 287 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_COLOR
staticprotected

Definition at line 285 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_FAMILY
staticprotected

Definition at line 284 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_ITALICS
staticprotected

Definition at line 286 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_PIXELSIZE
staticprotected

Definition at line 283 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_POINTSIZE
staticprotected

casacore::Record key names.

Definition at line 282 of file PlotOptions.h.

const casacore::String casa::PlotFont::REC_UNDERLINE
staticprotected

Definition at line 288 of file PlotOptions.h.


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