|
Synergy Color Management Component - SDK -
2018.0.80
|
An editable policy. More...
Public Types | |
| typedef SharedPtr< Preferences > | Ptr |
| A pointer to a Preferences instance with shared ownership type. The instance is automatically destroyed once no Ptr points to it. More... | |
Public Member Functions | |
| virtual | ~Preferences () |
| Destructor. More... | |
| virtual SynStatus | save () const =0 |
| Persists the Preferences. More... | |
| virtual SynStatus | saveAsPolicy (PolicyCollection &lib, const char *name) const =0 |
| Saves the Preferences as a 'Policy' with name 'name' in collection 'lib'. More... | |
| virtual void | setWorkingColourSpace (const char *cs)=0 |
| Sets the working colour space. More... | |
| virtual void | setRenderingColourSpace (const char *cs)=0 |
| Sets the rendering colour space. More... | |
| virtual void | setInputRulesFileName (const char *name)=0 |
| Sets the name of input rules file (always relative to the Preferences location, see 'create' above). More... | |
| virtual void | setViewingRulesFileName (const char *name)=0 |
| Sets the name of viewing rules file (always relative to the Preferences location, see 'create' above). More... | |
| virtual void | setUserColourSpacesDirectoryName (const char *name)=0 |
| Sets the name of colour space collection directory (always relative to the Preferences location, see 'create' above). More... | |
| virtual void | setUserVariable (const char *var, const char *value)=0 |
| Sets the value of an arbitrary variable 'var'. 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... | |
Static Public Member Functions | |
| static Ptr | create (const URL::Ptr &dir) |
| Creates Preferences at location 'dir'. More... | |
| static SynStatus | copy (const URL::Ptr &to, const Preferences &from, Ptr *copy) |
| Copies 'from' at location 'to'. The new Preferences object is returned to caller via optional 'copy'. Pass null for 'copy' if not interested. More... | |
| static SynStatus | replace (const URL::Ptr &to, const Preferences &from, Ptr *copy) |
| Like 'copy' but any existing Preferences at 'to' is lost. More... | |
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... | |
Private Member Functions | |
| virtual SynStatus | assign (const Preferences &r, bool replace)=0 |
An editable policy.
A pointer to a Preferences instance with shared ownership type. The instance is automatically destroyed once no Ptr points to it.
|
virtual |
Destructor.
Releases all resources used by the Preferences instance.
Creates Preferences at location 'dir'.
| dir | The storage location of the created Preferences instance. |
|
static |
Copies 'from' at location 'to'. The new Preferences object is returned to caller via optional 'copy'. Pass null for 'copy' if not interested.
| to | The target location for the copy |
| from | The Preferences instance to copy |
| copy | An optional Ptr to hold the resulting Preferences copy. Can be null. |
|
static |
Like 'copy' but any existing Preferences at 'to' is lost.
| to | The target location for the copy |
| from | The Preferences instance to copy |
| copy | An optional Ptr to hold the resulting Preferences copy. Can be null. |
|
pure virtual |
Persists the Preferences.
|
pure virtual |
Saves the Preferences as a 'Policy' with name 'name' in collection 'lib'.
| lib | The PolicyCollection in which to add the new Policy. |
| name | The name to assign to the new Policy. |
|
pure virtual |
Sets the working colour space.
| cs | The unique(short) colour space name. |
|
pure virtual |
Sets the rendering colour space.
| cs | The unique(short) colour space name. |
|
pure virtual |
Sets the name of input rules file (always relative to the Preferences location, see 'create' above).
| name | The name of the input rules file. |
|
pure virtual |
Sets the name of viewing rules file (always relative to the Preferences location, see 'create' above).
| name | The name of the viewing rules file. |
|
pure virtual |
Sets the name of colour space collection directory (always relative to the Preferences location, see 'create' above).
| name | The name of the user colour space collection directory. |
|
pure virtual |
Sets the value of an arbitrary variable 'var'.
| var | The name of the variable. |
| value | The value of the variable. |