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

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

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

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)

◆ 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)

Referenced by oyOption_s::oyOption_GetText().

◆ oyStruct_GetTextFromModule()

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

◆ oyStruct_RegisterStaticMessageFunc()

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

◆ oyStructTypeToText()

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

Referenced by oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), and oyObject_UnRef().

Field Documentation

◆ copy

oyStruct_Copy_f oyStruct_s::copy

◆ oy_

oyObject_s oyStruct_s::oy_

◆ release

oyStruct_Release_f oyStruct_s::release

◆ type_

const oyOBJECT_e oyStruct_s::type_