ClassificationLayer Class Reference
Provides access to display properties for the classification layer in a product view. More...
#include <ClassificationLayer.h>
Public Member Functions | |
| virtual void | setClassificationFont (const Font &classificationFont)=0 |
| virtual const Font & | getClassificationFont () const =0 |
| virtual void | setClassificationColor (ColorType classificationColor)=0 |
| virtual ColorType | getClassificationColor () const =0 |
Static Public Member Functions | |
| static const std::string & | signalFontChanged () |
| static const std::string & | signalColorChanged () |
Protected Member Functions | |
| virtual | ~ClassificationLayer () |
Detailed Description
Provides access to display properties for the classification layer in a product view.The classification layer is a special kind of graphic layer that contains two text objects. The layer is used in a product view to display the overall classification markings for the product. Only the font, color, and position of the text objects can be changed.
This subclass of Subject will notify upon the following conditions:
- The following methods are called: setClassificationFont() and setClassificationColor().
- Everything else documented in AnnotationLayer.
- See also:
- AnnotationLayer, ProductView
Definition at line 34 of file ClassificationLayer.h.
Constructor & Destructor Documentation
| virtual ClassificationLayer::~ClassificationLayer | ( | ) | [protected, virtual] |
A plug-in cannot create this object, it can only retrieve an already existing object from ProductView::getClassificationLayer.
The ProductView will manage any instances of this object.
Definition at line 96 of file ClassificationLayer.h.
Member Function Documentation
| static const std::string& ClassificationLayer::signalFontChanged | ( | ) | [static] |
Emitted when the font is changed with boost::any<const Font&> containing the new classification text font.
Definition at line 41 of file ClassificationLayer.h.
| static const std::string& ClassificationLayer::signalColorChanged | ( | ) | [static] |
Emitted when the color is changed with boost::any<ColorType> containing the new classification text color.
Definition at line 47 of file ClassificationLayer.h.
| virtual void ClassificationLayer::setClassificationFont | ( | const Font & | classificationFont | ) | [pure virtual] |
Sets the classification text font.
- Parameters:
-
classificationFont The new classification text font.
- Subject Notifications:
- This method will notify signalFontChanged() with boost::any<const Font&> containing the new classification text font.
| virtual const Font& ClassificationLayer::getClassificationFont | ( | ) | const [pure virtual] |
Returns the classification text font.
- Returns:
- The current classification text font.
| virtual void ClassificationLayer::setClassificationColor | ( | ColorType | classificationColor | ) | [pure virtual] |
Sets the classification text color.
- Parameters:
-
classificationColor The new classification text color. This method does nothing if classificationColor is invalid.
- Subject Notifications:
- This method will notify signalColorChanged() with boost::any<ColorType> containing the new classification text color.
- See also:
- ColorType::isValid()
| virtual ColorType ClassificationLayer::getClassificationColor | ( | ) | const [pure virtual] |
Returns the text color of the classification text.
- Returns:
- The classification text color.