oyOption_s Struct Reference
[Values Handling]

Option for rendering. More...

#include <oyranos_alpha.h>

Data Fields
oyOBJECT_e	type_
oyStruct_Copy_f	copy
oyStruct_Release_f	release
oyObject_s	oy_
uint32_t	id
char *	registration
int	version [3]
oyVALUETYPE_e	value_type
oyValue_u *	value
oyOPTIONSOURCE_e	source
uint32_t	flags
Related Functions
(Note that these are not member functions.)
oyOption_s *	oyOption_New (oyObject_s object)
	new option
oyOption_s *	oyOption_Copy (oyOption_s *option, oyObject_s object)
	copy or reference a option
int	oyOption_Release (oyOption_s **obj)
	release a option
int	oyOption_Clear (oyOption_s *s)
	clear a option
int	oyOption_GetId (oyOption_s *obj)
	get the identification number of a option
char *	oyOption_GetValueText (oyOption_s *obj, oyAlloc_f allocateFunc)
	get value as a text dump
const char *	oyOption_GetText (oyOption_s *obj, oyNAME_e type)
	get a text dump
int	oyOption_SetFromText (oyOption_s *obj, const char *text)
	set a option value from a string

---

Detailed Description

Option for rendering.

Todo:

include the oyOptions_t_ type for gui elements should be used in a list oyColourTransformOptions_s to form a options set oyOptions_t_ covers as well the UI part which should be separated as of the SimpleToolkitAbstraction project: http://www.oyranos.org/wiki/index.php?title=XML_Plug-in_options As of this architecture change The UI part must be decided to obtain a place. Probably in oyOptions_s? Thus the oyOption_s::name member should be removed.

The id field maps to a oyWidget_s object. Options and widgets are to be queried by the according function / CMM combination.

Version:

Oyranos: 0.1.8

Since:

2007/00/00 (Oyranos: 0.1.x)

Date:

2008/04/14

---

Field Documentation

oyStruct_Copy_f oyOption_s::copy

copy function

uint32_t oyOption_s::flags

| oyOPTIONATTRIBUTE_e

Referenced by oyOption_Clear(), oyOption_SetFromText(), and oyOptions_s::oyOptions_DoFilter().

uint32_t oyOption_s::id

id to map to events and widgets

Referenced by oyOption_GetId(), and oyOption_Release().

oyObject_s oyOption_s::oy_

base object

Referenced by oyOption_Clear(), oyOption_Copy(), oyOption_GetText(), oyOption_Release(), and oyOption_SetFromText().

char* oyOption_s::registration

full key path name to store configuration, e.g. "sw/oyranos.org/generic/scale/x"

Referenced by oyOption_Clear(), oyOption_GetText(), oyOptions_s::oyOptions_Add(), oyOptions_s::oyOptions_DoFilter(), oyOptions_s::oyOptions_Find(), oyOptions_s::oyOptions_FindString(), and oyOptions_s::oyOptions_FromBoolean().

oyStruct_Release_f oyOption_s::release

release function

Referenced by oyOption_New().

oyOPTIONSOURCE_e oyOption_s::source

the source of this value

Referenced by oyOptions_s::oyOptions_DoFilter(), and oyOptions_s::oyOptions_ForFilter_().

oyOBJECT_e oyOption_s::type_

struct type oyOBJECT_OPTION_S

Referenced by oyOption_Release(), oyOptions_s::oyOptions_Find(), oyOptions_s::oyOptions_FindString(), and oyOptions_s::oyOptions_MoveIn().

oyValue_u* oyOption_s::value

the actual value

Referenced by oyOption_Clear(), oyOption_GetText(), oyOption_GetValueText(), oyOption_SetFromText(), and oyOptions_s::oyOptions_FindString().

oyVALUETYPE_e oyOption_s::value_type

the type in value

Referenced by oyOption_Clear(), oyOption_GetValueText(), oyOption_SetFromText(), oyOptions_s::oyOptions_FindString(), and oyOptions_s::oyOptions_FromBoolean().

int oyOption_s::version[3]

as for oyCMMapi4_s::version