oyCMMui_s Struct Reference

The CMM API UI part. More...

#include <oyCMMui_s.h>

Inheritance diagram for oyCMMui_s:

Collaboration diagram for oyCMMui_s:

Public Types
typedef int(*	oyCMMuiGet_f )(oyOptions_s *options, char **ui_text, oyAlloc_f allocateFunc)
	obtain a XFORMS ui description

Public Member Functions
OYAPI oyCMMui_s *OYEXPORT	oyCMMui_New (oyObject_s object)
	allocate a new CMMui object
OYAPI oyCMMui_s *OYEXPORT	oyCMMui_Copy (oyCMMui_s *cmmui, oyObject_s object)
	copy or reference a CMMui object
OYAPI int OYEXPORT	oyCMMui_Release (oyCMMui_s **cmmui)
	release and possibly deallocate a oyCMMui_s object
const char **	oyCMMui_GetTexts (oyCMMui_s *ui)
	Get texts for GetTextF.
void	oyCMMui_Release__Members (oyCMMui_s_ *cmmui)
	Custom CMMui destructor.
int	oyCMMui_Init__Members (oyCMMui_s_ *cmmui)
	Custom CMMui constructor.
int	oyCMMui_Copy__Members (oyCMMui_s_ *dst, oyCMMui_s_ *src)
	Custom CMMui copy constructor.
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get a text dump

Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
Data Fields inherited from oyStruct_s
oyStruct_Copy_f	copy
oyStruct_Release_f	release

Detailed Description

The CMM API UI part.

Member Function Documentation

OYAPI oyCMMui_s *OYEXPORT oyCMMui_Copy	(	oyCMMui_s *	cmmui,
		oyObject_s	object
	)

copy or reference a CMMui object

Function oyCMMui_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters

[in]	cmmui	CMMui struct object
	object	NULL - means reference, the optional object triffers a real copy

References oyOBJECT_CMM_UI_S.

int oyCMMui_Copy__Members	(	oyCMMui_s_ *	dst,
		oyCMMui_s_ *	src
	)

Custom CMMui copy constructor.

Function oyCMMui_Copy__Members

const char ** oyCMMui_GetTexts

(

oyCMMui_s *

ui

)

Get texts for GetTextF.

Function oyCMMui_GetTexts

Parameters

[in]

node

ui object

Returns

the zero terminated string list

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.

Version

Oyranos: 0.5.0

Date

2012/09/15

Since

2012/09/15 (Oyranos: 0.5.0)

int oyCMMui_Init__Members

(

oyCMMui_s_ *

cmmui

)

Custom CMMui constructor.

Function oyCMMui_Init__Members

OYAPI oyCMMui_s *OYEXPORT oyCMMui_New

(

oyObject_s

object

)

allocate a new CMMui object

Function oyCMMui_New

References oyOBJECT_OBJECT_S.

OYAPI int OYEXPORT oyCMMui_Release

(

oyCMMui_s **

cmmui

)

release and possibly deallocate a oyCMMui_s object

Function oyCMMui_Release

Parameters

[in,out]

cmmui

CMMui struct object

References oyOBJECT_CMM_UI_S.

void oyCMMui_Release__Members

(

oyCMMui_s_ *

cmmui

)

Custom CMMui destructor.

Function oyCMMui_Release__Members

Field Documentation

oyStruct_Copy_f oyCMMui_s::copy

copy function

oyStruct_Release_f oyCMMui_s::release

release function