![]() |
Oyranos Color Management System API |
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_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 | |
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_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_FromFile(), 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.
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 oyOBJECT_CONF_DOMAIN_S.
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 oyDeviceToJSON().