oyCMMui_s Struct Reference

the CMM API UI part More...

#include <oyranos_cmm.h>

Data Fields
oyOBJECT_e	type
oyPointer	dummya
oyPointer	dummyb
oyPointer	dummyc
int32_t	version [3]
int32_t	module_api [3]
oyCMMFilter_ValidateOptions_f	oyCMMFilter_ValidateOptions
oyWidgetEvent_f	oyWidget_Event
const char *	category
const char *	options
oyCMMuiGet_f	oyCMMuiGet
oyCMMGetText_f	getText
const char **	texts

---

Detailed Description

the CMM API UI part

Version:

Oyranos: 0.1.10

Since:

2009/09/06 (Oyranos: 0.1.10)

Date:

2009/12/17

---

Field Documentation

const char* oyCMMui_s::category

menu structure

oyPointer oyCMMui_s::dummya

keep to zero

oyPointer oyCMMui_s::dummyb

keep to zero

oyPointer oyCMMui_s::dummyc

keep to zero

oyCMMGetText_f oyCMMui_s::getText

translated UI texts

Referenced by oyFilterCore_s::oyFilterCore_GetName().

int32_t oyCMMui_s::module_api[3]

0: last major Oyranos version during development time, e.g. 0 1: last minor Oyranos version during development time, e.g. 0 2: last Oyranos patch version during development time, e.g. 10

const char* oyCMMui_s::options

default options as Elektra/XFORMS compatible XML

oyCMMFilter_ValidateOptions_f oyCMMui_s::oyCMMFilter_ValidateOptions

check options for validy and correct

oyCMMuiGet_f oyCMMui_s::oyCMMuiGet

xml ui elements for filter options

Referenced by oyFilterNode_s::oyFilterNode_UiGet().

oyWidgetEvent_f oyCMMui_s::oyWidget_Event

handle widget events

const char** oyCMMui_s::texts

zero terminated categories for getText, e.g. {"name","category","help",0}

The "name" texts shall include information about the module. The "category" gives in oyNAME_NAME a translated version of oyCMMui_s::category. The "help" texts should provide general infromations about the module.

The oyNAME_NICK for the several oyCMMui_s::getText() texts is typical not translated. For "name" the oyNAME_NICK should be the module name. For other texts like "help" and "category" oyNAME_NICK makes no sense.

oyOBJECT_e oyCMMui_s::type

struct type oyOBJECT_CMM_DATA_TYPES_S

int32_t oyCMMui_s::version[3]

0: major - should be stable for the live time of a filters UI,
1: minor - mark new features,
2: patch version - correct errors