![]() |
Oyranos Color Management System API - Version 0.9.6 |
Manipulate and abstract values. More...
![]() |
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 |
Functions | |
int | oyDbHandlingReady (void) |
tell if DB handling is ready More... | |
int | oyDbHandlingSet (const oyDbAPI_s *db_api) |
set DB functions for persistent settingsBe careful to set the APIs only before any call to the oyDB_s functions. Otherwise the behaviour is undefined. More... | |
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... | |
Manipulate and abstract values.
#define OY_ADD_ALWAYS 0x04 |
no check for double occurencies; do not use for configurations
Referenced by oySetPersistentString().
#define OY_CREATE_NEW 0x02 |
create
Referenced by oyArray2d_s::oyArray2d_Show(), oyConfig_s::oyConfig_SaveToDB(), oyConfigs_s::oyConfigs_FromDB(), oyDeviceFromJSON(), oyDeviceSelectSimiliar(), oyDeviceSetProfile(), oyDeviceSetup(), oyDevicesFromTaxiDB(), oyGetPersistentString(), oyGetPersistentStrings(), oyImage_s::oyImage_Create(), oyImage_s::oyImage_CreateForDisplay(), oyImage_s::oyImage_FromFile(), oyImage_s::oyImage_ToFile(), oyObject_SetName(), oyOptions_s::oyOptions_Sort(), and oyProfile_s::oyProfile_GetFileName().
#define OY_MATCH_KEY 0x08 |
check for double occurencies of key name, ignoring the path
Referenced by oyOptions_s::oyOptions_MoveInStruct(), oyOptions_s::oyOptions_SetFromData(), oyOptions_s::oyOptions_SetFromDouble(), oyOptions_s::oyOptions_SetFromInt(), and oyOptions_s::oyOptions_SetFromText().
#define OY_SELECT_COMMON 4096 |
select from policySelect typical from a associatable oyCMMapi9_s type of filter for providing common options.
Referenced by oyOptions_s::oyOptions_ForFilter_().
#define OY_SELECT_FILTER 2048 |
select from filter
Referenced by oyImage_s::oyImage_FromFile(), oyImage_s::oyImage_ToFile(), and oyOptions_s::oyOptions_ForFilter_().
enum oyOPTIONATTRIBUTE_e |
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
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 |
OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_Copy | ( | oyConfDomain_s * | obj, |
oyObject_s | object | ||
) |
copy or reference a ConfDomain object
Function oyConfDomain_Copy
[in] | obj | struct object |
object | the optional object |
References oyOBJECT_CONF_DOMAIN_S.
Referenced by oyConfDomain_s::oyConfDomain_GetTexts().
OYAPI oyConfDomain_s *OYEXPORT oyConfDomain_FromReg | ( | const char * | registration_domain, |
oyObject_s | object | ||
) |
allocate a new ConfDomain object
Function oyConfDomain_New
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
[in,out] | obj | struct object |
[in] | name | the category to return |
[in] | type | the type of string |
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
References oyCMMui_s::oyCMMui_GetTextF(), oyCMMui_s::oyCMMui_GetTexts(), oyConfDomain_s::oyConfDomain_Copy(), oyConfDomain_s::oyConfDomain_Release(), oyOBJECT_CMM_API8_S, oyOBJECT_CONF_DOMAIN_S, oyObject_Copy(), oyObject_NewFrom(), oyObject_Release(), oyObject_SetParent(), oyObject_UnRef(), and oyConfDomain_s::release.
OYAPI int OYEXPORT oyConfDomain_Release | ( | oyConfDomain_s ** | obj | ) |
release and possibly deallocate a ConfDomain object
Function oyConfDomain_Release
[in,out] | obj | struct object |
References oyOBJECT_CONF_DOMAIN_S.
Referenced by oyConfDomain_s::oyConfDomain_GetTexts(), and oyDeviceToJSON().
int oyDbHandlingReady | ( | void | ) |
tell if DB handling is ready
int oyDbHandlingSet | ( | const oyDbAPI_s * | db_api | ) |
set DB functions for persistent settingsBe careful to set the APIs only before any call to the oyDB_s functions. Otherwise the behaviour is undefined.
References OY_TYPE_STD, oyOptions_s::oyOptions_Handle(), oyOptions_s::oyOptions_New(), and oyOptions_s::oyOptions_Release().
char* oyGetPersistentString | ( | const char * | key_name, |
uint32_t | flags, | ||
oySCOPE_e | scope, | ||
oyAlloc_f | alloc_func | ||
) |
get a cached string from DB
Function oyGetPersistentString
key_name | the DB key name |
flags |
|
scope | user/system or both, works together with flags |= oySOURCE_DATA |
alloc_func | the user allocator |
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(), oyOption_s::oyOption_SetValueFromDB(), and oySetPersistentString().
int oyGetPersistentStrings | ( | const char * | top_key_name | ) |
cache strings from DB
Function oyGetPersistentStrings
[in] | top_key_name | the DB root key, zero clears the DB cache; use for example OY_STD |
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
key_name | the DB key name |
scope | possible values are:
|
value | the value string |
comment | the comment string |
References OY_ADD_ALWAYS, oyGetPersistentString(), and oySCOPE_USER_SYS.
Referenced by oyDeviceSetup(), oyDeviceUnset(), oyOptions_s::oyOptions_SaveToDB(), and oySetCMMPattern().