Synergy Color Management Component - SDK -  2018.0.80
SYNCOLOR::ViewingRule Class Referenceabstract
Inheritance diagram for SYNCOLOR::ViewingRule:
SYNCOLOR::Rule

Public Types

enum  Context { SPECIFIC = 0, FAMILY }
 Specifies the context of colour spaces or displays this rule supports. More...
 
- Public Types inherited from SYNCOLOR::Rule
enum  RuleType { OPAQUE_RULE = 0, DEFAULT_RULE, STANDARD_RULE }
 All supported types of rule. More...
 

Public Member Functions

RuleType getType () const
 Returns the type of the rule. More...
 
virtual const char * getViewTransform () const =0
 Get the view transform used by the rule. More...
 
virtual SynStatus setViewTransform (const char *viewTransform)=0
 Set the view transform used by the rule. More...
 
virtual const char * getAllowedColorSpaces () const =0
 Get the color spaces allowed by the rule. More...
 
virtual Context getAllowedCSContext () const =0
 Get the allowed color spaces context of the rule. More...
 
virtual SynStatus setAllowedColorSpaces (const char *allowedColorSpaces, Context context)=0
 Set the color spaces allowed by the rule. More...
 
virtual const char * getAllowedDisplays () const =0
 Get the displays allowed by the rule. More...
 
virtual Context getAllowedDisplaysContext () const =0
 Get the allowed displays context of the rule. More...
 
virtual SynStatus setAllowedDisplays (const char *allowedDisplays, Context context)=0
 Set the displays allowed by the rule. More...
 
virtual bool getIsActive () const =0
 Get the active state of the rule. More...
 
virtual SynStatus setIsActive (const bool isActive)=0
 Set the active state of the rule. More...
 
- Public Member Functions inherited from SYNCOLOR::Rule
virtual ~Rule ()
 Default destructor. More...
 
virtual const char * getName () const =0
 Returns the name of the rule. More...
 

Additional Inherited Members

- Protected Member Functions inherited from SYNCOLOR::Rule
 Rule ()
 Default constructor. More...
 

Detailed Description

This class represents a rule where the color space, display and view transform may be managed by the user

Member Enumeration Documentation

Specifies the context of colour spaces or displays this rule supports.

Enumerator
SPECIFIC 

The parameter specifies a single colour space or display.

FAMILY 

The parameter specifies a family or group of families of colour spaces or displays.

Member Function Documentation

RuleType SYNCOLOR::ViewingRule::getType ( ) const
inlinevirtual

Returns the type of the rule.

Returns
the rule's type

Implements SYNCOLOR::Rule.

References SYNCOLOR::Rule::STANDARD_RULE.

virtual const char* SYNCOLOR::ViewingRule::getViewTransform ( ) const
pure virtual

Get the view transform used by the rule.

Returns
the view transform name
virtual SynStatus SYNCOLOR::ViewingRule::setViewTransform ( const char *  viewTransform)
pure virtual

Set the view transform used by the rule.

Parameters
viewTransformThe view transform to be used by the rule. There is no validation of the string done.
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
virtual const char* SYNCOLOR::ViewingRule::getAllowedColorSpaces ( ) const
pure virtual

Get the color spaces allowed by the rule.

Returns
the allowed color spaces
virtual Context SYNCOLOR::ViewingRule::getAllowedCSContext ( ) const
pure virtual

Get the allowed color spaces context of the rule.

Returns
the allowed color spaces context
virtual SynStatus SYNCOLOR::ViewingRule::setAllowedColorSpaces ( const char *  allowedColorSpaces,
Context  context 
)
pure virtual

Set the color spaces allowed by the rule.

Parameters
allowedColorSpacesThe color spaces allowed by the rule. There is no validation of the string done.
contextcontext of the allowed colour spaces parameter
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
virtual const char* SYNCOLOR::ViewingRule::getAllowedDisplays ( ) const
pure virtual

Get the displays allowed by the rule.

Returns
the allowed displays
virtual Context SYNCOLOR::ViewingRule::getAllowedDisplaysContext ( ) const
pure virtual

Get the allowed displays context of the rule.

Returns
the allowed displays context
virtual SynStatus SYNCOLOR::ViewingRule::setAllowedDisplays ( const char *  allowedDisplays,
Context  context 
)
pure virtual

Set the displays allowed by the rule.

Parameters
allowedDisplaysThe displays allowed by the rule. There is no validation of the string done.
contextcontext of the allowed displays parameter
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.
virtual bool SYNCOLOR::ViewingRule::getIsActive ( ) const
pure virtual

Get the active state of the rule.

Returns
the active state
virtual SynStatus SYNCOLOR::ViewingRule::setIsActive ( const bool  isActive)
pure virtual

Set the active state of the rule.

Parameters
isActivestate
Returns
returns a SYNCOLOR::SynStatus. Check the error code to determine if an error occurred. See SYNCOLOR::SynStatus above.