![]() |
Oyranos Color Management System API - Version 0.9.6 |
The API header for general users to include in your application. More...
Macros | |
#define | oySCOPE_OYRANOS 0x04 |
#define | oySCOPE_MACHINE 0x08 |
#define | oyNAME_MODULE (oyNAME_DESCRIPTION + 2) |
the system specific module name; e.g. a library name | |
#define | oyNAME_REGISTRATION (oyNAME_DESCRIPTION + 3) |
the logical name for selection | |
#define | oyNAME_PATTERN (oyNAME_DESCRIPTION + 4) |
a logical name for registration search | |
#define | oyNAME_JSON (oyNAME_DESCRIPTION + 5) |
a logical name for registration search | |
#define | oySOURCE_FILTER 0x02 |
use inbuild values | |
#define | oySOURCE_DATA 0x04 |
use persistenly stored DB values | |
#define | oyDEFAULT_PROFILE oyPROFILE_e |
#define | OY_LAYOUT_NO_CHOICES 0x01 |
layout flags for widgets | |
#define | OY_LAYOUT_MIDDLE 0x02 |
#define | OY_LAYOUT_PATH_SELECTOR 0x04 |
Functions | |
char * | oyGetInstallPath (oyPATH_TYPE_e type, oySCOPE_e scope, oyAlloc_f allocFunc) |
get Path Name for Installation | |
int | oyGetBehaviour (oyBEHAVIOUR_e type) |
int | oySetBehaviour (oyBEHAVIOUR_e type, oySCOPE_e scope, int choice) |
char * | oyGetCMMPattern (oyCMM_e type, uint32_t flags, oyAlloc_f allocate_func) |
Get a default CMM. | |
int | oySetCMMPattern (oyCMM_e type, uint32_t flags, oySCOPE_e scope, const char *name) |
set a CMM as default | |
char ** | oyGetCMMs (oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM list as strings. | |
char * | oyCMMRegistrationToName (const char *registration, oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM string. | |
char * | oyCMMNameToRegistration (const char *name, oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func) |
Get a CMM registration from UI string. | |
int | oyPolicySaveActual (oyGROUP_e group, oySCOPE_e scope, const char *name) |
save a options group to a file | |
char * | oyPolicyToXML (oyGROUP_e group, int add_header, oyAlloc_f alloc_func) |
int | oyReadXMLPolicy (oyGROUP_e group, const char *xml) |
int | oyPolicySet (const char *policy, const char *full_name) |
char * | oyGetPathFromProfileName (const char *profile_name, oyAlloc_f) |
int | oySetDefaultProfile (oyPROFILE_e type, oySCOPE_e scope, const char *file_name) |
char * | oyGetDefaultProfileName (oyPROFILE_e type, oyAlloc_f alloc_func) |
char ** | oyProfileListGet (const char *colorsig, uint32_t *size, oyAlloc_f allocateFunc) |
get a list of profile filenames | |
char ** | oyProfilePathsGet (int *size, oyAlloc_f allocateFunc) |
get Search Path names for ICC Profiles | |
int | oyCheckProfile (const char *name, const char *unused) |
check an file if it is a profile | |
int | oyCheckProfileMem (const void *mem, size_t size, const char *unused) |
check an memory block if it is a profile | |
size_t | oyGetProfileSize (const char *profilename) |
get the profiles size | |
void * | oyGetProfileBlock (const char *profilename, size_t *size, oyAlloc_f alloc_func) |
obtain an memory block in the responsibility of the user | |
oyWIDGET_e * | oyWidgetListGet (oyGROUP_e group, int *count, oyAlloc_f allocate_func) |
all widgets of a group | |
oyWIDGET_TYPE_e | oyWidgetTitleGet (oyWIDGET_e option, const oyGROUP_e **categories, const char **name, const char **tooltip, int *flags) |
Get a special Options UI strings. | |
int | oyOptionChoicesGet (oyWIDGET_e option, int *choices, const char ***choices_string_list, int *current) |
Get a Options choices UI strings. | |
uint32_t | oyICCProfileSelectionFlagsFromRegistration (const char *registration) |
Get flags for oyProfile_FromFile() and friends. | |
int | oyOptionChoicesGet2 (oyWIDGET_e option, uint32_t flags, int name_type, int *choices, const char ***choices_string_list, int *current) |
see oyOptionChoicesGet() | |
void | oyOptionChoicesFree (oyWIDGET_e option, const char ***list, int size) |
delete list of choices from a option | |
int | oyGetPersistentStrings (const char *top_key_name) |
cache strings from DB | |
int | oyProfileGetMD5 (void *buffer, size_t size, unsigned char *md5_return) |
calculate a md5 digest beginning after the header offset |
The API header for general users to include in your application.
public Oyranos API's
This file contains all functions and structs available in the Oyranos API.
For further macros see
Oyranos is an open source Color Management System
#define OY_LAYOUT_MIDDLE 0x02 |
Arrange in the middle.
#define OY_LAYOUT_NO_CHOICES 0x01 |
layout flags for widgets
show informational
#define OY_LAYOUT_PATH_SELECTOR 0x04 |
add a path selector to each entry
#define oyDEFAULT_PROFILE oyPROFILE_e |
enum oyBEHAVIOUR_e |
Behaviour settings.
possibly include the default profiles here
enum oyGROUP_e |
Widget Groups.
enum oyPROFILE_e |
Default Profiles.
enum oyWIDGET_e |
options for UI presentation, covering all kind of settings
enum oyWIDGET_TYPE_e |
type of widget
oyWIDGETTYPE_GROUP_TREE |
group creating a new visibility (tab, leave) |
oyWIDGETTYPE_PROFILE |
select a profile through a list widget |
oyWIDGETTYPE_INT |
TODO
|
oyWIDGETTYPE_FLOAT |
IEEE floating point number |
oyWIDGETTYPE_CHOICE |
option from a array of choices |
oyWIDGETTYPE_LIST |
list widget, like for paths |
oyWIDGETTYPE_VOID |
data block, should not be selectable |