Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::TemplateParameter Class Referenceabstract

Template parameter class. More...

Public Member Functions

virtual ~TemplateParameter ()
 Default Destructor. More...
 
virtual const char * getName () const =0
 Parameter name. More...
 
virtual unsigned getNumValues () const =0
 Number of parameter values. More...
 
virtual const char * getValue (const unsigned index) const =0
 I-th parameter value. More...
 
virtual const char * getValueForKey (const unsigned index, ColorSpaceAttributeKey key) const =0
 I-th parameter value. More...
 
virtual SYNCOLOR::SynStatus select (const unsigned index)=0
 Select a parameter value based on its index. More...
 
virtual SYNCOLOR::SynStatus select (const char *value)=0
 Select a parameter value based on its value. More...
 
virtual void deselect ()=0
 Clear the template parameter selection. More...
 
virtual int getSelectedIndex () const =0
 Selected value index. More...
 
virtual const char * getSelectedValue () const =0
 Selected value. More...
 
virtual const char * getSelectedValueForKey (ColorSpaceAttributeKey key) const =0
 Selected value. More...
 

Detailed Description

Template parameter class.

A template parameter provides a list of values, and a selection mechanism.

Constructor & Destructor Documentation

virtual SYNCOLOR::TemplateParameter::~TemplateParameter ( )
virtual

Default Destructor.

Member Function Documentation

virtual const char* SYNCOLOR::TemplateParameter::getName ( ) const
pure virtual

Parameter name.

Returns
Template parameter name. This string is not to be deleted.
virtual unsigned SYNCOLOR::TemplateParameter::getNumValues ( ) const
pure virtual

Number of parameter values.

Returns
Number of values.
virtual const char* SYNCOLOR::TemplateParameter::getValue ( const unsigned  index) const
pure virtual

I-th parameter value.

Parameters
indexParameter index.
Returns
Parameter name value (i.e NameKey), or NULL if the index is out of bounds. This string is not to be deleted.
virtual const char* SYNCOLOR::TemplateParameter::getValueForKey ( const unsigned  index,
ColorSpaceAttributeKey  key 
) const
pure virtual

I-th parameter value.

Parameters
indexParameter index.
keyParameter key.
Returns
Parameter value for the specified key, or NULL if the index is out of bounds. This string is not be deleted.
virtual SYNCOLOR::SynStatus SYNCOLOR::TemplateParameter::select ( const unsigned  index)
pure virtual

Select a parameter value based on its index.

If the index is out of bounds, the previous selection remains unchanged.

Parameters
indexSelected index.
Returns
Returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred.
virtual SYNCOLOR::SynStatus SYNCOLOR::TemplateParameter::select ( const char *  value)
pure virtual

Select a parameter value based on its value.

If the value is not present in the list, the previous selection remains unchanged.

Parameters
valueSelected value for the name value (i.e NameKey).
Returns
Returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred.
virtual void SYNCOLOR::TemplateParameter::deselect ( )
pure virtual

Clear the template parameter selection.

virtual int SYNCOLOR::TemplateParameter::getSelectedIndex ( ) const
pure virtual

Selected value index.

Returns
Selected index or -1 if no selection has been done.
virtual const char* SYNCOLOR::TemplateParameter::getSelectedValue ( ) const
pure virtual

Selected value.

Returns
Selected name value (i.e NameKey) string or NULL if no selection has been done.
virtual const char* SYNCOLOR::TemplateParameter::getSelectedValueForKey ( ColorSpaceAttributeKey  key) const
pure virtual

Selected value.

Returns
Selected value string for the specified key or NULL if no selection has been done.