oyranos_forms.h File Reference

common Oyranos forms declarations More...

#include "oyranos_alpha.h"

Data Structures
struct	oyFormsArgs_s
	a FormsArgs object More...

Functions
int	oyFormsAddHeadline (char **stream, int type, const char *value, oyAlloc_f allocateFunc, oyDeAlloc_f deAllocateFunc)
	add an html:Hxxx to a existing oforms stream More...
int	oyFormsAddItem (char **stream, const char *value, const char *label, oyAlloc_f allocateFunc, oyDeAlloc_f deAllocateFunc)
	add an xf:item to a existing oforms stream More...
int	oyFormsStartChoice (char **stream, const char *reference, const char *label, const char *choice, oyAlloc_f allocateFunc, oyDeAlloc_f deAllocateFunc)
	start an xf:choice to a existing oforms stream More...

Detailed Description

common Oyranos forms declarations

Oyranos is an open source Color Management System

Copyright:

2009 (C) Kai-Uwe Behrmann

Function Documentation

oyFormsAddHeadline()

int oyFormsAddHeadline	(	char **	stream,
		int	type,
		const char *	value,
		oyAlloc_f	allocateFunc,
		oyDeAlloc_f	deAllocateFunc
	)

add an html:Hxxx to a existing oforms stream

Function oyFormsAddHeadline

Parameters

[in,out]	stream	the oforms stream
[in]	type	the type of headline; typical 1...4
[in]	value	the value for the html:hx headline
[in]	allocateFunc	the stream allocator
[in]	deAllocateFunc	the stream deallocator

Version

Oyranos: 0.1.10

Since

2010/01/09 (Oyranos: 0.1.10)

Date

2010/01/09

oyFormsAddItem()

int oyFormsAddItem	(	char **	stream,
		const char *	value,
		const char *	label,
		oyAlloc_f	allocateFunc,
		oyDeAlloc_f	deAllocateFunc
	)

add an xf:item to a existing oforms stream

Function oyFormsAddItem The funtction is to be called after a xf:choices or other xf:items. The stream should be finished by other xf:items or a closing xf:choice.

Parameters

[in,out]	stream	the oforms stream
[in]	value	the value for the xf:item
[in]	label	the label for the xf:item
[in]	allocateFunc	the stream allocator
[in]	deAllocateFunc	the stream deallocator

Version

Oyranos: 0.1.10

Since

2010/01/09 (Oyranos: 0.1.10)

Date

2010/01/09

oyFormsStartChoice()

int oyFormsStartChoice	(	char **	stream,
		const char *	reference,
		const char *	label,
		const char *	help,
		oyAlloc_f	allocateFunc,
		oyDeAlloc_f	deAllocateFunc
	)

start an xf:choice to a existing oforms stream

Function oyFormsStartChoice The function is to be followed xf:items entries. The stream should be finished by a closing xf:choice.

Parameters

[in,out]	stream	the oforms stream
[in]	reference	the ref attribute for xf:choice
[in]	label	the label for the xf:choice
[in]	help	the help text for the xf:choice
[in]	allocateFunc	the stream allocator
[in]	deAllocateFunc	the stream deallocator

Version

Oyranos: 0.1.10

Since

2010/01/09 (Oyranos: 0.1.10)

Date

2010/01/09