/chakra/desktop/oyranos/src/oyranos-0.9.6/src/include/oyranos.h File Reference
Description: C source code API documentation for the Oyranos project.
Keywords: Oyranos,Color Management,Color Management,ICC,CMS,C,doxygen,API,documentation

| Oyranos Color Management System API - Version 0.9.6

Macros | Enumerations | Functions
oyranos.h File Reference

The API header for general users to include in your application. More...

`#include "oyranos_definitions.h"`
`#include "oyranos_core.h"`

## 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 More...
#define | oyNAME_REGISTRATION (oyNAME_DESCRIPTION + 3)
| the logical name for selection More...
#define | oyNAME_PATTERN (oyNAME_DESCRIPTION + 4)
| a logical name for registration search More...
#define | oyNAME_JSON (oyNAME_DESCRIPTION + 5)
| a logical name for registration search More...
#define | oySOURCE_FILTER 0x02
| use inbuild values More...
#define | oySOURCE_DATA 0x04
| use persistenly stored DB values More...
#define | oyDEFAULT_PROFILE oyPROFILE_e
#define | OY_LAYOUT_NO_CHOICES 0x01
| layout flags for widgets More...
#define | OY_LAYOUT_MIDDLE 0x02
#define | OY_LAYOUT_PATH_SELECTOR 0x04

## Enumerations
enum | oyPATH_TYPE_e { , oyPATH_ICC = 0x01, oyPATH_POLICY = 0x02, oyPATH_MODULE = 0x04 }
| data type selectors More...
enum | oySCOPE_e { oySCOPE_USER_SYS = 0x0, oySCOPE_USER = 0x01, oySCOPE_SYSTEM = 0x02 }
| Select Scope for Installation or Configurations. More...
enum | oyGROUP_e { , oyGROUP_POLICY, oyGROUP_PATHS, oyGROUP_DEFAULT_PROFILES, oyGROUP_DEFAULT_PROFILES_EDIT, oyGROUP_DEFAULT_PROFILES_ASSUMED, oyGROUP_BEHAVIOUR, oyGROUP_BEHAVIOUR_RENDERING, oyGROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS, oyGROUP_BEHAVIOUR_MISSMATCH, oyGROUP_BEHAVIOUR_PROOF, oyGROUP_BEHAVIOUR_EFFECT, oyGROUP_CMM, oyGROUP_ALL, oyGROUP_EXTERN = 200 }
| Widget Groups. More...
enum | oyBEHAVIOUR_e { , oyBEHAVIOUR_ACTION_UNTAGGED_ASSIGN, oyBEHAVIOUR_ACTION_OPEN_MISMATCH_RGB, oyBEHAVIOUR_ACTION_OPEN_MISMATCH_CMYK, oyBEHAVIOUR_MIXED_MOD_DOCUMENTS_PRINT, oyBEHAVIOUR_MIXED_MOD_DOCUMENTS_SCREEN, oyBEHAVIOUR_RENDERING_INTENT, oyBEHAVIOUR_RENDERING_BPC, oyBEHAVIOUR_RENDERING_INTENT_PROOF, oyBEHAVIOUR_PROOF_SOFT, oyBEHAVIOUR_PROOF_HARD, oyBEHAVIOUR_EFFECT, oyBEHAVIOUR_RENDERING_GAMUT_WARNING, oyBEHAVIOUR_END }
| Behaviour settings. More...
enum | { oyNO, oyYES, oyASK }
enum | oyCMM_e { , oyCMM_CONTEXT, oyCMM_RENDERER, oyCMM_CONTEXT_FALLBACK, oyCMM_RENDERER_FALLBACK, oyCMM_END }
| CMM Types. More...
enum | oyPROFILE_e { , oyEDITING_XYZ, oyEDITING_LAB, oyEDITING_RGB, oyEDITING_CMYK, oyEDITING_GRAY, oyASSUMED_XYZ = 110, oyASSUMED_LAB, oyASSUMED_RGB, oyASSUMED_WEB, oyASSUMED_CMYK, oyASSUMED_GRAY, oyPROFILE_PROOF = 120, oyPROFILE_EFFECT, oyDEFAULT_PROFILE_END }
| Default Profiles. More...
enum | oyWIDGET_e { , oyWIDGET_GROUP_POLICY, oyWIDGET_GROUP_PATHS, oyWIDGET_GROUP_DEFAULT_PROFILES, oyWIDGET_GROUP_DEFAULT_PROFILES_EDIT, oyWIDGET_GROUP_DEFAULT_PROFILES_ASSUMED, oyWIDGET_GROUP_BEHAVIOUR, oyWIDGET_GROUP_BEHAVIOUR_RENDERING, oyWIDGET_GROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS, oyWIDGET_GROUP_BEHAVIOUR_MISSMATCH, oyWIDGET_GROUP_BEHAVIOUR_PROOF, oyWIDGET_GROUP_BEHAVIOUR_EFFECT, oyWIDGET_GROUP_CMM, oyWIDGET_GROUP_ALL, oyWIDGET_GROUP_DEVICES, oyWIDGET_GROUP_DEVICES_PROFILES_TAXI, oyWIDGET_GROUP_DEVICES_PROFILES, oyWIDGET_GROUP_INFORMATION, oyWIDGET_GROUP_EXTERN = 200, oyWIDGET_POLICY = 20, oyWIDGET_PATHS , oyWIDGET_ACTION_UNTAGGED_ASSIGN, oyWIDGET_ACTION_OPEN_MISMATCH_RGB, oyWIDGET_ACTION_OPEN_MISMATCH_CMYK, oyWIDGET_MIXED_MOD_DOCUMENTS_PRINT, oyWIDGET_MIXED_MOD_DOCUMENTS_SCREEN, oyWIDGET_RENDERING_INTENT, oyWIDGET_RENDERING_BPC, oyWIDGET_RENDERING_INTENT_PROOF, oyWIDGET_PROOF_SOFT, oyWIDGET_PROOF_HARD, oyWIDGET_EFFECT, oyWIDGET_RENDERING_GAMUT_WARNING, oyWIDGET_BEHAVIOUR_END , oyWIDGET_EDITING_XYZ, oyWIDGET_EDITING_LAB, oyWIDGET_EDITING_RGB, oyWIDGET_EDITING_CMYK, oyWIDGET_EDITING_GRAY, oyWIDGET_ASSUMED_XYZ =110, oyWIDGET_ASSUMED_LAB, oyWIDGET_ASSUMED_RGB, oyWIDGET_ASSUMED_WEB, oyWIDGET_ASSUMED_CMYK, oyWIDGET_ASSUMED_GRAY, oyWIDGET_PROFILE_PROOF = 120, oyWIDGET_PROFILE_EFFECT, oyWIDGET_DEFAULT_PROFILE_END, oyWIDGET_DEVICES_RELATED = 200, oyWIDGET_POLICY_ACTIVE, oyWIDGET_TAXI_PROFILE_INSTALL, oyWIDGET_CMM_START = 300, oyWIDGET_CMM_CONTEXT, oyWIDGET_CMM_RENDERER, oyWIDGET_CMM_CONTEXT_FALLBACK, oyWIDGET_CMM_RENDERER_FALLBACK, oyWIDGET_CMM_END }
| options for UI presentation, covering all kind of settings More...
enum | oyWIDGET_TYPE_e { , oyWIDGETTYPE_GROUP_TREE , oyWIDGETTYPE_PROFILE, oyWIDGETTYPE_INT, oyWIDGETTYPE_FLOAT, oyWIDGETTYPE_CHOICE, oyWIDGETTYPE_LIST, oyWIDGETTYPE_VOID }
| type of widget More...

## Functions
char * | oyGetInstallPath (oyPATH_TYPE_e type, oySCOPE_e scope, oyAlloc_f allocFunc)
| get Path Name for Installation More...
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. More...
int | oySetCMMPattern (oyCMM_e type, uint32_t flags, oySCOPE_e scope, const char *name)
| set a CMM as default More...
char ** | oyGetCMMs (oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func)
| Get a CMM list as strings. More...
char * | oyCMMRegistrationToName (const char *registration, oyCMM_e type, int name_type, uint32_t flags, oyAlloc_f allocate_func)
| Get a CMM string. More...
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. More...
int | oyPolicySaveActual (oyGROUP_e group, oySCOPE_e scope, const char *name)
| save a options group to a file More...
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 More...
char ** | oyProfilePathsGet (int *size, oyAlloc_f allocateFunc)
| get Search Path names for ICC Profiles More...
int | oyCheckProfile (const char *name, const char *unused)
| check an file if it is a profile More...
int | oyCheckProfileMem (const void *mem, size_t size, const char *unused)
| check an memory block if it is a profile More...
size_t | oyGetProfileSize (const char *profilename)
| get the profiles size More...
void * | oyGetProfileBlock (const char *profilename, size_t *size, oyAlloc_f alloc_func)
| obtain an memory block in the responsibility of the user More...
oyWIDGET_e * | oyWidgetListGet (oyGROUP_e group, int *count, oyAlloc_f allocate_func)
| all widgets of a group More...
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. More...
int | oyOptionChoicesGet (oyWIDGET_e option, int *choices, const char ***choices_string_list, int *current)
| Get a Options choices UI strings. More...
uint32_t | oyICCProfileSelectionFlagsFromRegistration (const char *registration)
| Get flags for oyProfile_FromFile() and friends. More...
int | oyOptionChoicesGet2 (oyWIDGET_e option, uint32_t flags, int name_type, int *choices, const char ***choices_string_list, int *current)
| see oyOptionChoicesGet() More...
void | oyOptionChoicesFree (oyWIDGET_e option, const char ***list, int size)
| delete list of choices from a option More...
int | oyGetPersistentStrings (const char *top_key_name)
| cache strings from DB More...
int | oyProfileGetMD5 (void *buffer, size_t size, unsigned char *md5_return)
| calculate a md5 digest beginning after the header offset More...

## Detailed Description

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

Copyright:
  2004-2015 (C) Kai-Uwe Behrmann

Author
  Kai-Uwe Behrmann ku.b@.nosp@m.gmx..nosp@m.de

License:
  new BSD http://www.opensource.org/licenses/BSD-3-Clause

Since
  2004/11/25

## Macro Definition Documentation

## ◆ OY_LAYOUT_MIDDLE

#define OY_LAYOUT_MIDDLE 0x02

Arrange in the middle.

## ◆ OY_LAYOUT_NO_CHOICES

#define OY_LAYOUT_NO_CHOICES 0x01

layout flags for widgets

show informational

## ◆ OY_LAYOUT_PATH_SELECTOR

#define OY_LAYOUT_PATH_SELECTOR 0x04

add a path selector to each entry

## ◆ oyDEFAULT_PROFILE

#define oyDEFAULT_PROFILE oyPROFILE_e

Deprecated:
  provide oyDEFAULT_PROFILE for compatibility

## Enumeration Type Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
oyNO | dont do it
oyYES | automaticaly perform action
oyASK | popup dialog

## ◆ oyBEHAVIOUR_e

enum oyBEHAVIOUR_e

Behaviour settings.

possibly include the default profiles here

Enumerator
oyBEHAVIOUR_ACTION_UNTAGGED_ASSIGN | What to do if image is untagged ?
oyBEHAVIOUR_ACTION_OPEN_MISMATCH_RGB | What to do if profiles mismatch ?
oyBEHAVIOUR_ACTION_OPEN_MISMATCH_CMYK | What to do if profiles mismatch ?
oyBEHAVIOUR_MIXED_MOD_DOCUMENTS_PRINT | Convert befor save for Print?
oyBEHAVIOUR_MIXED_MOD_DOCUMENTS_SCREEN | Convert befor save for Screen?
oyBEHAVIOUR_RENDERING_INTENT | Standard color transformations
oyBEHAVIOUR_RENDERING_BPC | use BlackPointCompensation
oyBEHAVIOUR_RENDERING_INTENT_PROOF | Proofing color transformations
oyBEHAVIOUR_PROOF_SOFT | Proofing by default for screen
oyBEHAVIOUR_PROOF_HARD | Proofing by default for printing
oyBEHAVIOUR_EFFECT | Using Effect by default
oyBEHAVIOUR_RENDERING_GAMUT_WARNING | mark out of gamut colors
oyBEHAVIOUR_END | just for easen Gui design

## ◆ oyGROUP_e

enum oyGROUP_e

Widget Groups.

Enumerator
oyGROUP_POLICY | Policies
oyGROUP_PATHS | Paths
oyGROUP_DEFAULT_PROFILES | Default Profiles
oyGROUP_DEFAULT_PROFILES_EDIT | Default Editing Profiles
oyGROUP_DEFAULT_PROFILES_ASSUMED | Default Assumed Profiles
oyGROUP_BEHAVIOUR | Behaviour
oyGROUP_BEHAVIOUR_RENDERING | Rendering Behaviour
oyGROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS | PDF Generation Options
oyGROUP_BEHAVIOUR_MISSMATCH | Profile Missmatch Behaviour
oyGROUP_BEHAVIOUR_PROOF | Profile Missmatch Behaviour
oyGROUP_BEHAVIOUR_EFFECT | Effect Behaviour
oyGROUP_CMM | CMM selection
oyGROUP_ALL | just for easen Gui design
oyGROUP_EXTERN | start of groups in a extern module

## ◆ oyPROFILE_e

enum oyPROFILE_e

Default Profiles.

Enumerator
oyEDITING_XYZ | XYZ Editing (Workspace) Profile
oyEDITING_LAB | Lab Editing (Workspace) Profile
oyEDITING_RGB | Rgb Editing (Workspace) Profile
oyEDITING_CMYK | Cmyk Editing (Workspace) Profile
oyEDITING_GRAY | Gray Editing (Workspace) Profile
oyASSUMED_XYZ | standard XYZ assumed source profile
oyASSUMED_LAB | standard Lab assumed source profile
oyASSUMED_RGB | standard RGB assumed source profile
oyASSUMED_WEB | std internet assumed source static_profile
oyASSUMED_CMYK | standard Cmyk assumed source profile
oyASSUMED_GRAY | standard Gray assumed source Profile
oyPROFILE_PROOF | standard proofing profile
oyPROFILE_EFFECT | effect profile
oyDEFAULT_PROFILE_END | just for easen Gui design

## ◆ oyWIDGET_e

enum oyWIDGET_e

options for UI presentation, covering all kind of settings

Enumerator
oyWIDGET_GROUP_POLICY | Policies
oyWIDGET_GROUP_PATHS | Paths
oyWIDGET_GROUP_DEFAULT_PROFILES | Default Profiles
oyWIDGET_GROUP_DEFAULT_PROFILES_EDIT | Default Editing Profiles
oyWIDGET_GROUP_DEFAULT_PROFILES_ASSUMED | Default Assumed Profiles
oyWIDGET_GROUP_BEHAVIOUR | Behaviour
oyWIDGET_GROUP_BEHAVIOUR_RENDERING | Rendering Behaviour
oyWIDGET_GROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS | PDF Generation Options
oyWIDGET_GROUP_BEHAVIOUR_MISSMATCH | Profile Missmatch Behaviour
oyWIDGET_GROUP_BEHAVIOUR_PROOF | Profile Proof Behaviour
oyWIDGET_GROUP_BEHAVIOUR_EFFECT | Profile Effect Behaviour
oyWIDGET_GROUP_CMM | Color Matching Modules
oyWIDGET_GROUP_ALL | just for easen Gui design
oyWIDGET_GROUP_DEVICES | just for easen Gui design
oyWIDGET_GROUP_DEVICES_PROFILES_TAXI | just for easen Gui design
oyWIDGET_GROUP_DEVICES_PROFILES | just for easen Gui design
oyWIDGET_GROUP_INFORMATION | just for easen Gui design
oyWIDGET_GROUP_EXTERN | start of groups in a extern module
oyWIDGET_POLICY | policy selection
oyWIDGET_PATHS | path selection
oyWIDGET_ACTION_UNTAGGED_ASSIGN | What to do if image is untagged ?
oyWIDGET_ACTION_OPEN_MISMATCH_RGB | What to do if profiles mismatch ?
oyWIDGET_ACTION_OPEN_MISMATCH_CMYK | What to do if profiles mismatch ?
oyWIDGET_MIXED_MOD_DOCUMENTS_PRINT | Convert befor save for Print?
oyWIDGET_MIXED_MOD_DOCUMENTS_SCREEN | Convert befor save for Screen?
oyWIDGET_RENDERING_INTENT | Standard color transformations
oyWIDGET_RENDERING_BPC | use BlackPointCompensation
oyWIDGET_RENDERING_INTENT_PROOF | Proofing color transformations
oyWIDGET_PROOF_SOFT | Proofing by default for screen
oyWIDGET_PROOF_HARD | Proofing by default for printing
oyWIDGET_EFFECT | Using Effect by default
oyWIDGET_RENDERING_GAMUT_WARNING | mark out of gamut colors
oyWIDGET_BEHAVIOUR_END | just for easen Gui design
oyWIDGET_EDITING_XYZ | XYZ Editing (Workspace) Profile
oyWIDGET_EDITING_LAB | Lab Editing (Workspace) Profile
oyWIDGET_EDITING_RGB | Rgb Editing (Workspace) Profile
oyWIDGET_EDITING_CMYK | Cmyk Editing (Workspace) Profile
oyWIDGET_EDITING_GRAY | Gray Editing (Workspace) Profile
oyWIDGET_ASSUMED_XYZ | standard XYZ assumed source profile
oyWIDGET_ASSUMED_LAB | standard Lab assumed source profile
oyWIDGET_ASSUMED_RGB | standard RGB assumed source profile
oyWIDGET_ASSUMED_WEB | std internet assumed source static_profile
oyWIDGET_ASSUMED_CMYK | standard Cmyk assumed source profile
oyWIDGET_ASSUMED_GRAY | standard Gray assumed source profile
oyWIDGET_PROFILE_PROOF | standard proofing profile
oyWIDGET_PROFILE_EFFECT | effect profile
oyWIDGET_DEFAULT_PROFILE_END | just for easen Gui design
oyWIDGET_DEVICES_RELATED | select only device related profiles [checkbox]
oyWIDGET_POLICY_ACTIVE | active policy [choice]
oyWIDGET_TAXI_PROFILE_INSTALL | Install selected profile [button]
oyWIDGET_CMM_START | CMM options
oyWIDGET_CMM_CONTEXT | CMM core selection
oyWIDGET_CMM_RENDERER | take a device link and color convert
oyWIDGET_CMM_CONTEXT_FALLBACK | CMM core fallback selection
oyWIDGET_CMM_RENDERER_FALLBACK | take a device link and color convert
oyWIDGET_CMM_END | just for easen Gui design

## ◆ oyWIDGET_TYPE_e

enum oyWIDGET_TYPE_e

type of widget

Enumerator
oyWIDGETTYPE_GROUP_TREE | group creating a new visibility (tab, leave)
oyWIDGETTYPE_PROFILE | select a profile through a list widget
oyWIDGETTYPE_INT | TODO Todo: value range
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