oyranos.h File Reference

public Oyranos API's More...

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

Namespaces
	oyranos
	The Oyranos namespace.

Macros
#define	oyDEFAULT_PROFILE   oyPROFILE_e
#define	OY_LAYOUT_NO_CHOICES   0x01 /**!< show informational */
	layout flags for widgets More...

Enumerations
enum	oyGROUP_e { ,   oyGROUP_POLICY, oyGROUP_PATHS, oyGROUP_DEFAULT_PROFILES, oyGROUP_DEFAULT_PROFILES_EDIT,   oyGROUP_DEFAULT_PROFILES_ASSUMED, oyGROUP_DEFAULT_PROFILES_PROOF, oyGROUP_BEHAVIOUR, oyGROUP_BEHAVIOUR_RENDERING,   oyGROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS, oyGROUP_BEHAVIOUR_MISSMATCH, oyGROUP_BEHAVIOUR_PROOF, 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_RENDERING_GAMUT_WARNING, oyBEHAVIOUR_END }
	Behaviour settings. More...
enum	{ oyNO, oyYES, oyASK }
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,   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_DEFAULT_PROFILES_PROOF, oyWIDGET_GROUP_BEHAVIOUR, oyWIDGET_GROUP_BEHAVIOUR_RENDERING,   oyWIDGET_GROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS, oyWIDGET_GROUP_BEHAVIOUR_MISSMATCH, oyWIDGET_GROUP_BEHAVIOUR_PROOF, oyWIDGET_GROUP_ALL,   oyWIDGET_GROUP_DEVICES, 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_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_DEFAULT_PROFILE_END, oyWIDGET_CMM_START = 300, oyWIDGET_CMM_SELECT,   oyWIDGET_CMM_INTENT, oyWIDGET_CMM_BPC, oyWIDGET_CMM_INTENT_PROOF }
	options for UI presentation, covering all kind of settings More...
enum	oyWIDGET_TYPE_e { ,   oyWIDGETTYPE_BEHAVIOUR , oyWIDGETTYPE_INT, oyWIDGETTYPE_FLOAT, oyWIDGETTYPE_CHOICE,   oyWIDGETTYPE_LIST, oyWIDGETTYPE_VOID, oyWIDGETTYPE_END }
	type of widget More...

Functions
int	oyGetBehaviour (oyBEHAVIOUR_e type)
int	oySetBehaviour (oyBEHAVIOUR_e type, int choice)
int	oyPolicySaveActual (oyGROUP_e group, 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)
int	oyPolicyFileNameGet (const char *policy_name, char **full_name, oyAlloc_f allocateFunc)
	resolve the file name of a policy More...
char *	oyGetPathFromProfileName (const char *profile_name, oyAlloc_f)
int	oySetDefaultProfile (oyPROFILE_e type, 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...
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...
void	oyOptionChoicesFree (oyWIDGET_e option, char ***list, int size)
	delete list of choices from a option More...
int	oyProfileGetMD5 (void *buffer, size_t size, unsigned char *md5_return)
	calculate a md5 digest beginning after the header offset More...

Detailed Description

public Oyranos API's

Oyranos is an open source Color Management System

Copyright:

2004-2010 (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-license.php

Since

2004/11/25

Macro Definition Documentation

#define OY_LAYOUT_NO_CHOICES   0x01 /**!< show informational */

layout flags for widgets

#define oyDEFAULT_PROFILE   oyPROFILE_e

Deprecated:

provide oyDEFAULT_PROFILE for compatibility

Enumeration Type Documentation

anonymous enum

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

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_RENDERING_GAMUT_WARNING	mark out of gamut colors
oyBEHAVIOUR_END	just for easen Gui design

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_DEFAULT_PROFILES_PROOF	Default Proofing 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_ALL	just for easen Gui design
oyGROUP_EXTERN	start of groups in a extern module

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
oyDEFAULT_PROFILE_END	just for easen Gui design

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_DEFAULT_PROFILES_PROOF	Default Proofing 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 Missmatch Behaviour
oyWIDGET_GROUP_ALL	just for easen Gui design
oyWIDGET_GROUP_DEVICES	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_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_DEFAULT_PROFILE_END	just for easen Gui design
oyWIDGET_CMM_START	CMM options
oyWIDGET_CMM_SELECT	CMM selection
oyWIDGET_CMM_INTENT	CMM rendering intent
oyWIDGET_CMM_BPC	black point compensation switch
oyWIDGET_CMM_INTENT_PROOF	Proofing color transformations

enum oyWIDGET_TYPE_e

type of widget

Enumerator
oyWIDGETTYPE_BEHAVIOUR	!< group creating a new visibility (tab, leave)
oyWIDGETTYPE_INT	!< select a profile through a list widget
oyWIDGETTYPE_FLOAT	!< TODO Todo: value range
oyWIDGETTYPE_CHOICE	!< IEEE floating point number
oyWIDGETTYPE_LIST	!< option from a array of choices
oyWIDGETTYPE_VOID	!< list widget, like for paths
oyWIDGETTYPE_END	!< data block, should not be selectable