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

A read-only policy intended as a Preferences template. More...

Inheritance diagram for SYNCOLOR::Policy:
SYNCOLOR::PolicyInterface

Public Types

typedef SharedPtr< PolicyPtr
 A pointer to a Policy instance with shared ownership type. The instance is automatically destroyed once no Ptr points to it. More...
 

Public Member Functions

virtual ~Policy ()
 Destructor. More...
 
virtual SynStatus saveAsPreferences (const URL::Ptr &to) const =0
 saveAsPreferences will preserve existing preferences if any. More...
 
virtual SynStatus replacePreferences (const URL::Ptr &to) const =0
 like 'saveAsPreferences' but any existing preferences at 'to' are lost. More...
 
- Public Member Functions inherited from SYNCOLOR::PolicyInterface
virtual ~PolicyInterface ()
 Destructor. More...
 
virtual const char * getPolicyName () const =0
 Get the name of the policy. More...
 
virtual const char * getWorkingColourSpace () const =0
 Get the working colour space. More...
 
virtual const char * getRenderingColourSpace () const =0
 Get the rendering colour space. More...
 
virtual URL::Ptr getInputRules () const =0
 Get the full path to the input rules file. More...
 
virtual URL::Ptr getViewingRules () const =0
 Get the full path to the viewing rules file. More...
 
virtual URL::Ptr getUserColourSpaces () const =0
 Get the full path to the user colour space collection. More...
 
virtual const char * getUserVariable (const char *var) const =0
 Get the value of an arbitrary variable. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from SYNCOLOR::PolicyInterface
static const char * policyFile ()
 Gets the standard name of the policy file in which variables are stored. More...
 

Detailed Description

A read-only policy intended as a Preferences template.

Member Typedef Documentation

A pointer to a Policy instance with shared ownership type. The instance is automatically destroyed once no Ptr points to it.

Constructor & Destructor Documentation

virtual SYNCOLOR::Policy::~Policy ( )
virtual

Destructor.

Releases all resources used by the Policy instance.

Member Function Documentation

virtual SynStatus SYNCOLOR::Policy::saveAsPreferences ( const URL::Ptr to) const
pure virtual

saveAsPreferences will preserve existing preferences if any.

Parameters
toThe directory location of the Preferences to be saved.
Returns
A SynStatus. Check the error code to determine if an error occurred.
virtual SynStatus SYNCOLOR::Policy::replacePreferences ( const URL::Ptr to) const
pure virtual

like 'saveAsPreferences' but any existing preferences at 'to' are lost.

Parameters
toThe directory location of the Preferences to be saved.
Returns
A SynStatus. Check the error code to determine if an error occurred.