oyranos_core.h File Reference

public Oyranos API's More...

#include <stdarg.h>
#include "oyranos_version.h"
#include "oyranos_types.h"

Namespaces
namespace	oyranos
	The Oyranos namespace.
Functions
int	oyMessageFormat (char **message_text, int code, const oyPointer context, const char *string)
	default function to form a message string
int	oyMessageFunc (int code, const oyPointer context_object, const char *format,...)
	default message function to console
int	oyMessageFuncSet (oyMessage_f message_func)
int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f f)
	register a function for verbosity
const char *	oyStruct_GetInfo (oyPointer context, int flags)
	get a additional string from a object
int	oyVersion (int type)
	give the compiled in library version
char *	oyVersionString (int type, oyAlloc_f allocateFunc)
	give the configure options for Oyranos
char *	oyDescriptionToHTML (int group, const char **options, oyAlloc_f allocateFunc)
	write a HTML description page
void	oyI18NSet (int active, int reserved)
	switch internationalisation of strings on or off
const char *	oyLanguage (void)
	get language code
const char *	oyCountry (void)
	get country code
const char *	oyLang (void)
	get LANG code/variable
void	oyI18Nreset (void)
	reset i18n language and country variables
Variables
const char *	oy_domain_codeset
	codeset for Oyranos

---

Detailed Description

public Oyranos API's

Oyranos is an open source Colour Management System

Copyright:

2004-2011 (C) Kai-Uwe Behrmann

Author:

Kai-Uwe Behrmann <ku.b@gmx.de>

License:

new BSD <http://www.opensource.org/licenses/bsd-license.php>

Since:

2004/11/25

---

Function Documentation

char* oyDescriptionToHTML	(	int	group,
		const char **	options,
		oyAlloc_f	allocateFunc
	)

write a HTML description page

Function oyDescriptionToHTML

    const char * opts[] = {"add_html_header","1",
                           "add_oyranos_title","1",
                           "add_oyranos_copyright","1",
                           NULL};
    char * html = oyDescriptionToHTML( oyGROUP_ALL, opts, malloc );
    

Parameters:

group	currently only oyGROUP_ALL
options	zero terminated paired key/value strings "add_html_header":"1" - adds a HTML header "bgcolor":"#cccccc" - background color "title":"myPage" - HTML page title
allocate_func	the user allocator

Returns:

the string

Version:

Oyranos: 0.3.2

Since:

2011/08/09 (Oyranos: 0.3.2)

Date:

2011/08/09

References oyDescriptionToHTML(), oyGetHtmlHeader(), oyGROUP_ALL, oyGROUP_BEHAVIOUR_MISSMATCH, oyGROUP_BEHAVIOUR_MIXED_MODE_DOCUMENTS, oyGROUP_BEHAVIOUR_PROOF, oyGROUP_BEHAVIOUR_RENDERING, oyGROUP_DEFAULT_PROFILES, oyWIDGET_ACTION_OPEN_MISMATCH_CMYK, oyWIDGET_ACTION_UNTAGGED_ASSIGN, oyWIDGET_BEHAVIOUR_END, oyWIDGET_DEFAULT_PROFILE_END, oyWIDGET_MIXED_MOD_DOCUMENTS_PRINT, oyWIDGET_MIXED_MOD_DOCUMENTS_SCREEN, oyWIDGET_RENDERING_INTENT, oyWIDGET_RENDERING_INTENT_PROOF, and oyWriteOptionToHTML_().

Referenced by oyDescriptionToHTML().

int oyMessageFormat	(	char **	message_text,
		int	code,
		const oyPointer	context_object,
		const char *	string
	)

default function to form a message string

oyMessageFormat This default message function is used as a message formatter. The resulting string can be placed anywhere, e.g. in a GUI.

See also:

the oyMessageFunc() needs just to replaxe the fprintf with your favourite GUI call.

Version:

Oyranos: 0.2.1

Since:

2008/04/03 (Oyranos: 0.2.1)

Date:

2011/01/15

References oyStruct_GetInfo(), and oyStructTypeToText().

Referenced by oyMessageFunc().

int oyMessageFunc	(	int	code,
		const oyPointer	context_object,
		const char *	format,
			...
	)

default message function to console

oyMessageFunc The default message function is used as a message printer to the console from library start.

Parameters:

code	a message code understood be your message handler or oyMSG_e
context_object	a oyStruct_s is expected from Oyranos
format	the text format string for following args
...	the variable args fitting to format

Returns:

0 - success; 1 - error

Version:

Oyranos: 0.3.0

Since:

2008/04/03 (Oyranos: 0.1.8)

Date:

2009/07/20

References oyMessageFormat().

int oyMessageFuncSet

(

oyMessage_f

message_func

)

oyMessageFuncSet

Version:

Oyranos: 0.1.8

Date:

2008/04/03

Since:

2008/04/03 (Oyranos: 0.1.8)

const char* oyStruct_GetInfo	(	oyPointer	context_object,
		int	flags
	)

get a additional string from a object

oyStruct_GetInfo The content can be provided by object authors by using oyStruct_RegisterStaticMessageFunc() typical at the first time of object creation.

Parameters:

[in]	context_object	the object to get informations about
[in]	flags	currently not used

Returns:

a string or NULL; The pointer might become invalid after further using the object pointed to by context.

Version:

Oyranos: 0.2.1

Since:

2011/01/15

Date:

2011/01/15

References oyStructTypeToText().

Referenced by oyMessageFormat().

int oyStruct_RegisterStaticMessageFunc	(	int	type,
		oyStruct_RegisterStaticMessageFunc_f	f
	)

register a function for verbosity

oyStruct_RegisterStaticMessageFunc

Parameters:

[in]	type	the object oyOBJECT_e type
[in]	f	the object string function

Returns:

0 - success; >= 1 - error

Version:

Oyranos: 0.2.1

Since:

2011/01/14

Date:

2011/01/14

---

Variable Documentation

const char* oy_domain_codeset

codeset for Oyranos

set here the codeset part, e.g. "UTF-8", which shall be delivered from Oyranos string translations. Set this variable before any call to Oyranos. The environment variable OY_LOCALEDIR overrides the static inbuild OY_LOCALEDIR macro defined in config.h . OY_LOCALEDIR should match a corresponding $prefix/share/locale path.

Referenced by oyXFORMsFromModelAndUi().