Oyranos Color Management System API
Namespaces | Functions | Variables
oyranos_core.h File Reference

public Oyranos API's More...

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

Namespaces

 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 More...
 
int oyMessageFunc (int code, const oyPointer context_object, const char *format,...)
 default message function to console More...
 
int oyMessageFuncSet (oyMessage_f message_func)
 
int oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f f)
 register a function for verbosity More...
 
const char * oyStruct_GetInfo (oyPointer context, int flags)
 get a additional string from a object More...
 
int oyVersion (int type)
 give the compiled in library version More...
 
char * oyVersionString (int type, oyAlloc_f allocateFunc)
 give the configure options for Oyranos More...
 
void oyI18NSet (int active, int reserved)
 switch internationalisation of strings on or off More...
 
const char * oyLanguage (void)
 get language code More...
 
const char * oyCountry (void)
 get country code More...
 
const char * oyLang (void)
 get LANG code/variable More...
 
void oyI18Nreset (void)
 reset i18n language and country variables More...
 

Variables

int oy_debug
 Set debug level. More...
 
const char * oy_domain_codeset
 codeset for Oyranos More...
 

Detailed Description

public Oyranos API's

Oyranos is an open source Color Management System

Copyright:
2004-2011 (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

Function Documentation

◆ oyMessageFormat()

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 replace the fprintf with your favourite GUI call.
Version
Oyranos: 0.2.1
Since
2008/04/03 (Oyranos: 0.2.1)
Date
2011/01/15

Referenced by oyMessageFunc().

◆ 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
codea message code understood be your message handler or oyMSG_e
context_objecta oyStruct_s is expected from Oyranos
formatthe 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().

◆ oyMessageFuncSet()

int oyMessageFuncSet ( oyMessage_f  message_func)

oyMessageFuncSet

Version
Oyranos: 0.1.8
Date
2008/04/03
Since
2008/04/03 (Oyranos: 0.1.8)

◆ oyStruct_GetInfo()

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_objectthe object to get informations about
[in]flagscurrently 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

◆ oyStruct_RegisterStaticMessageFunc()

int oyStruct_RegisterStaticMessageFunc ( int  type,
oyStruct_RegisterStaticMessageFunc_f  f 
)

register a function for verbosity

oyStruct_RegisterStaticMessageFunc

Parameters
[in]typethe object oyOBJECT_e type
[in]fthe object string function
Returns
0 - success; >= 1 - error
Version
Oyranos: 0.2.1
Since
2011/01/14
Date
2011/01/14

Variable Documentation

◆ oy_debug

int oy_debug

Set debug level.

Variable oy_debug

Version
Oyranos: 0.0.1
Date
2005/02/01
Since
2005/02/01 (Oyranos: 0.0.1)

Referenced by oyConfig_s::oyConfig_Compare(), and oyFilterGraph_s::oyFilterGraph_ToText().

◆ oy_domain_codeset

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 oyranos_config_internal.h . OY_LOCALEDIR should match a corresponding $prefix/share/locale path.