![]() |
Oyranos Colour Management System API |
The CMM API UI part. More...
#include <oyCMMui_s.h>
Public Types | |
typedef int(* | oyCMMuiGet_f )(oyOptions_s *options, char **ui_text, oyAlloc_f allocateFunc) |
obtain a XFORMS ui description More... | |
Public Member Functions | |
OYAPI oyCMMui_s *OYEXPORT | oyCMMui_New (oyObject_s object) |
allocate a new CMMui object More... | |
OYAPI oyCMMui_s *OYEXPORT | oyCMMui_Copy (oyCMMui_s *cmmui, oyObject_s object) |
copy or reference a CMMui object More... | |
OYAPI int OYEXPORT | oyCMMui_Release (oyCMMui_s **cmmui) |
release and possibly deallocate a oyCMMui_s object More... | |
const char ** | oyCMMui_GetTexts (oyCMMui_s *ui) |
Get texts for GetTextF. More... | |
void | oyCMMui_Release__Members (oyCMMui_s_ *cmmui) |
Custom CMMui destructor. More... | |
int | oyCMMui_Init__Members (oyCMMui_s_ *cmmui) |
Custom CMMui constructor. More... | |
int | oyCMMui_Copy__Members (oyCMMui_s_ *dst, oyCMMui_s_ *src) |
Custom CMMui copy constructor. More... | |
![]() | |
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get a text dump More... | |
Data Fields | |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
![]() | |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
The CMM API UI part.
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.
[in] | cmmui | CMMui struct object |
object | NULL - means reference, the optional object triggers 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
[in] | node | ui object |
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.
int oyCMMui_Init__Members | ( | oyCMMui_s_ * | cmmui | ) |
Custom CMMui constructor.
Function oyCMMui_Init__Members
OYAPI oyCMMui_s *OYEXPORT oyCMMui_New | ( | oyObject_s | object | ) |
OYAPI int OYEXPORT oyCMMui_Release | ( | oyCMMui_s ** | cmmui | ) |
release and possibly deallocate a oyCMMui_s object
Function oyCMMui_Release
[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
oyStruct_Copy_f oyCMMui_s::copy |
copy function
oyStruct_Release_f oyCMMui_s::release |
release function