casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Types | Public Member Functions | Static Protected Attributes
casa::PlotAreaFill Class Reference

Abstract class for area fill. More...

#include <PlotOptions.h>

List of all members.

Public Types

enum  Pattern {
  FILL,
  MESH1,
  MESH2,
  MESH3,
  NOFILL
}
 Pattern enum, similar in spirit to http://doc.trolltech.com/4.3/qt.html#BrushStyle-enum . More...

Public Member Functions

 PlotAreaFill ()
 Constructor.
virtual ~PlotAreaFill ()
 Destructor.
virtual PlotColorPtr color () const =0
 ABSTRACT METHODS //.
virtual void setColor (const PlotColor &color)=0
 Sets the area fill color to the given.
virtual Pattern pattern () const =0
 Returns the pattern for this area fill.
virtual void setPattern (Pattern pattern)=0
 Sets the pattern for this area fill to the given.
virtual void setColor (const PlotColorPtr c)
 CONVENIENCE METHODS //.
virtual void setColor (const String &co)
virtual Record toRecord () const
 RECORD METHODS //.
virtual void fromRecord (const Record &record)
virtual PlotAreaFilloperator= (const PlotAreaFill &rh)
 OPERATORS //.
virtual bool operator== (const PlotAreaFill &rh) const
 Returns true if this PlotAreaFill is equal to the given; false otherwise.
virtual bool operator!= (const PlotAreaFill &rh) const
 Returns true if this PlotAreaFill is NOT equal to the given; false otherwise.

Static Protected Attributes

static const String REC_COLOR
 Record key names.
static const String REC_PATTERN

Detailed Description

Abstract class for area fill.

An area fill consists of a color and a pattern.

Definition at line 286 of file PlotOptions.h.


Member Enumeration Documentation

Pattern enum, similar in spirit to http://doc.trolltech.com/4.3/qt.html#BrushStyle-enum .

Enumerator:
FILL 
MESH1 
MESH2 
MESH3 
NOFILL 

Definition at line 290 of file PlotOptions.h.


Constructor & Destructor Documentation

Constructor.

virtual casa::PlotAreaFill::~PlotAreaFill ( ) [virtual]

Destructor.


Member Function Documentation

virtual PlotColorPtr casa::PlotAreaFill::color ( ) const [pure virtual]

ABSTRACT METHODS //.

Returns a copy of the color in this area fill.

virtual void casa::PlotAreaFill::fromRecord ( const Record record) [virtual]
virtual bool casa::PlotAreaFill::operator!= ( const PlotAreaFill rh) const [virtual]

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

virtual PlotAreaFill& casa::PlotAreaFill::operator= ( const PlotAreaFill rh) [virtual]

OPERATORS //.

Assigns the value of the given PlotAreaFill to this one.

virtual bool casa::PlotAreaFill::operator== ( const PlotAreaFill rh) const [virtual]

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

virtual Pattern casa::PlotAreaFill::pattern ( ) const [pure virtual]

Returns the pattern for this area fill.

virtual void casa::PlotAreaFill::setColor ( const PlotColor color) [pure virtual]

Sets the area fill color to the given.

Referenced by casa::PlotShape::setAreaFill(), casa::BarPlot::setAreaFill(), and casa::PlotAnnotation::setBackground().

virtual void casa::PlotAreaFill::setColor ( const PlotColorPtr  c) [virtual]

CONVENIENCE METHODS //.

Convenience methods for setting color.

virtual void casa::PlotAreaFill::setColor ( const String co) [virtual]
virtual void casa::PlotAreaFill::setPattern ( Pattern  pattern) [pure virtual]

Sets the pattern for this area fill to the given.

Referenced by casa::PlotShape::setAreaFill(), casa::BarPlot::setAreaFill(), and casa::PlotAnnotation::setBackground().

virtual Record casa::PlotAreaFill::toRecord ( ) const [virtual]

RECORD METHODS //.

Gets/Sets the color as a Record.


Member Data Documentation

const String casa::PlotAreaFill::REC_COLOR [static, protected]

Record key names.

Definition at line 350 of file PlotOptions.h.

const String casa::PlotAreaFill::REC_PATTERN [static, protected]

Definition at line 351 of file PlotOptions.h.


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