cee::ug::OverlayPlotPropertyHandler Class Reference

Property handler for overlay plot properties. More...

Public Types

enum  PropertyKey {
  CONTEXT_OVERLAY_PLOT_ID, HEIGHT, WIDTH, TITLE,
  DRAW_BACKGROUND, BACKGROUND_COLOR, BACKGROUND_OPACITY, BORDER_COLOR,
  BORDER_WIDTH, DRAW_BORDER, X_AXIS_TITLE, Y_AXIS_TITLE,
  X_AXIS_RANGE_MIN, X_AXIS_RANGE_MAX, Y_AXIS_RANGE_MIN, Y_AXIS_RANGE_MAX,
  DRAW_LEGEND, TEXT_COLOR, DRAW_GRID_LINES, DRAW_MARKER_LINE,
  MARKER_LINE_VALUE, MARKER_LINE_COLOR, AXIS_COLOR, AXIS_GRID_LINES_COLOR,
  LOGARITHMIC_SCALE_X, LOGARITHMIC_SCALE_Y
}
 List of property keys for OverlayPlotPropertyHandler. More...
 

Public Member Functions

 OverlayPlotPropertyHandler (PropertySet *propSet)
 Creates an overlay plot property handler from a given property set propSet. More...
 
Variant propertyValue (PropertyKey key) const
 Returns the property value for the specified property key. More...
 
void setPropertyValue (PropertyKey key, Variant data)
 Sets the property key and value to this handlers property set. More...
 

Static Public Member Functions

static Str propertySetClassType ()
 Returns the class type of the property set. More...
 
static bool isValidPropertySet (const PropertySet &propSet)
 Returns true if the specified property set is a valid overlay plot property set. More...
 

Detailed Description

Property handler for overlay plot properties.

Member Enumeration Documentation

List of property keys for OverlayPlotPropertyHandler.

Enumerator
CONTEXT_OVERLAY_PLOT_ID 

Unique id for identifying a plot.

HEIGHT 

Overlay plot height

WIDTH 

Overlay plot width

TITLE 

Plot title.

DRAW_BACKGROUND 

Draw background.

BACKGROUND_COLOR 

Background color

BACKGROUND_OPACITY 

Background opacity

BORDER_COLOR 

Border color.

BORDER_WIDTH 

Border width.

DRAW_BORDER 

Draw border.

X_AXIS_TITLE 

The title of the x axis.

Y_AXIS_TITLE 

The title of the y axis.

X_AXIS_RANGE_MIN 

Minimum x axis range value.

X_AXIS_RANGE_MAX 

Maximum x axis range value.

Y_AXIS_RANGE_MIN 

Minimum y axis range value.

Y_AXIS_RANGE_MAX 

Maximum y axis range value.

DRAW_LEGEND 

Draw the curve legend.

TEXT_COLOR 

Color of text in the plot (labels/titles)

DRAW_GRID_LINES 

Draw grid lines.

DRAW_MARKER_LINE 

Draw marker line.

MARKER_LINE_VALUE 

Marker line value.

MARKER_LINE_COLOR 

Marker line color.

AXIS_COLOR 

Axis color.

AXIS_GRID_LINES_COLOR 

Axis grid lines color.

LOGARITHMIC_SCALE_X 

Use logarithmic scaling.

LOGARITHMIC_SCALE_Y 

Use logarithmic scaling.

Constructor & Destructor Documentation

cee::ug::OverlayPlotPropertyHandler::OverlayPlotPropertyHandler ( PropertySet propSet)

Creates an overlay plot property handler from a given property set propSet.

Member Function Documentation

bool cee::ug::OverlayPlotPropertyHandler::isValidPropertySet ( const PropertySet propSet)
static

Returns true if the specified property set is a valid overlay plot property set.

Str cee::ug::OverlayPlotPropertyHandler::propertySetClassType ( )
static

Returns the class type of the property set.

cee::Variant cee::ug::OverlayPlotPropertyHandler::propertyValue ( PropertyKey  key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void cee::ug::OverlayPlotPropertyHandler::setPropertyValue ( PropertyKey  key,
Variant  data 
)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.