![]() |
Oyranos
0.9.7
Oyranos is a full featured Color Management System
|
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... | |
int | oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f f) |
register a function for verbosity More... | |
const char * | oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags) |
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.
const char * oyStruct_GetInfo | ( | oyPointer | context_object, |
oyNAME_e | type, | ||
int | flags | ||
) |
get a additional string from a object
Function oyStruct_GetInfo
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 |
|
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 |
int oyStruct_RegisterStaticMessageFunc | ( | int | type, |
oyStruct_RegisterStaticMessageFunc_f | f | ||
) |
register a function for verbosity
Function oyStruct_RegisterStaticMessageFunc
[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 lrawCMMWarnFunc(), and oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket().
oyStruct_Copy_f oyStruct_s::copy |
oyObject_s oyStruct_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
Referenced by lrawCMMWarnFunc(), oyContextCollectData_(), oyPointer_s::oyPointer_LookUpFromObject(), 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 lrawCMMWarnFunc(), oyProfiles_s::oiccProfilesGetText(), oyStruct_CheckType(), oyStruct_GetAllocator(), oyStruct_GetDeAllocator(), oyStructList_s::oyStructList_GetRefType(), oyStructList_s::oyStructList_GetType(), and oyValue_u::oyValueEqual().