oyOptions_s Struct Reference
[Values Handling]

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. 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_soyOptions_New (oyObject_s object)
 new options
oyOptions_soyOptions_FromBoolean (oyOptions_s *set_a, oyOptions_s *set_b, oyBOOLEAN_e type, oyObject_s object)
 boolean operations on two sets of option
oyOptions_soyOptions_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_soyOptions_ForFilter_ (oyFilter_s *filter, uint32_t flags, oyObject_s object)
 provide Oyranos behaviour settings
oyOptions_soyOptions_ForFilter (const char *registration, const char *cmm, uint32_t flags, oyObject_s object)
 provide Oyranos behaviour settings
oyOptions_soyOptions_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_soyOptions_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


Detailed Description

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.

Version:
Oyranos: 0.1.8
Since:
2008/06/26 (Oyranos: 0.1.8)
Date:
2008/06/26

Field Documentation

oyStruct_Copy_f oyOptions_s::copy

copy function

oyStructList_s* oyOptions_s::list

oyStruct_Release_f oyOptions_s::release

release function

Referenced by oyOptions_New().


Generated on Tue Mar 10 09:46:43 2009 for Oyranos by  doxygen 1.5.8