![]() |
Oyranos Color Management System API |
A filter connection description structure. More...
#include <oyConnector_s.h>
Public Member Functions | |
OYAPI oyConnector_s *OYEXPORT | oyConnector_New (oyObject_s object) |
allocate a new Connector object More... | |
OYAPI oyConnector_s *OYEXPORT | oyConnector_Copy (oyConnector_s *connector, oyObject_s object) |
copy or reference a Connector object More... | |
OYAPI int OYEXPORT | oyConnector_Release (oyConnector_s **connector) |
release and possibly deallocate a oyConnector_s object More... | |
OYAPI int OYEXPORT | oyConnector_SetTexts (oyConnector_s *obj, oyCMMGetText_f getText, const char **text_classes) |
set the texts in a connector More... | |
OYAPI const char **OYEXPORT | oyConnector_GetTexts (oyConnector_s *obj) |
get the text classes in a connector More... | |
OYAPI const char *OYEXPORT | oyConnector_GetText (oyConnector_s *obj, const char *name_class, oyNAME_e type) |
get the names in a connector More... | |
int | oyConnector_IsPlug (oyConnector_s *obj) |
Is this connector a plug or a socket. More... | |
int | oyConnector_SetIsPlug (oyConnector_s *obj, int is_plug) |
Set this connector as a plug or a socket. More... | |
const char * | oyConnector_GetReg (oyConnector_s *obj) |
Get the registration for the connection type. More... | |
int | oyConnector_SetReg (oyConnector_s *obj, const char *type_registration) |
Set this connectors type string. More... | |
int | oyConnector_SetMatch (oyConnector_s *obj, oyCMMFilterSocket_MatchPlug_f func) |
Set this connectors type check function. More... | |
oyCMMFilterSocket_MatchPlug_f | oyConnector_GetMatch (oyConnector_s *obj) |
Set this connectors type check function. More... | |
![]() | |
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... | |
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... | |
![]() | |
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... | |
A filter connection description structure.
This structure holds informations about the connection capabilities. It holds common structure members of oyFilterPlug_s and oyFilterSocket_s.
To signal a value is not initialised or does not apply, set the according integer value to -1.
OYAPI oyConnector_s *OYEXPORT oyConnector_Copy | ( | oyConnector_s * | connector, |
oyObject_s | object | ||
) |
copy or reference a Connector object
Function oyConnector_Copy
The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.
[in] | connector | Connector struct object |
object | NULL - means reference, the optional object triggers a real copy |
Referenced by oyFilterPlug_s::oyFilterPlug_GetPattern(), and oyFilterPlug_s::oyFilterSocket_GetPattern().
oyCMMFilterSocket_MatchPlug_f oyConnector_GetMatch | ( | oyConnector_s * | obj | ) |
Set this connectors type check function.
Function oyConnector_GetMatch
This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.
[in] | obj | Connector object |
Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch().
const char * oyConnector_GetReg | ( | oyConnector_s * | obj | ) |
Get the registration for the connection type.
Function oyConnector_GetReg
This is use as a rough check, if connections are possible.
[in] | obj | Connector object |
Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch(), and oyFilterNode_s::oyFilterNode_GetConnectorPos().
OYAPI const char *OYEXPORT oyConnector_GetText | ( | oyConnector_s * | obj, |
const char * | name_class, | ||
oyNAME_e | type | ||
) |
get the names in a connector
Function oyConnector_GetText
Get UI strings.
[in] | obj | Connector object |
[in] | name_class | the names class, e.g. "name", "help" ... |
[in] | type | the names type |
OYAPI const char **OYEXPORT oyConnector_GetTexts | ( | oyConnector_s * | obj | ) |
get the text classes in a connector
Function oyConnector_GetTexts
Set UI strings.
[in] | obj | Connector object |
int oyConnector_IsPlug | ( | oyConnector_s * | obj | ) |
Is this connector a plug or a socket.
Function oyConnector_IsPlug
[in] | obj | Connector object |
OYAPI oyConnector_s *OYEXPORT oyConnector_New | ( | oyObject_s | object | ) |
OYAPI int OYEXPORT oyConnector_Release | ( | oyConnector_s ** | connector | ) |
release and possibly deallocate a oyConnector_s object
Function oyConnector_Release
[in,out] | connector | Connector struct object |
Referenced by oyFilterNode_s::oyFilterNode_ConnectorMatch().
int oyConnector_SetIsPlug | ( | oyConnector_s * | obj, |
int | is_plug | ||
) |
Set this connector as a plug or a socket.
Function oyConnector_SetIsPlug
[in,out] | obj | Connector object |
[in] | is_plug | boolean; 0 - socket; 1 - plug |
int oyConnector_SetMatch | ( | oyConnector_s * | obj, |
oyCMMFilterSocket_MatchPlug_f | func | ||
) |
Set this connectors type check function.
Function oyConnector_SetMatch
This is use as a check, if connections are possible. This allowes for a more fine grained control than the type registration.
[in,out] | obj | Connector object |
[in] | func | the check function |
int oyConnector_SetReg | ( | oyConnector_s * | obj, |
const char * | type_registration | ||
) |
Set this connectors type string.
Function oyConnector_SetReg
This is use as a rough check, if connections are possible.
[in,out] | obj | Connector object |
[in] | type_registration | the registration string to describe the type |
OYAPI int OYEXPORT oyConnector_SetTexts | ( | oyConnector_s * | obj, |
oyCMMGetText_f | getText, | ||
const char ** | text_classes | ||
) |
set the texts in a connector
Function oyConnector_SetTexts
Set UI strings.
[in] | obj | Connector object |
[in] | getText | the name function |
[in] | text_classes | zero terminated list of classes, e.g. {"name",NULL} owned by the user, but has to live the lifetime of the object |
oyStruct_Copy_f oyConnector_s::copy |
Copy function.
oyObject_s oyConnector_s::oy_ |
Oyranos internal object.
Features name and hash. Do not change during object life time.
oyStruct_Release_f oyConnector_s::release |
Release function.
const oyOBJECT_e oyConnector_s::type_ |
Type of object.
The struct type tells Oyranos how to interprete hidden fields.