Oyranos Color Management System API - Version 0.9.6
Public Member Functions | Data Fields
oyStruct_s Struct Reference

Oyranos base structure. More...

#include <oyStruct_s.h>

Inheritance diagram for oyStruct_s:
Inheritance graph
Collaboration diagram for oyStruct_s:
Collaboration graph

Public Member Functions

const char * oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get object infos from a module
const char * oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 Get a text dump.
 oyStruct_RegisterStaticMessageFunc
 register a function for verbosity
 oyStruct_GetInfo
 get a additional string from a object
const char * oyStructTypeToText (oyOBJECT_e type)
 Objects type to small string.

Data Fields

const oyOBJECT_e type_
 Type of object.
oyStruct_Copy_f copy
 Copy function.
oyStruct_Release_f release
 Release function.
oyObject_s oy_
 Oyranos internal object.

Detailed Description

Oyranos base structure.

All inherited Oyranos structures should be castable to this basic one.

Note
New templates will not be created automaticly [notemplates]
Version
Oyranos: x.x.x
Since
Oyranos: version 0.1.8
Date
1 january 2008 (API 0.1.8)
Examples:
image_display.cpp, and oyranos_cmm_oJPG.c.

Member Function Documentation

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().

Parameters
[in]context_objectthe object to get informations about
[in]typerequest a suitable format
[in]flags0x01 - skip trivial struct type name
Returns
a string or NULL; The pointer might become invalid after further using the object pointed to by context.
Version
Oyranos: 0.9.6
Date
2016/04/18
Since
2011/01/15 (Oyranos: 0.2.1)

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.

Parameters
objthe object
name_typethe text type
flags
  • 0: get object infos
  • 1: get object type infos
  • 2: skip object type infos
Returns
the text
Version
Oyranos: 0.9.6
Date
2016/04/18
Since
2009/09/14 (Oyranos: 0.1.10)

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

Parameters
[in,out]objthe objects structure
[in]name_typethe type
[in]flags
See Also
oyStruct_GetText
Returns
the text
Version
Oyranos: 0.3.3
Since
2009/09/15 (Oyranos: 0.3.3)
Date
2011/10/31

References oy_, oyCMMapiFilters_s::oyCMMapiFilters_Count(), oyCMMapiFilters_s::oyCMMapiFilters_Get(), oyCMMapiFilters_s::oyCMMapiFilters_Release(), oyNAME_NICK, oyOBJECT_CMM_API9_S, oyObject_GetName(), oyStructTypeToText(), oyCMMapiFilter_s::release, and type_.

oyStruct_RegisterStaticMessageFunc

register a function for verbosity

Parameters
[in]typethe object oyOBJECT_e type
[in]fthe object string function
Returns
0 - success; >= 1 - error
Version
Oyranos: 0.2.1
Since
2011/01/14
Date
2011/01/14
const char * oyStructTypeToText ( oyOBJECT_e  type)

Objects type to small string.

Function oyStructTypeToText

Give a basic description of inbuild object types.

Version
Oyranos: 0.5.0
Since
2008/06/24 (Oyranos: 0.1.8)
Date
2012/09/05

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 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(), oyImage_s::oyImage_Create(), oyImage_s::oyImage_FillArray(), oyObject_GetId(), oyObject_UnRef(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType(), oyPixelAccess_s::oyPixelAccess_GetUserData(), oyPixelAccess_s::oyPixelAccess_SetUserData(), oyStruct_GetText(), oyStruct_GetTextFromModule(), oyObserver_s::oyStruct_ObserverAdd(), and oyStructList_s::oyStructList_CopyFrom().

Field Documentation

oyStruct_Copy_f oyStruct_s::copy
oyObject_s oyStruct_s::oy_
oyStruct_Release_f oyStruct_s::release
const oyOBJECT_e oyStruct_s::type_