Markable Class Reference

#include <Markable.hpp>

Inheritance diagram for Markable:

Inheritance graph
[legend]
Collaboration diagram for Markable:

Collaboration graph
[legend]
List of all members.

Detailed Description

This is an interface for markable basic shapes.

Anything that can contain a marker. The only use of this will be by a line which is not fillable as that is the only shape where markers make sense. So this will inherit from BasicShape and will be inherited by Line.

Definition at line 46 of file Markable.hpp.

Public Member Functions

 Markable (void)
 Default constructor.
 Markable (const StrokeStyle &istyle)
 Constructor.
 Markable (const Marker &imarker)
 Constructor.
 Markable (const StrokeStyle &istyle, const Marker &imarker)
 Constructor.
bool hasOwnMarker (void) const
 Accessor. Does this markable have a marker?
Marker getMarker (void) const
 Accessor. What is the marker for this markable?
void setMarker (const Marker &imarker)
 Mutator. Set the marker.
void removeMarker (void)
 Mutator. Remove the marker...use default(or none).

Protected Attributes

Marker marker
 Default marker.
bool hasMarker
 A marker has been set?


Constructor & Destructor Documentation

Markable void   )  [inline]
 

Default constructor.

Definition at line 57 of file Markable.hpp.

References hasMarker.

Markable const StrokeStyle istyle  )  [inline]
 

Constructor.

Defines a basic shape by a StrokeStyle.

Parameters:
istyle appearance of the stroke

Definition at line 65 of file Markable.hpp.

References hasMarker.

Markable const Marker imarker  )  [inline]
 

Constructor.

Defines a basic shape by a Marker.

Parameters:
imarker appearance of the stroke

Definition at line 73 of file Markable.hpp.

References hasMarker, and marker.

Markable const StrokeStyle istyle,
const Marker imarker
[inline]
 

Constructor.

Defines a basic shape by a StrokeStyle and a Marker.

Parameters:
istyle appearance of the stroke
imarker appearance of the stroke

Definition at line 82 of file Markable.hpp.

References hasMarker, and marker.


Member Function Documentation

Marker getMarker void   )  const [inline]
 

Accessor. What is the marker for this markable?

Definition at line 90 of file Markable.hpp.

Referenced by SVGImage::line(), and PSImageBase::line().

bool hasOwnMarker void   )  const [inline]
 

Accessor. Does this markable have a marker?

Definition at line 87 of file Markable.hpp.

void removeMarker void   )  [inline]
 

Mutator. Remove the marker...use default(or none).

Definition at line 96 of file Markable.hpp.

References hasMarker.

void setMarker const Marker imarker  )  [inline]
 

Mutator. Set the marker.

Definition at line 93 of file Markable.hpp.

References hasMarker, and marker.


Member Data Documentation

bool hasMarker [protected]
 

A marker has been set?

Definition at line 104 of file Markable.hpp.

Referenced by Markable(), removeMarker(), and setMarker().

Marker marker [protected]
 

Default marker.

Definition at line 101 of file Markable.hpp.

Referenced by Markable(), and setMarker().


The documentation for this class was generated from the following file:
Generated on Tue Feb 7 03:31:25 2012 for GPS ToolKit Software Library by  doxygen 1.3.9.1