oyranos_alpha.h File Reference

object APIs More...

#include "oyranos.h"
#include "oyranos_conversion.h"
#include "oyranos_icc.h"
#include "oyranos_image.h"
#include "oyranos_object.h"
#include "oyBlob_s.h"
#include "oyFilterCore_s.h"
#include "oyHash_s.h"
#include "oyName_s.h"
#include "oyObject_s.h"
#include "oyOptions_s.h"
#include "oyProfile_s.h"
#include "oyStruct_s.h"
#include "oyStructList_s.h"

Data Structures
struct	oyCallback_s
	a Callback object More...
struct	oyNamedColour_s
	colour patch with meta informations More...
struct	oyNamedColours_s
	list of colour patches More...
struct	oyUiHandler_s
	provide a list of handlers to build the UI More...

Macros
#define	OY_IN_PLANING

Typedefs
typedef int(*	oyUiHandler_f )(oyPointer cur, oyOptions_s *collected_elements, oyPointer handler_context)
	handle parser output and build the UI

Enumerations
enum	oyDATALAYOUT_e { ,   oyDATALAYOUT_CURVE, oyDATALAYOUT_MATRIX, oyDATALAYOUT_TABLE, oyDATALAYOUT_ARRAY,   oyDATALAYOUT_MAX }
	ideas for basic data arrangements More...

Functions
void	oyCopyColour (const double *from, double *to, int n, oyProfile_s *profile_ref, int channels_n)
	copy pure colours
char **	oyModulsGetNames (int *count, oyAlloc_f allocateFunc)
const char *	oyModulGetOptions (const char *cmm, oyObject_s object)
char *	oyDumpColourToCGATS (const double *channels, size_t n, oyProfile_s *prof, oyAlloc_f allocateFunc, const char *DESCRIPTOR)
	create CGATS text from double value array and a profile
char *	oyXFORMsFromModelAndUi (const char *data, const char *ui_text, const char **namespaces, const char *head_injection, oyAlloc_f allocate_func)
	join data and UI
int	oyXFORMsRenderUi (const char *xforms, oyUiHandler_s **ui_handlers, oyPointer user_data)
	render the UI by a selected toolkit
int	oyModulRegisterXML (oyGROUP_e group, const char *xml)
int	oyGetMonitorInfo (const char *display, char **manufacturer, char **model, char **serial, char **display_geometry, char **system_port, oyBlob_s **edit, oyAlloc_f allocate_func)
	brief pick up monitor information with Xlib

Detailed Description

object APIs

Oyranos is an open source Colour Management System

Copyright:

2004-2012 (C) Kai-Uwe Behrmann

Author

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

License:

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

Since

2004/11/25

Macro Definition Documentation

#define OY_IN_PLANING

Date

25. 11. 2004

Typedef Documentation

typedef int(* oyUiHandler_f)(oyPointer cur, oyOptions_s *collected_elements, oyPointer handler_context)

handle parser output and build the UI

Parameters

[in]	cur	libxml2 node
[in]	collected_elements	from libxml2
[in]	handler_context	the toolkit context

Returns

ns + ':' + name

Version

Oyranos: 0.1.10

Since

2009/08/30 (Oyranos: 0.1.10)

Date

2009/08/30

Enumeration Type Documentation

enum oyDATALAYOUT_e

ideas for basic data arrangements

Version

Oyranos: 0.1.8

Since

2008/00/00 (Oyranos: 0.1.8)

Date

2008/00/00

Enumerator:

oyDATALAYOUT_CURVE	equally spaced curve, oyDATALAYOUT_e[0], size[1], min[2], max[3], elements[4]...
oyDATALAYOUT_MATRIX	3x3 matrix, oyDATALAYOUT_e[0], a1[1],a2[2],a3,b1,b2,b3,c1,c2,c3
oyDATALAYOUT_TABLE	CLUT, oyDATALAYOUT_e[0], table dimensions in[1], array out[2], size of first dimension[3], size of second [4], ... size of last[n], elements[n+1]...
oyDATALAYOUT_ARRAY	value array, oyDATALAYOUT_e[0], size[1], elements[2]...
oyDATALAYOUT_MAX	paired curve, layout as in oyDATA_LAYOUT_CURVE but with elements grouped to two oyDATALAYOUT_e[0], triangle count[1], indixes[2], XYZ triples[3..5]..., followed by interwoven index + normale + midpoint triples[n]...

Function Documentation

const char* oyModulGetOptions	(	const char *	cmm,
		oyObject_s	object
	)

Query for available options for a cmm

Parameters

[in]	cmm	the 4 char CMM ID or zero for the current CMM
[in]	object	the optional base

Returns

available options

int oyModulRegisterXML	(	oyGROUP_e	group,
		const char *	xml
	)

Deprecated:

char** oyModulsGetNames	(	int *	count,
		oyAlloc_f	allocateFunc
	)

obtain 4 char CMM identifiers and count of CMM's

char* oyXFORMsFromModelAndUi	(	const char *	data,
		const char *	ui_text,
		const char **	namespaces,
		const char *	head_injection,
		oyAlloc_f	allocate_func
	)

join data and UI

Function oyXFORMsFromModelAndUi

Parameters

[in]	data	data text
[in]	ui_text	ui text
[in]	namespaces	url style namespaces
[in]	head_injection	html text to include in the HEAD section With a NULL pointer Oyranos will implicit insert a default CSS.
[in]	allocate_func	user allocator

Returns

XFORMS text

Version

Oyranos: 0.1.10

Since

2009/08/31 (Oyranos: 0.1.10)

Date

2009/08/31

References oy_domain_codeset, and OY_XFORMS_CSS.

int oyXFORMsRenderUi	(	const char *	xforms,
		oyUiHandler_s **	ui_handlers,
		oyPointer	user_data
	)

render the UI by a selected toolkit

Function oyXFORMsRenderUi Parse the XFORMS XML and render with the selected toolkit UI handlers.

Parameters

[in]	xforms	XFORMS text
[in]	ui_handlers	the toolkit specific XFORMS handlers
[in,out]	user_data	user context passed to ui_handlers

Returns

error

Version

Oyranos: 0.1.10

Since

2009/08/31 (Oyranos: 0.1.10)

Date

2009/08/31