Oyranos Color Management System API - Version 0.9.6
Data Structures | Macros | Enumerations | Functions
Values Handling

Manipulate and abstract values. More...

Collaboration diagram for Values Handling:

Data Structures

struct  oyBlob_s
 A data blob object. More...
 
struct  oyConfig_s
 A group of options for a device. More...
 
struct  oyConfigs_s
 A Configs list. More...
 
union  oyValue_u
 a value More...
 
struct  oyOption_s
 Option object. More...
 
struct  oyOptions_s
 generic Options More...
 

Macros

#define OY_CREATE_NEW   0x02
 
#define OY_ADD_ALWAYS   0x04
 
#define OY_MATCH_KEY   0x08
 
#define OY_SELECT_FILTER   2048
 select from filter More...
 
#define OY_SELECT_COMMON   4096
 select from policySelect typical from a associatable oyCMMapi9_s type of filter for providing common options. More...
 

Enumerations

enum  oyOPTIONATTRIBUTE_e {
  oyOPTIONATTRIBUTE_BASIC = 0, oyOPTIONATTRIBUTE_EDIT = 32, oyOPTIONATTRIBUTE_AUTOMATIC = 64, oyOPTIONATTRIBUTE_ADVANCED = 128,
  oyOPTIONATTRIBUTE_FRONT = 256, oyOPTIONATTRIBUTE_DOUBLE = 512
}
 usage typeThe types of Oyranos default settings to include into the options set. So proofing makes no sense for toolkit widgets, but for advanced graphics displaying. All other Oyranos behaviour settings should be taken over untouched. More...
 

Functions

int oyGetPersistentStrings (const char *top_key_name)
 cache strings from DB More...
 
char * oyGetPersistentString (const char *key_name, uint32_t flags, oySCOPE_e scope, oyAlloc_f alloc_func)
 get a cached string from DB More...
 
int oySetPersistentString (const char *key_name, oySCOPE_e scope, const char *value, const char *comment)
 set string into DB and cache More...
 
OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_s::oyConfDomain_FromReg (const char *registration_domain, oyObject_s object)
 allocate a new ConfDomain object More...
 
OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_s::oyConfDomain_Copy (oyConfDomain_s *obj, oyObject_s object)
 copy or reference a ConfDomain object More...
 
OYAPI int OYEXPORT oyConfDomain_s::oyConfDomain_Release (oyConfDomain_s **obj)
 release and possibly deallocate a ConfDomain object More...
 
OYAPI const char *OYEXPORT oyConfDomain_s::oyConfDomain_GetText (oyConfDomain_s *obj, const char *name, oyNAME_e type)
 obtain a UI text from a ConfDomain object More...
 
OYAPI const char **OYEXPORT oyConfDomain_s::oyConfDomain_GetTexts (oyConfDomain_s *obj)
 obtain a list of possible UI text from a ConfDomain object More...
 

Detailed Description

Manipulate and abstract values.

Macro Definition Documentation

#define OY_ADD_ALWAYS   0x04

no check for double occurencies; do not use for configurations

Referenced by oySetPersistentString().

#define OY_CREATE_NEW   0x02
#define OY_MATCH_KEY   0x08
#define OY_SELECT_COMMON   4096

select from policySelect typical from a associatable oyCMMapi9_s type of filter for providing common options.

Version
Oyranos: 0.1.10
Since
2009/07/27 (Oyranos: 0.1.10)
Date
2009/07/27

Referenced by oyOptions_s::oyOptions_ForFilter_().

#define OY_SELECT_FILTER   2048

select from filter

Version
Oyranos: 0.1.10
Since
2009/07/27 (Oyranos: 0.1.10)
Date
2009/07/27
Examples:
image_display.cpp.

Referenced by oyImage_s::oyImage_FromFile(), oyImage_s::oyImage_ToFile(), and oyOptions_s::oyOptions_ForFilter_().

Enumeration Type Documentation

usage typeThe types of Oyranos default settings to include into the options set. So proofing makes no sense for toolkit widgets, but for advanced graphics displaying. All other Oyranos behaviour settings should be taken over untouched.

The ".invisible" attribute says a option shall not be displayed in a GUI. The ".readonly" attribute alllows for unchangeable, static options. They might be used for passing additional informations. The ".font" and ".advanced" attributes are described for the according enum values.

See as well Registration

Version
Oyranos: 0.1.9
Since
2008/10/08 (Oyranos: 0.1.8)
Date
2008/11/27
Enumerator
oyOPTIONATTRIBUTE_BASIC 

basic settings, as typical for toolkits and office/web applications, e.g. disable proofing or disable mark out of gamut colors

oyOPTIONATTRIBUTE_EDIT 

user modified, e.g. after oyOption_SetFromText()

oyOPTIONATTRIBUTE_AUTOMATIC 

automatically modified, e.g. by a CMM

oyOPTIONATTRIBUTE_ADVANCED 

advanced settings, as typical for editing, e.g. include proofing (options appended with ".advanced")

oyOPTIONATTRIBUTE_FRONT 

front end options, handled by the framework or policy module, e.g. ".front"

oyOPTIONATTRIBUTE_DOUBLE 

tell this options is included twice

Function Documentation

OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_Copy ( oyConfDomain_s obj,
oyObject_s  object 
)

copy or reference a ConfDomain object

Function oyConfDomain_Copy

Parameters
[in]objstruct object
objectthe optional object
Version
Oyranos: 0.1.10
Since
2009/12/30 (Oyranos: 0.1.10)
Date
2009/12/30

References oyOBJECT_CONF_DOMAIN_S.

OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_FromReg ( const char *  registration_domain,
oyObject_s  object 
)

allocate a new ConfDomain object

Function oyConfDomain_New

Version
Oyranos: 0.1.10
Since
2009/12/30 (Oyranos: 0.1.10)
Date
2009/12/30

Referenced by oyDeviceToJSON().

OYAPI const char *OYEXPORT oyConfDomain_GetText ( oyConfDomain_s obj,
const char *  name,
oyNAME_e  type 
)

obtain a UI text from a ConfDomain object

Function oyConfDomain_GetText

Parameters
[in,out]objstruct object
[in]namethe category to return
[in]typethe type of string
Version
Oyranos: 0.1.10
Since
2009/12/30 (Oyranos: 0.1.10)
Date
2009/12/30

References oyOBJECT_CONF_DOMAIN_S.

Referenced by oyDeviceToJSON().

OYAPI const char **OYEXPORT oyConfDomain_GetTexts ( oyConfDomain_s obj)

obtain a list of possible UI text from a ConfDomain object

Function oyConfDomain_GetTexts

Returns
zero terminated list of strings, Each string is a "name" option to oyConfDomain_GetText().
Version
Oyranos: 0.1.10
Since
2009/12/30 (Oyranos: 0.1.10)
Date
2009/12/30

References oyOBJECT_CONF_DOMAIN_S.

OYAPI int OYEXPORT oyConfDomain_Release ( oyConfDomain_s **  obj)

release and possibly deallocate a ConfDomain object

Function oyConfDomain_Release

Parameters
[in,out]objstruct object
Version
Oyranos: 0.1.10
Since
2009/12/30 (Oyranos: 0.1.10)
Date
2009/12/30

References oyOBJECT_CONF_DOMAIN_S.

Referenced by oyDeviceToJSON().

char* oyGetPersistentString ( const char *  key_name,
uint32_t  flags,
oySCOPE_e  scope,
oyAlloc_f  alloc_func 
)

get a cached string from DB

Function oyGetPersistentString

Parameters
key_namethe DB key name
flags
  • 0 for cached string or
  • oySOURCE_DATA for a likely expensive DB lookup
scopeuser/system or both, works together with flags |= oySOURCE_DATA
alloc_functhe user allocator
Returns
the cached value
Version
Oyranos: 0.9.6
Date
2015/02/06
Since
2015/02/06 (Oyranos: 0.9.6)

References OY_CREATE_NEW, OY_STD, oyGetPersistentStrings(), oyNAME_REGISTRATION, oyOption_s::oyOption_GetValueString(), oyOption_s::oyOption_Release(), oyOptions_s::oyOptions_Count(), oyOptions_s::oyOptions_Find(), and oySOURCE_DATA.

Referenced by oyDeviceSetup(), oyDeviceUnset(), oyGetCMMPattern(), oyGetFilterNodeRegFromDB(), and oyOption_s::oyOption_SetValueFromDB().

int oyGetPersistentStrings ( const char *  top_key_name)

cache strings from DB

Function oyGetPersistentStrings

Parameters
[in]top_key_namethe DB root key, zero clears the DB cache; use for example OY_STD
Returns
error
Version
Oyranos: 0.9.6
Date
2016/03/02
Since
2015/02/26 (Oyranos: 0.9.6)

References OY_CREATE_NEW, oyOptions_s::oyOptions_Release(), and oySCOPE_USER_SYS.

Referenced by oyGetPersistentString().

int oySetPersistentString ( const char *  key_name,
oySCOPE_e  scope,
const char *  value,
const char *  comment 
)

set string into DB and cache

Function oySetPersistentString

Parameters
key_namethe DB key name
scopepossible values are:
  • oySCOPE_USER
  • oySCOPE_SYS
  • oySCOPE_USER_SYS means, you are your own with prefixing
valuethe value string
commentthe comment string
Returns
DB specific return code
Version
Oyranos: 0.9.6
Date
2015/02/06
Since
2015/02/06 (Oyranos: 0.9.6)
Examples:
image_display.cpp.

References OY_ADD_ALWAYS, and oySCOPE_USER_SYS.

Referenced by oyDeviceSetup(), oyDeviceUnset(), oyOptions_s::oyOptions_SaveToDB(), and oySetCMMPattern().