Generic Objects

Collaboration diagram for Generic Objects:

Data Structures
struct	oyName_s
	Oyranos Name structure. More...
struct	oyObject_s
	Oyranos structure baseThe base object of Oyranos object system is self contained. It can be handled by the belonging function set. Complex objects for user interaction should almost all be derived from this struct. The memory management can be controlled by the user and will affect internal and derived data. More...
struct	oyObserver_s
	Oyranos object observers. More...
struct	oyPointer_s
	custom pointer More...
struct	oyStruct_s
	Oyranos base structure. More...
struct	oyStructList_s
	a pointer list More...

Enumerations
enum	oyOBJECT_e { ,   oyOBJECT_OBJECT_S, oyOBJECT_MONITOR_S, oyOBJECT_NAMED_COLOUR_S, oyOBJECT_NAMED_COLOURS_S,   oyOBJECT_PROFILE_S, oyOBJECT_PROFILE_TAG_S, oyOBJECT_PROFILES_S, oyOBJECT_OPTION_S,   oyOBJECT_OPTIONS_S, oyOBJECT_RECTANGLE_S, oyOBJECT_IMAGE_S, oyOBJECT_ARRAY2D_S,   oyOBJECT_COLOUR_CONVERSION_S, oyOBJECT_CONNECTOR_S = 20, oyOBJECT_CONNECTOR_IMAGING_S, oyOBJECT_CONNECTOR_MAX_S,   oyOBJECT_FILTER_PLUG_S = 30, oyOBJECT_FILTER_PLUGS_S, oyOBJECT_FILTER_SOCKET_S, oyOBJECT_FILTER_CORE_S,   oyOBJECT_FILTER_CORES_S, oyOBJECT_FILTER_NODE_S, oyOBJECT_FILTER_NODES_S, oyOBJECT_FILTER_GRAPH_S,   oyOBJECT_PIXEL_ACCESS_S, oyOBJECT_CONVERSION_S, oyOBJECT_CMM_HANDLE_S = 50, oyOBJECT_POINTER_S,   oyOBJECT_CMM_INFO_S, oyOBJECT_CMM_API_S, oyOBJECT_CMM_APIS_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_DATA_TYPES_S, oyOBJECT_CMM_API8_S,   oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_FILTERS_S, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_API10_S,   oyOBJECT_CMM_UI_S, oyOBJECT_CMM_OBJECT_TYPE_S, oyOBJECT_CMM_API_MAX, oyOBJECT_ICON_S = 80,   oyOBJECT_MODULE_S, oyOBJECT_EXTERNFUNC_S, oyOBJECT_NAME_S, oyOBJECT_COMP_S_,   oyOBJECT_FILE_LIST_S_, oyOBJECT_HASH_S, oyOBJECT_STRUCT_LIST_S, oyOBJECT_BLOB_S,   oyOBJECT_CONFIG_S, oyOBJECT_CONFIGS_S, oyOBJECT_UI_HANDLER_S, oyOBJECT_FORMS_ARGS_S,   oyOBJECT_CALLBACK_S, oyOBJECT_OBSERVER_S, oyOBJECT_CONF_DOMAIN_S, oyOBJECT_INFO_STATIC_S }
	Oyranos structure type. More...
enum	oySIGNAL_e { ,   oySIGNAL_CONNECTED, oySIGNAL_RELEASED, oySIGNAL_DATA_CHANGED, oySIGNAL_STORAGE_CHANGED,   oySIGNAL_INCOMPATIBLE_DATA, oySIGNAL_INCOMPATIBLE_OPTION, oySIGNAL_INCOMPATIBLE_CONTEXT , oySIGNAL_USER3 }
	observer signalsThe signal types are similiar to the graph event enum oyCONNECTOR_EVENT_e. More...
enum	oyNAME_e { oyNAME_NAME, oyNAME_NICK, oyNAME_DESCRIPTION }
	describe the base types of a oyObject_s name More...

Functions
OYAPI oyCallback_s *OYEXPORT	oyCallback_s::oyCallback_New (oyObject_s object)
	allocate a new Callback object
OYAPI oyCallback_s *OYEXPORT	oyCallback_s::oyCallback_Copy (oyCallback_s *obj, oyObject_s object)
	copy or reference a Callback object
OYAPI int OYEXPORT	oyCallback_s::oyCallback_Release (oyCallback_s **obj)
	release and possibly deallocate a Callback object

Detailed Description

Enumeration Type Documentation

enum oyNAME_e

describe the base types of a oyObject_s name

Version

Oyranos: 0.1.8

Since

2007/10/00 (Oyranos: 0.1.8)

Date

2007/10/00

Enumerator:

oyNAME_NAME	compatible to oyName_s/oyObject_s
oyNAME_NICK	compatible to oyName_s/oyObject_s
oyNAME_DESCRIPTION	compatible to oyName_s/oyObject_s

enum oyOBJECT_e

Oyranos structure type.

Version

Oyranos: 0.1.8

Since

2007/11/22 (Oyranos: 0.1.x)

Date

2008/07/31

Enumerator:

oyOBJECT_OBJECT_S	oyObject_s
oyOBJECT_MONITOR_S	oyMonitor_s
oyOBJECT_NAMED_COLOUR_S	oyNamedColour_s
oyOBJECT_NAMED_COLOURS_S	oyNamedColours_s
oyOBJECT_PROFILE_S	oyProfile_s
oyOBJECT_PROFILE_TAG_S	oyProfileTag_s
oyOBJECT_PROFILES_S	oyProfiles_s
oyOBJECT_OPTION_S	oyOption_s
oyOBJECT_OPTIONS_S	oyOptions_s
oyOBJECT_RECTANGLE_S	oyRectangle_s
oyOBJECT_IMAGE_S	oyImage_s
oyOBJECT_ARRAY2D_S	oyArray2d_s
oyOBJECT_COLOUR_CONVERSION_S	oyColourConversion_s deprecated
oyOBJECT_CONNECTOR_S	oyConnector_s
oyOBJECT_CONNECTOR_IMAGING_S	oyConnectorImaging_s
oyOBJECT_CONNECTOR_MAX_S	not defined
oyOBJECT_FILTER_PLUG_S	oyFilterPlug_s
oyOBJECT_FILTER_PLUGS_S	oyFilterPlugs_s
oyOBJECT_FILTER_SOCKET_S	oyFilterSocket_s
oyOBJECT_FILTER_CORE_S	oyFilterCore_s
oyOBJECT_FILTER_CORES_S	oyFilterCores_s
oyOBJECT_FILTER_NODE_S	oyFilterNode_s
oyOBJECT_FILTER_NODES_S	oyFilterNodes_s
oyOBJECT_FILTER_GRAPH_S	oyFilterGraph_s
oyOBJECT_PIXEL_ACCESS_S	oyPixelAccess_s
oyOBJECT_CONVERSION_S	oyConversion_s
oyOBJECT_CMM_HANDLE_S	oyCMMhandle_s
oyOBJECT_POINTER_S	oyPointer_s
oyOBJECT_CMM_INFO_S	oyCMMinfo_s
oyOBJECT_CMM_API_S	oyCMMapi_s
oyOBJECT_CMM_APIS_S	oyCMMapis_s
oyOBJECT_CMM_API1_S	oyCMMapi1_s
oyOBJECT_CMM_API2_S	oyCMMapi2_s
oyOBJECT_CMM_API3_S	oyCMMapi3_s
oyOBJECT_CMM_API4_S	oyCMMapi4_s
oyOBJECT_CMM_API5_S	oyCMMapi5_s
oyOBJECT_CMM_API6_S	oyCMMapi6_s
oyOBJECT_CMM_API7_S	oyCMMapi7_s
oyOBJECT_CMM_DATA_TYPES_S	oyCMMDataTypes_s
oyOBJECT_CMM_API8_S	oyCMMapi8_s
oyOBJECT_CMM_API_FILTER_S	oyCMMapiFilter_s
oyOBJECT_CMM_API_FILTERS_S	oyCMMapiFilters_s
oyOBJECT_CMM_API9_S	oyCMMapi9_s
oyOBJECT_CMM_API10_S	oyCMMapi10_s
oyOBJECT_CMM_UI_S	oyCMMui_s
oyOBJECT_CMM_OBJECT_TYPE_S	oyCMMobjectType_s
oyOBJECT_CMM_API_MAX	not defined
oyOBJECT_ICON_S	oyIcon_s
oyOBJECT_MODULE_S	oyModule_s
oyOBJECT_EXTERNFUNC_S	oyExternFunc_s
oyOBJECT_NAME_S	oyName_s
oyOBJECT_COMP_S_	oyComp_s_
oyOBJECT_FILE_LIST_S_	oyFileList_s_
oyOBJECT_HASH_S	oyHash_s
oyOBJECT_STRUCT_LIST_S	oyStructList_s
oyOBJECT_BLOB_S	oyBlob_s
oyOBJECT_CONFIG_S	oyConfig_s
oyOBJECT_CONFIGS_S	oyConfigs_s
oyOBJECT_UI_HANDLER_S	oyUiHandler_s
oyOBJECT_FORMS_ARGS_S	oyFormsArgs_s
oyOBJECT_CALLBACK_S	oyCallback_s
oyOBJECT_OBSERVER_S	oyObserver_s
oyOBJECT_CONF_DOMAIN_S	oyConfDomain_s
oyOBJECT_INFO_STATIC_S	oyObjectInfoStatic_s

enum oySIGNAL_e

observer signalsThe signal types are similiar to the graph event enum oyCONNECTOR_EVENT_e.

Version

Oyranos: 0.1.10

Since

2009/10/26 (Oyranos: 0.1.10)

Date

2009/10/26

Enumerator:

oySIGNAL_CONNECTED	connection established
oySIGNAL_RELEASED	released the connection
oySIGNAL_DATA_CHANGED	call to update image views
oySIGNAL_STORAGE_CHANGED	new data accessors
oySIGNAL_INCOMPATIBLE_DATA	can not process image
oySIGNAL_INCOMPATIBLE_OPTION	can not handle option
oySIGNAL_INCOMPATIBLE_CONTEXT	can not handle profile
oySIGNAL_USER3	more signal types are possible

Function Documentation

OYAPI oyCallback_s *OYEXPORT oyCallback_Copy	(	oyCallback_s *	obj,
		oyObject_s	object
	)

copy or reference a Callback object

Function oyCallback_Copy

Parameters

[in]	obj	struct object
	object	the optional object

Version

Oyranos: 0.1.10

Since

2009/11/18 (Oyranos: 0.1.10)

Date

2009/11/18

References oyCallback_s::oy_, oyOBJECT_CALLBACK_S, and oyObject_s::oyObject_Copy().

Referenced by oyCallback_s::oyCallback_New().

OYAPI oyCallback_s *OYEXPORT oyCallback_New

(

oyObject_s

object

)

allocate a new Callback object

Function oyCallback_New

Version

Oyranos: 0.1.10

Since

2009/11/18 (Oyranos: 0.1.10)

Date

2009/11/18

References oyCallback_s::oyCallback_Copy(), oyCallback_s::oyCallback_Release(), oyOBJECT_CALLBACK_S, oyObject_s::oyObject_NewFrom(), oyObject_s::oyObject_SetParent(), and oyCallback_s::release.

OYAPI int OYEXPORT oyCallback_Release

(

oyCallback_s **

obj

)

release and possibly deallocate a Callback object

Function oyCallback_Release

Parameters

[in,out]

obj

struct object

Version

Oyranos: 0.1.10

Since

2009/11/18 (Oyranos: 0.1.10)

Date

2009/11/18

References oyCallback_s::oy_, oyOBJECT_CALLBACK_S, oyObject_s::oyObject_Release(), and oyObject_s::oyObject_UnRef().

Referenced by oyCallback_s::oyCallback_New().