![]() |
Oyranos Color Management System API |
The CMM API UI part. More...
#include <oyCMMui_s.h>
Public Types | |
typedef int(* | oyCMMuiGet_f) (oyCMMapiFilter_s *module, 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... | |
OYAPI oyCMMui_s *OYEXPORT | oyCMMui_Create (const char *category, oyCMMGetText_f getText, const char **texts, oyObject_s object) |
Create a oyCMMui_s object. More... | |
OYAPI void OYEXPORT | oyCMMui_SetUiOptions (oyCMMui_s *ui, const char *options, oyCMMuiGet_f oyCMMuiGet) |
Set UI for possible options. More... | |
oyCMMGetText_f | oyCMMui_GetTextF (oyCMMui_s *ui) |
Get the GetText function. More... | |
const char ** | oyCMMui_GetTexts (oyCMMui_s *ui) |
Get texts for GetTextF. More... | |
oyCMMapiFilter_s * | oyCMMui_GetParent (oyCMMui_s *ui) |
Get the parent structure. More... | |
![]() | |
const char * | oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get object infos from a module More... | |
const char * | oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags) |
get a text dump More... | |
Data Fields | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
![]() | |
const oyOBJECT_e | type_ |
Type of object. More... | |
oyStruct_Copy_f | copy |
Copy function. More... | |
oyStruct_Release_f | release |
Release function. More... | |
oyObject_s | oy_ |
Oyranos internal object. More... | |
The CMM API UI part.
typedef int(* oyCMMuiGet_f) (oyCMMapiFilter_s *module, oyOptions_s *options, char **ui_text, oyAlloc_f allocateFunc) |
obtain a XFORMS ui description
typedef oyCMMuiGet_f
The structures can provide a XFORMS ui based on the modules own set of options. The options are in the property of the caller.
[in] | module | the owner |
[in] | options | the options to display |
[out] | ui_text | the XFORMS string |
[in] | allocateFunc | user allocator |
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.
Referenced by oyCMMapi4_s::oyCMMapi4_Create().
OYAPI oyCMMui_s *OYEXPORT oyCMMui_Create | ( | const char * | category, |
oyCMMGetText_f | getText, | ||
const char ** | texts, | ||
oyObject_s | object | ||
) |
Create a oyCMMui_s object.
Function oyCMMui_Create
category | menu structure |
getText | translated UI texts |
texts | zero terminated list of string classes for getText, e.g. {"name","category","help",0}
|
object | optional object |
References oyCMMui_New().
oyCMMapiFilter_s * oyCMMui_GetParent | ( | oyCMMui_s * | ui | ) |
Get the parent structure.
[in] | ui | ui object |
References oyCMMapiFilter_s::copy.
oyCMMGetText_f oyCMMui_GetTextF | ( | oyCMMui_s * | ui | ) |
Get the GetText function.
Function oyCMMui_GetTextF
[in] | ui | ui object |
const char ** oyCMMui_GetTexts | ( | oyCMMui_s * | ui | ) |
Get texts for GetTextF.
Function oyCMMui_GetTexts
[in] | ui | 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.
OYAPI oyCMMui_s *OYEXPORT oyCMMui_New | ( | oyObject_s | object | ) |
allocate a new CMMui object
Function oyCMMui_New
References oyOBJECT_OBJECT_S.
Referenced by oyCMMui_Create().
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.
OYAPI void OYEXPORT oyCMMui_SetUiOptions | ( | oyCMMui_s * | ui, |
const char * | options, | ||
oyCMMuiGet_f | oyCMMuiGet | ||
) |
Set UI for possible options.
Function oyCMMui_SetUiOptions
[in] | ui | ui object |
options | the default options as oFORMS model compatible XML | |
oyCMMuiGet | the oFORMS UI for filter options |
References oyOBJECT_CMM_UI_S.
oyStruct_Copy_f oyCMMui_s::copy |
Copy function.
oyObject_s oyCMMui_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyCMMui_s::release |
Release function.
const oyOBJECT_e oyCMMui_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.