generic OptionsOptions can be any flag or rendering intent and other informations needed to configure a process. The object contains a list of oyOption_s objects. More...
#include <oyranos_alpha.h>
Data Fields | |
oyOBJECT_e | type_ |
oyStruct_Copy_f | copy |
oyStruct_Release_f | release |
oyObject_s | oy_ |
oyStructList_s * | list |
Related Functions | |
(Note that these are not member functions.) | |
oyOptions_s * | oyOptions_New (oyObject_s object) |
new options | |
oyOptions_s * | oyOptions_FromBoolean (oyOptions_s *set_a, oyOptions_s *set_b, oyBOOLEAN_e type, oyObject_s object) |
boolean operations on two sets of option | |
oyOptions_s * | oyOptions_FromText (const char *text, uint32_t flags, oyObject_s object) |
deserialise a text file to oyOptions_s data | |
int | oyOptions_DoFilter (oyOptions_s *s, uint32_t flags, const char *filter_type) |
filter the options | |
oyOptions_s * | oyOptions_ForFilter_ (oyFilter_s *filter, uint32_t flags, oyObject_s object) |
provide Oyranos behaviour settings | |
oyOptions_s * | oyOptions_ForFilter (const char *registration, const char *cmm, uint32_t flags, oyObject_s object) |
provide Oyranos behaviour settings | |
oyOptions_s * | oyOptions_Copy (oyOptions_s *obj, oyObject_s object) |
release options | |
int | oyOptions_Release (oyOptions_s **obj) |
release options | |
OYAPI int OYEXPORT | oyOptions_MoveIn (oyOptions_s *list, oyOption_s **obj, int pos) |
add a element to a Options list | |
OYAPI int OYEXPORT | oyOptions_ReleaseAt (oyOptions_s *list, int pos) |
release a element from a Options list | |
OYAPI oyOption_s *OYEXPORT | oyOptions_Get (oyOptions_s *list, int pos) |
get a element of a Options list | |
int | oyOptions_Add (oyOptions_s *options, oyOption_s *option, int pos, oyObject_s object) |
add a element to a Options list | |
const char * | oyOptions_GetText (oyOptions_s *options, oyNAME_e type) |
dump options to text | |
oyOption_s * | oyOptions_Find (oyOptions_s *options, const char *key) |
search for a certain option key | |
const char * | oyOptions_FindString (oyOptions_s *options, const char *key, const char *value) |
search for a certain option key and possibly value | |
int | oyOptions_SetFromText (oyOptions_s *obj, const char *key, const char *value) |
change a value |
generic Options
Options can be any flag or rendering intent and other informations needed to configure a process. The object contains a list of oyOption_s objects.
oyStruct_Copy_f oyOptions_s::copy |
copy function
oyStructList_s* oyOptions_s::list |
the list data
Referenced by oyOptions_DoFilter(), oyOptions_Get(), oyOptions_MoveIn(), oyOptions_Release(), and oyOptions_ReleaseAt().
base object
Referenced by oyOptions_Copy(), oyOptions_DoFilter(), oyOptions_GetText(), and oyOptions_Release().
oyStruct_Release_f oyOptions_s::release |
release function
Referenced by oyOptions_New().
struct type oyOBJECT_OPTIONS_S
Referenced by oyOptions_Copy(), oyOptions_Find(), oyOptions_FindString(), oyOptions_Get(), oyOptions_MoveIn(), oyOptions_Release(), oyOptions_ReleaseAt(), and oyOptions_SetFromText().