![]() |
Oyranos
0.9.7
Oyranos is a full featured Color Management System
|
Oyranos base structure. More...
#include <oyStruct_s.h>
Public Member Functions | |
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... | |
int | oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f f) |
register a function for verbosity More... | |
const char * | oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags) |
get a additional string from a object More... | |
const char * | oyStructTypeToText (oyOBJECT_e type) |
Objects type to small string. 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... | |
Oyranos base structure.
All inherited Oyranos structures should be castable to this basic one.
const char * oyStruct_GetInfo | ( | oyPointer | context_object, |
oyNAME_e | type, | ||
int | flags | ||
) |
get a additional string from a object
Function oyStruct_GetInfo
The content can be provided by object authors by using oyStruct_RegisterStaticMessageFunc() typical at the first time of object creation.
Note: this function is a very low level version of oyStruct_GetText().
[in] | context_object | the object to get informations about |
[in] | type | request a suitable format |
[in] | flags | 0x01 - skip trivial struct type name |
References oyStructTypeToText(), and type_.
Referenced by oiccChangeNodeOption(), oydiFilterPlug_ImageDisplayRun(), oyMessageFormat(), oyObject_Show(), oyObject_UnRef(), oyStruct_CheckType(), and oyStruct_GetText().
const char * oyStruct_GetText | ( | oyStruct_s * | obj, |
oyNAME_e | name_type, | ||
uint32_t | flags | ||
) |
Get a text dump.
Function oyStruct_GetText
Ask the object type module for text informations.
obj | the object |
name_type | the text type |
flags |
|
References oy_, oyCMMapiFilters_s::oyCMMapiFilters_Count(), oyCMMapiFilters_s::oyCMMapiFilters_Get(), oyCMMapiFilters_s::oyCMMapiFilters_Release(), oyFILTER_REG_MODE_STRIP_IMPLEMENTATION_ATTR, oyNAME_NICK, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_DATA_TYPES_S, oyObject_GetName(), oyStruct_GetInfo(), oyStructTypeToText(), oyCMMapiFilter_s::release, and type_.
Referenced by oyOption_s::oyOption_GetText(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_ObserverCopyModel(), oyObserver_s::oyStruct_ObserverCopyObserver(), and oyObserver_s::oyStruct_ObserverSignal().
const char * oyStruct_GetTextFromModule | ( | oyStruct_s * | obj, |
oyNAME_e | name_type, | ||
uint32_t | flags | ||
) |
get object infos from a module
[in,out] | obj | the objects structure |
[in] | name_type | the type |
[in] | flags |
References oy_, oyCMMapiFilters_s::oyCMMapiFilters_Count(), oyCMMapiFilters_s::oyCMMapiFilters_Get(), oyCMMapiFilters_s::oyCMMapiFilters_Release(), oyNAME_NICK, oyOBJECT_CMM_API10_S, oyOBJECT_CMM_API4_S, oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API7_S, oyOBJECT_CMM_API8_S, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_HANDLE_S, oyOBJECT_CMM_INFO_S, oyObject_Copy(), oyObject_GetName(), oyObject_NewFrom(), oyObject_Release(), oyObject_SetParent(), oyObject_UnRef(), oyStructList_s::oyStructList_Count(), oyStructList_s::oyStructList_ReleaseAt(), oyStructTypeToText(), oyCMMapiFilter_s::release, and type_.
int oyStruct_RegisterStaticMessageFunc | ( | int | type, |
oyStruct_RegisterStaticMessageFunc_f | f | ||
) |
register a function for verbosity
Function oyStruct_RegisterStaticMessageFunc
[in] | type | the object oyOBJECT_e type |
[in] | f | the object string function |
const char * oyStructTypeToText | ( | oyOBJECT_e | type | ) |
Objects type to small string.
Function oyStructTypeToText
Give a basic description of inbuild object types.
References oyOBJECT_ARRAY2D_S, oyOBJECT_BLOB_S, oyOBJECT_CALLBACK_S, oyOBJECT_CMM_API10_S, oyOBJECT_CMM_API1_S, oyOBJECT_CMM_API2_S, oyOBJECT_CMM_API3_S, oyOBJECT_CMM_API4_S, oyOBJECT_CMM_API5_S, oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API7_S, oyOBJECT_CMM_API8_S, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_FILTERS_S, oyOBJECT_CMM_API_MAX, oyOBJECT_CMM_API_S, oyOBJECT_CMM_APIS_S, oyOBJECT_CMM_DATA_TYPES_S, oyOBJECT_CMM_HANDLE_S, oyOBJECT_CMM_INFO_S, oyOBJECT_CMM_OBJECT_TYPE_S, oyOBJECT_CMM_UI_S, oyOBJECT_COMP_S_, oyOBJECT_CONF_DOMAIN_S, oyOBJECT_CONFIG_S, oyOBJECT_CONFIGS_S, oyOBJECT_CONNECTOR_IMAGING_S, oyOBJECT_CONNECTOR_MAX_S, oyOBJECT_CONNECTOR_S, oyOBJECT_CONVERSION_S, oyOBJECT_EXTERNFUNC_S, oyOBJECT_FILE_LIST_S_, oyOBJECT_FILTER_CORE_S, oyOBJECT_FILTER_CORES_S, oyOBJECT_FILTER_GRAPH_S, oyOBJECT_FILTER_NODE_S, oyOBJECT_FILTER_NODES_S, oyOBJECT_FILTER_PLUG_S, oyOBJECT_FILTER_PLUGS_S, oyOBJECT_FILTER_SOCKET_S, oyOBJECT_FORMS_ARGS_S, oyOBJECT_HASH_S, oyOBJECT_ICON_S, oyOBJECT_IMAGE_S, oyOBJECT_INFO_STATIC_S, oyOBJECT_JOB_S, oyOBJECT_LIS_S, oyOBJECT_LIST_S, oyOBJECT_MODULE_S, oyOBJECT_MONITOR_HOOKS_S, oyOBJECT_MONITOR_S, oyOBJECT_NAME_S, oyOBJECT_NAMED_COLOR_S, oyOBJECT_NAMED_COLORS_S, oyOBJECT_OBJECT_S, oyOBJECT_OBSERVER_S, oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOBJECT_PIXEL_ACCESS_S, oyOBJECT_POINTER_S, oyOBJECT_PROFILE_S, oyOBJECT_PROFILE_TAG_S, oyOBJECT_PROFILES_S, oyOBJECT_RECTANGLE_S, oyOBJECT_STRUCT_LIST_S, oyOBJECT_UI_HANDLER_S, and oyValueUInt32().
Referenced by lrawCMMWarnFunc(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_Connect(), oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterNode_s::oyFilterNode_ShowConnector(), oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), oyFilterSocket_s::oyFilterSocket_GetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyGetCMMs(), oyImage_s::oyImage_Create(), oyImage_s::oyImage_FillArray(), oyMessageFormat(), oyMessageFunc(), oyObject_GetId(), oyObject_UnRef(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType2(), oyPixelAccess_s::oyPixelAccess_GetUserData(), oyPixelAccess_s::oyPixelAccess_SetUserData(), oyStruct_GetInfo(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_ObserverAdd(), and oyStructList_s::oyStructList_CopyFrom().
oyStruct_Copy_f oyStruct_s::copy |
Copy function.
Referenced by oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyJob_Add_(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType2(), oyPixelAccess_s::oyPixelAccess_SetUserData(), oyObserver_s::oyStruct_ObserverAdd(), oyStructList_s::oyStructList_CopyFrom(), and oyValue_u::oyValueCopy().
oyObject_s oyStruct_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
Referenced by lrawCMMWarnFunc(), oyContextCollectData_(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_GetData(), oyMessageFormat(), oyMessageFunc(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType2(), oyPointer_s::oyPointer_LookUpFromObject(), oyStruct_Allocate(), oyStruct_CheckType(), oyStruct_DeAllocate(), oyObserver_s::oyStruct_DisableSignalSend(), oyObserver_s::oyStruct_EnableSignalSend(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_IsObserved(), oyObserver_s::oyStruct_ObserverAdd(), oyObserver_s::oyStruct_ObserverCopyModel(), oyObserver_s::oyStruct_ObserverCopyObserver(), oyObserver_s::oyStruct_ObserverSignal(), oyStructList_s::oyStructList_CopyFrom(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetText(), and oyValue_u::oyValueCopy().
oyStruct_Release_f oyStruct_s::release |
Release function.
Referenced by oyFilterGraph_s::oyFilterGraph_ToText(), oyJob_s::oyJob_Release(), oyObserver_s::oyObserver_Release(), oyStructList_s::oyStructList_GetRefType(), oyValue_u::oyValueClear(), and oyValue_u::oyValueCopy().
const oyOBJECT_e oyStruct_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by l2cmsCMMData_Open(), lcmsCMMData_Open(), lrawCMMWarnFunc(), oyProfiles_s::oiccProfilesGetText(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_GetData(), oyMessageFormat(), oyMessageFunc(), oyObject_GetId(), oyObject_Show(), oyObjectTreePrint(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType2(), oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStruct_GetInfo(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_ObserverAdd(), oyStructList_s::oyStructList_CopyFrom(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetType(), oyStructList_s::oyStructList_MoveIn(), and oyValue_u::oyValueEqual().