![]() |
Oyranos Color Management System API - Version 0.9.6 |
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... | |
oyStruct_RegisterStaticMessageFunc | |
register a function for verbosity More... | |
oyStruct_GetInfo | |
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.
oyStruct_GetInfo |
get a additional string from a object
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 |
Referenced by 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(), oyCMMapi9_s::release, and type_.
Referenced by oyFilterNode_s::oyFilterNode_TextToInfo_(), oyOption_s::oyOption_GetText(), oyOption_SetFromText_(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_ObserverCopyModel(), oyObserver_s::oyStruct_ObserverCopyObserver(), oyObserver_s::oyStruct_ObserverListGet_(), oyObserver_s::oyStruct_ObserverSignal(), and oyObserver_s::oyStructSignalForward_().
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(), oyCMMinfo_s::oyCMMinfo_GetCMM(), 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_GetType_(), oyStructList_s::oyStructList_ReleaseAt(), oyStructTypeToText(), oyCMMapi9_s::release, type_, and oyCMMinfo_s::type_.
oyStruct_RegisterStaticMessageFunc |
register a function for verbosity
[in] | type | the object oyOBJECT_e type |
[in] | f | the object string function |
Referenced by oyArray2d_s::oyArray2d_Copy__Members(), oyCMMapi10_s::oyCMMapi10_Copy__Members(), oyCMMapi3_s::oyCMMapi3_Copy__Members(), oyCMMapi4_s::oyCMMapi4_Copy__Members(), oyCMMapi5_s::oyCMMapi5_Copy__Members(), oyCMMapi6_s::oyCMMapi6_Copy__Members(), oyCMMapi7_s::oyCMMapi7_Copy__Members(), oyCMMapi8_s::oyCMMapi8_Copy__Members(), oyCMMapi9_s::oyCMMapi9_Copy__Members(), oyCMMapi_s::oyCMMapi_Copy__Members(), oyCMMapiFilter_s::oyCMMapiFilter_Copy__Members(), oyCMMapiFilters_s::oyCMMapiFilters_Copy__Members(), oyCMMapis_s::oyCMMapis_Copy__Members(), oyCMMinfo_s::oyCMMinfo_Copy__Members(), oyCMMobjectType_s::oyCMMobjectType_Copy__Members(), oyCMMui_s::oyCMMui_Copy__Members(), oyConfigs_s::oyConfigs_Copy__Members(), oyConnector_s::oyConnector_Copy__Members(), oyConnectorImaging_s::oyConnectorImaging_Copy__Members(), oyConversion_s::oyConversion_Copy__Members(), oyFilterCore_s::oyFilterCore_Copy__Members(), oyFilterGraph_s::oyFilterGraph_Copy__Members(), oyFilterNode_s::oyFilterNode_Copy__Members(), oyFilterNodes_s::oyFilterNodes_Copy__Members(), oyFilterPlug_s::oyFilterPlug_Copy__Members(), oyFilterPlugs_s::oyFilterPlugs_Copy__Members(), oyFilterSocket_s::oyFilterSocket_Copy__Members(), oyImage_s::oyImage_Copy__Members(), oyList_s::oyList_Copy__Members(), oyNamedColor_s::oyNamedColor_Copy__Members(), oyNamedColors_s::oyNamedColors_Copy__Members(), oyOptions_s::oyOptions_Copy__Members(), oyPixelAccess_s::oyPixelAccess_Copy__Members(), and oyProfiles_s::oyProfiles_Copy__Members().
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 oyArray2d_s::oyArray2d_Copy__Members(), oyCMMapi10_s::oyCMMapi10_Copy__Members(), oyCMMapi3_s::oyCMMapi3_Copy__Members(), oyCMMapi4_s::oyCMMapi4_Copy__Members(), oyCMMapi5_s::oyCMMapi5_Copy__Members(), oyCMMapi6_s::oyCMMapi6_Copy__Members(), oyCMMapi7_s::oyCMMapi7_Copy__Members(), oyCMMapi8_s::oyCMMapi8_Copy__Members(), oyCMMapi9_s::oyCMMapi9_Copy__Members(), oyCMMapi_s::oyCMMapi_Copy__Members(), oyCMMapiFilter_s::oyCMMapiFilter_Copy__Members(), oyCMMapiFilters_s::oyCMMapiFilters_Copy__Members(), oyCMMapis_s::oyCMMapis_Copy__Members(), oyCMMinfo_s::oyCMMinfo_Copy__Members(), oyCMMobjectType_s::oyCMMobjectType_Copy__Members(), oyCMMui_s::oyCMMui_Copy__Members(), oyConfigs_s::oyConfigs_Copy__Members(), oyConnector_s::oyConnector_Copy__Members(), oyConnectorImaging_s::oyConnectorImaging_Copy__Members(), oyConversion_s::oyConversion_Copy__Members(), oyFilterCore_s::oyFilterCore_Copy__Members(), oyFilterGraph_s::oyFilterGraph_Copy__Members(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_Connect(), oyFilterNode_s::oyFilterNode_Copy__Members(), oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_GetData_(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterNode_s::oyFilterNode_ShowConnector(), oyFilterNodes_s::oyFilterNodes_Copy__Members(), oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), oyFilterPlug_s::oyFilterPlug_Copy__Members(), oyFilterPlugs_s::oyFilterPlugs_Copy__Members(), oyFilterSocket_s::oyFilterSocket_Copy__Members(), oyFilterSocket_s::oyFilterSocket_GetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyGetCMMs(), oyImage_s::oyImage_Copy__Members(), oyImage_s::oyImage_Create(), oyImage_s::oyImage_FillArray(), oyList_s::oyList_Copy__Members(), oyNamedColor_s::oyNamedColor_Copy__Members(), oyNamedColors_s::oyNamedColors_Copy__Members(), oyObject_GetId(), oyObject_Show(), oyObject_UnRef(), oyObserver_s::oyObserver_Copy_(), oyOption_s::oyOption_GetStruct(), oyOption_SetFromText_(), oyOptions_s::oyOptions_Copy__Members(), oyOptions_s::oyOptions_GetType(), oyPixelAccess_s::oyPixelAccess_Copy__Members(), oyPixelAccess_s::oyPixelAccess_GetUserData(), oyPixelAccess_s::oyPixelAccess_SetUserData(), oyProfiles_s::oyProfiles_Copy__Members(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_ObserverAdd(), oyStructList_s::oyStructList_CopyFrom(), and oyStructList_s::oyStructList_ReferenceAt_().
oyStruct_Copy_f oyStruct_s::copy |
Copy function.
Referenced by oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_GetData_(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyObserver_s::oyObserver_Copy_(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType(), oyPixelAccess_s::oyPixelAccess_SetUserData(), oyObserver_s::oyStruct_ObserverAdd(), oyStructList_s::oyStructList_CopyFrom(), oyStructList_s::oyStructList_ReferenceAt_(), 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 oyContextCollectData_(), oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_GetData_(), oyFilterNode_s::oyFilterNode_TextToInfo_(), oyObject_Show(), oyObserver_s::oyObserver_Copy_(), oyOption_s::oyOption_GetStruct(), oyOption_SetFromText_(), oyOptions_s::oyOptions_GetType(), oyPointer_s::oyPointer_LookUpFromObject(), oyStruct_Allocate(), oyStruct_CheckType(), 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_ObserverListGet_(), oyObserver_s::oyStruct_ObserverSignal(), oyStructList_s::oyStructList_CopyFrom(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetText(), oyStructList_s::oyStructList_ReferenceAt_(), oyObserver_s::oyStructSignalForward_(), and oyValue_u::oyValueCopy().
oyStruct_Release_f oyStruct_s::release |
const oyOBJECT_e oyStruct_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_GetData_(), oyFilterNode_s::oyFilterNode_TextToInfo_(), oyObject_GetId(), oyObject_Show(), oyObserver_s::oyObserver_Copy_(), oyOption_s::oyOption_GetStruct(), oyOption_SetFromText_(), oyOptions_s::oyOptions_GetType(), oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_ObserverAdd(), oyStructList_s::oyStructList_CopyFrom(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetType(), oyStructList_s::oyStructList_GetType_(), oyStructList_s::oyStructList_MoveIn(), oyStructList_s::oyStructList_ReferenceAt_(), oyObserver_s::oyStructSignalForward_(), and oyValue_u::oyValueEqual().