![]() |
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 |
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 |
|
Referenced by oyOption_s::oyOption_GetText().
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 |
oyStruct_RegisterStaticMessageFunc |
register a function for verbosity
[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.
Referenced by oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), and oyObject_UnRef().
oyStruct_Copy_f oyStruct_s::copy |
Copy function.
Referenced by oyFilterNode_s::oyFilterNode_GetData(), oyFilterNode_s::oyFilterNode_SetData(), oyFilterSocket_s::oyFilterSocket_SetData(), oyOption_s::oyOption_GetStruct(), oyOptions_s::oyOptions_GetType(), oyPixelAccess_s::oyPixelAccess_SetUserData(), and oyStructList_s::oyStructList_CopyFrom().
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(), oyPointer_s::oyPointer_LookUpFromObject(), oyStruct_Allocate(), oyObserver_s::oyStruct_DisableSignalSend(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_IsObserved(), and oyStructList_s::oyStructList_GetRefType().
oyStruct_Release_f oyStruct_s::release |
Release function.
Referenced by oyObserver_s::oyObserver_Release(), oyStructList_s::oyStructList_GetRefType(), and oyValue_u::oyValueClear().
const oyOBJECT_e oyStruct_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.
Referenced by oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetType(), and oyValue_u::oyValueEqual().