Oyranos Colour Management System API
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | Data Fields
oyOptions_s Struct Reference

generic Options More...

#include <oyOptions_s.h>

Inheritance diagram for oyOptions_s:
Inheritance graph
Collaboration diagram for oyOptions_s:
Collaboration graph

Public Member Functions

OYAPI oyOptions_s *OYEXPORT oyOptions_New (oyObject_s object)
 allocate a new Options object More...
 
OYAPI oyOptions_s *OYEXPORT oyOptions_Copy (oyOptions_s *options, oyObject_s object)
 copy or reference a Options object More...
 
OYAPI int OYEXPORT oyOptions_Release (oyOptions_s **options)
 release and possibly deallocate a oyOptions_s object More...
 
OYAPI int OYEXPORT oyOptions_MoveIn (oyOptions_s *list, oyOption_s **obj, int pos)
 add an element to a Options list More...
 
OYAPI int OYEXPORT oyOptions_ReleaseAt (oyOptions_s *list, int pos)
 release a element from a Options list More...
 
OYAPI oyOption_s *OYEXPORT oyOptions_Get (oyOptions_s *list, int pos)
 get a element of a Options list More...
 
OYAPI int OYEXPORT oyOptions_Count (oyOptions_s *list)
 count the elements in a Options list More...
 
OYAPI int OYEXPORT oyOptions_Clear (oyOptions_s *list)
 clear the elements in a Options list More...
 
OYAPI int OYEXPORT oyOptions_Sort (oyOptions_s *list, int32_t *rank_list)
 sort a list according to a rank_list More...
 
oyOptions_soyOptions_FromBoolean (oyOptions_s *set_a, oyOptions_s *set_b, oyBOOLEAN_e type, oyObject_s object)
 boolean operations on two sets of option More...
 
oyOptions_soyOptions_FromText (const char *text, uint32_t flags, oyObject_s object)
 deserialise a text file to oyOptions_s data More...
 
int oyOptions_Add (oyOptions_s *options, oyOption_s *option, int pos, oyObject_s object)
 add a element to a Options list More...
 
int oyOptions_Set (oyOptions_s *options, oyOption_s *option, int pos, oyObject_s object)
 set a element in a Options list More...
 
int oyOptions_SetOpts (oyOptions_s *list, oyOptions_s *add)
 set options in a Options list More...
 
int oyOptions_AppendOpts (oyOptions_s *list, oyOptions_s *append)
 Basic reference options from one list into an other. More...
 
int oyOptions_CopyFrom (oyOptions_s **list, oyOptions_s *from, oyBOOLEAN_e type, oyFILTER_REG_e fields, oyObject_s object)
 copy from one option set to an other option set More...
 
int oyOptions_Filter (oyOptions_s **add_list, int32_t *count, uint32_t flags, oyBOOLEAN_e type, const char *registration, oyOptions_s *src_list)
 filter options More...
 
const char * oyOptions_GetText (oyOptions_s *options, oyNAME_e type)
 dump options to text More...
 
int oyOptions_CountType (oyOptions_s *options, const char *registration, oyOBJECT_e type)
 search for options with special attributes More...
 
oyOption_soyOptions_Find (oyOptions_s *options, const char *registration)
 search for a certain option key More...
 
const char * oyOptions_FindString (oyOptions_s *options, const char *registration, const char *value)
 search for a certain option key and possibly value More...
 
int oyOptions_SetFromText (oyOptions_s **obj, const char *registration, const char *value, uint32_t flags)
 change a value More...
 
int oyOptions_FindInt (oyOptions_s *options, const char *registration, int pos, int32_t *result)
 get a value More...
 
int oyOptions_SetFromInt (oyOptions_s **obj, const char *registration, int32_t value, int pos, uint32_t flags)
 change a value More...
 
int oyOptions_FindDouble (oyOptions_s *options, const char *registration, int pos, double *result)
 get a value More...
 
int oyOptions_SetFromDouble (oyOptions_s **obj, const char *registration, double value, int pos, uint32_t flags)
 change a value More...
 
oyStruct_soyOptions_GetType (oyOptions_s *options, int pos, const char *registration, oyOBJECT_e type)
 select from options with special attribute More...
 
int oyOptions_MoveInStruct (oyOptions_s **obj, const char *registration, oyStruct_s **oy_struct, uint32_t flags)
 change a value More...
 
int oyOptions_SetFromData (oyOptions_s **options, const char *registration, oyPointer ptr, size_t size, uint32_t flags)
 set a data blob or plain pointer More...
 
int oyOptions_FindData (oyOptions_s *options, const char *registration, oyPointer *result, size_t *size, oyAlloc_f allocateFunc)
 get a value More...
 
int oyOptions_SetSource (oyOptions_s *options, oyOPTIONSOURCE_e source)
 set source attribute More...
 
OYAPI int OYEXPORT oyOptions_ObserverAdd (oyOptions_s *object, oyStruct_s *observer, oyStruct_s *user_data, oyObserver_Signal_f signalFunc)
 observe options and its elements More...
 
OYAPI int OYEXPORT oyOptions_ObserversDisable (oyOptions_s *object)
 disable signaling More...
 
OYAPI int OYEXPORT oyOptions_ObserversEnable (oyOptions_s *object)
 disable signaling More...
 
OYAPI int OYEXPORT oyOptions_SetDriverContext (oyOptions_s **options, oyPointer driver_context, const char *driver_context_type, size_t driver_context_size, oyObject_s object)
 set a device option from a given external context More...
 
void oyOptions_Release__Members (oyOptions_s_ *options)
 Custom Options destructor. More...
 
int oyOptions_Init__Members (oyOptions_s_ *options)
 Custom Options constructor. More...
 
int oyOptions_Copy__Members (oyOptions_s_ *dst, oyOptions_s_ *src)
 Custom Options copy constructor. More...
 
- Public Member Functions inherited from oyStruct_s
const char * oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
 get a text dump More...
 

Data Fields

oyStruct_Copy_f copy
 
oyStruct_Release_f release
 
- Data Fields inherited from oyStruct_s
oyStruct_Copy_f copy
 
oyStruct_Release_f release
 

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.

Note
This class holds a list of objects [list]
Version
Oyranos: x.x.x
Since
YYYY/MM/DD (Oyranos: x.x.x)
Date
YYYY/MM/DD

Member Function Documentation

int oyOptions_Add ( oyOptions_s options,
oyOption_s option,
int  pos,
oyObject_s  object 
)

add a element to a Options list

Function oyOptions_Add

We must not add any already listed option. (oyFILTER_REG_TOP)

Adding a new element without any checks is as simple as following code:

*     tmp = oyOption_Copy( option, object );
*     oyOptions_MoveIn( options, &tmp, -1 ); 
Version
Oyranos: 0.1.9
Since
2008/11/17 (Oyranos: 0.1.9)
Date
2010/11/27

References oyFILTER_REG_TOP, oyOption_s::oyOption_Copy(), oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyOptions_MoveIn().

Referenced by oyConfigs_s::oyConfigs_FromDB(), oyOptions_Filter(), and oyOptions_FromBoolean().

int oyOptions_AppendOpts ( oyOptions_s list,
oyOptions_s append 
)

Basic reference options from one list into an other.

Function oyOptions_AppendOpts

See Also
oyOptions_MoveIn
Version
Oyranos:
Since
Date

References oyOptions_Count(), oyOptions_Get(), and oyOptions_MoveIn().

Referenced by oyConfig_s::oyConfig_Count(), oyConfig_s::oyConfig_Get(), and oyConfig_s::oyConfig_SaveToDB().

OYAPI int OYEXPORT oyOptions_Clear ( oyOptions_s list)

clear the elements in a Options list

Function oyOptions_Clear

Parameters
[in,out]listthe list
Returns
0 - success; otherwise - error
Version
Oyranos: 0.3.0
Since
2011/02/01 (Oyranos: 0.3.0)
Date
2011/02/01

References oyOBJECT_OPTIONS_S, and oyStructList_s::oyStructList_Clear().

Referenced by oyConfig_s::oyConfig_GetOptions(), and oyProfiles_s::oyProfiles_DeviceRank().

OYAPI oyOptions_s *OYEXPORT oyOptions_Copy ( oyOptions_s options,
oyObject_s  object 
)

copy or reference a Options object

Function oyOptions_Copy

The function is for copying and for referencing. The reference is the most often used way, which saves resourcs and time.

Parameters
[in]optionsOptions struct object
objectNULL - means reference, the optional object triggers a real copy

References oyOBJECT_OPTIONS_S.

Referenced by oyConfig_s::oyConfig_GetFromDB(), oyConfigs_s::oyConfigs_FromDeviceClass(), oyFilterCore_s::oyFilterCore_Copy__Members(), oyFilterCore_s::oyFilterCore_NewWith(), oyFilterGraph_s::oyFilterGraph_Copy__Members(), oyFilterGraph_s::oyFilterGraph_GetOptions(), oyFilterNode_s::oyFilterNode_GetTags(), oyImage_s::oyImage_GetTags(), oyImage_s::oyImage_SetCritical(), oyOptions_FromBoolean(), and oyPixelAccess_s::oyPixelAccess_GetRequestQueue().

int oyOptions_Copy__Members ( oyOptions_s_ *  dst,
oyOptions_s_ *  src 
)

Custom Options copy constructor.

Function oyOptions_Copy__Members

int oyOptions_CopyFrom ( oyOptions_s **  list,
oyOptions_s from,
oyBOOLEAN_e  type,
oyFILTER_REG_e  fields,
oyObject_s  object 
)

copy from one option set to an other option set

Function oyOptions_CopyFrom

Parameters
[out]listtarget
[in]fromsource
typeboolean operation before copy
fieldsregistration fields of each option
objectthe optional object
Returns
0 - success; 1 - error; -1 issue
Version
Oyranos: 0.1.10
Since
2009/05/05 (Oyranos: 0.1.10)
Date
2009/10/25

References oyBOOLEAN_DIFFERENZ, oyBOOLEAN_INTERSECTION, oyBOOLEAN_SUBSTRACTION, oyBOOLEAN_UNION, oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), oyOptions_MoveIn(), oyOptions_New(), oyOptions_Release(), oyOptions_SetOpts(), oyStructList_s::oyStructList_New(), and oyStructList_s::oyStructList_Release().

Referenced by oyImage_ToFile().

OYAPI int OYEXPORT oyOptions_Count ( oyOptions_s list)
int oyOptions_CountType ( oyOptions_s options,
const char *  registration,
oyOBJECT_e  type 
)

search for options with special attributes

Function oyOptions_CountType

Version
Oyranos: 0.1.10
Since
2009/03/04 (Oyranos: 0.1.10)
Date
2009/03/04

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyVAL_STRUCT.

int oyOptions_Filter ( oyOptions_s **  add_list,
int32_t *  count,
uint32_t  flags,
oyBOOLEAN_e  type,
const char *  registration,
oyOptions_s src_list 
)

filter options

Function oyOptions_Filter

Each option added to the add_list is a cheaply linked one.

See Also
oyOptions_Add
Parameters
[out]add_listthe options list to add to
[out]countthe number of matching options
[in]flagsfor inbuild defaults | oyOPTIONSOURCE_FILTER
[in]typesupport are oyBOOLEAN_INTERSECTION and oyBOOLEAN_DIFFERENZ
[in]registrationa registration which shall be matched
[in]src_listthe options to select from
Returns
0 - success; 1 - error
Version
Oyranos: 0.1.10
Since
2009/05/05 (Oyranos: 0.1.10)
Date
2009/05/05

References oyBOOLEAN_DIFFERENZ, oyBOOLEAN_INTERSECTION, oyBOOLEAN_UNION, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), oyOptions_Add(), oyOptions_Count(), oyOptions_Get(), oyOptions_New(), oyOPTIONSOURCE_DATA, oyOPTIONSOURCE_FILTER, and oyOPTIONSOURCE_USER.

Referenced by oyPixelAccess_s::oyPixelAccess_Create().

oyOption_s * oyOptions_Find ( oyOptions_s options,
const char *  registration 
)

search for a certain option key

Function oyOptions_Find

This function returns the first found option for a given key. The key is represented by a registrations option level.

Parameters
optionsset of options
registrationregistration or key
Returns
a matching options
Version
Oyranos: 0.1.9
Since
2008/11/05 (Oyranos: 0.1.9)
Date
2009/04/13

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), oyOptions_Count(), and oyOptions_Get().

Referenced by oyConfig_s::oyConfig_Find(), oyConfig_s::oyConfig_Has(), oyFilterGraph_s::oyFilterGraph_PrepareContexts(), oyOptions_FindData(), oyOptions_FindDouble(), oyOptions_FindInt(), oyOptions_FindString(), oyOptions_MoveInStruct(), oyOptions_SetFromData(), oyOptions_SetFromDouble(), oyOptions_SetFromInt(), oyOptions_SetFromText(), oyObserver_s::oyStruct_DisableSignalSend(), oyObserver_s::oyStruct_EnableSignalSend(), oyObserver_s::oyStruct_ObserverListGet_(), and oyObserver_s::oyStruct_ObserverSignal().

int oyOptions_FindData ( oyOptions_s options,
const char *  registration,
oyPointer *  result,
size_t *  size,
oyAlloc_f  allocateFunc 
)

get a value

Function oyOptions_FindData

Parameters
optionsthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt" or simply a key, e.g. "my_opt"
[out]resultthe data; With size == zero, the pointer is static and owned somewhere else. With size set, the pointer is owned my
  • the caller.
[out]sizethe data size
[in]allocateFuncuser allocator
Returns
0 - option exists, is of correct type, holds a value; -1 - not found; 1 - error
Version
Oyranos: 0.1.10
Since
2009/11/07 (Oyranos: 0.1.10)
Date
2009/11/07

References oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_GetData(), oyOption_s::oyOption_Release(), oyOptions_Find(), and oyVAL_STRUCT.

int oyOptions_FindDouble ( oyOptions_s options,
const char *  registration,
int  pos,
double *  result 
)

get a value

Function oyOptions_FindDouble

Parameters
optionsthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt" or simple key, e.g. "my_opt"
resultthe double
posthe value position
Returns
0 - option exists, is of correct type, holds a value at the position; -1 - not found; 1 - error
Version
Oyranos: 0.1.10
Since
2009/05/04 (Oyranos: 0.1.10)
Date
2009/09/10

References oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_GetValueDouble(), oyOption_s::oyOption_Release(), oyOptions_Find(), and oyVAL_DOUBLE.

int oyOptions_FindInt ( oyOptions_s options,
const char *  registration,
int  pos,
int32_t *  result 
)

get a value

Function oyOptions_FindInt

Parameters
optionsthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt" or simple key, e.g. "my_opt"
posthe values position in a possible list
resultthe integer
Returns
0 - option exists, is of correct type, holds a value at the position; -1 - not found; 1 - error
Version
Oyranos: 0.1.10
Since
2009/05/04 (Oyranos: 0.1.10)
Date
2009/05/04

References oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_GetValueInt(), oyOption_s::oyOption_Release(), and oyOptions_Find().

const char * oyOptions_FindString ( oyOptions_s options,
const char *  registration,
const char *  value 
)

search for a certain option key and possibly value

Function oyOptions_FindString

This function returns the first found value for a given key. The key is represented by the oyOption_s::name::nick The returned string is valid along the livetime of the particular option value.

Version
Oyranos: 0.1.9
Since
2008/10/07 (Oyranos: 0.1.8)
Date
2009/04/13

References oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), and oyOptions_Find().

Referenced by oyConfig_s::oyConfig_FindString(), oyConfigs_s::oyConfigs_FromDeviceClass(), oyConversion_s::oyConversion_RunPixels(), oyFilterGraph_s::oyFilterGraph_CountNodes(), oyFilterGraph_s::oyFilterGraph_GetNode(), oyObject_s::oyObject_GetName(), oyProfile_s::oyProfile_AddDevice(), oyProfile_FromTaxiDB(), oyProfile_s::oyProfile_GetFileName(), and oyProfile_Install().

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

Function oyOptions_FromBoolean

See Also
oyOptions_Add
Parameters
[in]set_aoptions set A
[in]set_boptions set B
[in]typethe operation to perform
objectthe optional object
Version
Oyranos: 0.1.8
Since
2008/06/28 (Oyranos: 0.1.8)
Date
2008/06/28

References oyBOOLEAN_DIFFERENZ, oyBOOLEAN_UNION, oyFILTER_REG_OPTION, oyOption_s::oyOption_Release(), oyOptions_Add(), oyOptions_Copy(), oyOptions_Count(), oyOptions_Get(), and oyOptions_New().

oyOptions_s * oyOptions_FromText ( const char *  text,
uint32_t  flags,
oyObject_s  object 
)

deserialise a text file to oyOptions_s data

Function oyOptions_FromText

This function is based on libxml2.

Parameters
[in]textthe text to process
[in]flagsfor future use
objectthe optional object
Returns
the data
Version
Oyranos: 0.1.9
Since
2008/11/17 (Oyranos: 0.1.9)
Date
2008/11/17

References oyOptions_New().

Referenced by oyOptions_SetDriverContext().

OYAPI oyOption_s *OYEXPORT oyOptions_Get ( oyOptions_s list,
int  pos 
)
const char * oyOptions_GetText ( oyOptions_s options,
oyNAME_e  type 
)

dump options to text

Function oyOptions_GetText

The type argument should select the following string in return:

  • oyNAME_NAME - a readable XFORMS data model
  • oyNAME_NICK - the hash ID
  • oyNAME_DESCRIPTION - option registration name with key and without value
Todo:
streamline output and group, avoid writing all levels for each key
Parameters
[in,out]optionsthe option
typeoyNAME_NICK is equal to an ID
Returns
the text
Version
Oyranos: 0.3.3
Since
2008/11/25 (Oyranos: 0.1.9)
Date
2011/10/31

References oyNAME_DESCRIPTION, oyNAME_NAME, oyObject_s::oyObject_GetName(), oyObject_s::oyObject_SetName(), oyOption_s::oyOption_GetText(), oyOption_s::oyOption_GetValueText(), oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyVAL_STRUCT.

Referenced by oyOption_s::oyOption_GetText().

oyStruct_s * oyOptions_GetType ( oyOptions_s options,
int  pos,
const char *  registration,
oyOBJECT_e  type 
)

select from options with special attribute

Function oyOptions_GetType

Version
Oyranos: 0.1.10
Since
2009/03/04 (Oyranos: 0.1.10)
Date
2009/03/04

References oyStruct_s::copy, oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyVAL_STRUCT.

Referenced by oyImage_s::oyImage_CreateForDisplay().

int oyOptions_Init__Members ( oyOptions_s_ *  options)

Custom Options constructor.

Function oyOptions_Init__Members

OYAPI int OYEXPORT oyOptions_MoveIn ( oyOptions_s list,
oyOption_s **  obj,
int  pos 
)
int oyOptions_MoveInStruct ( oyOptions_s **  obj,
const char *  registration,
oyStruct_s **  oy_struct,
uint32_t  flags 
)

change a value

Function oyOptions_MoveInStruct

Parameters
objthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt"
oy_structthe Oyranos style object to move in
flagscan be OY_CREATE_NEW for a new option, or OY_ADD_ALWAYS
Version
Oyranos: 0.1.10
Since
2009/03/05 (Oyranos: 0.1.10)
Date
2009/03/05

Add a new option if the OY_CREATE_NEW flag is present.

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_Release(), oyOption_s::oyOption_StructMoveIn(), oyOptions_Find(), oyOptions_MoveIn(), and oyOptions_New().

Referenced by oyImage_s::oyImage_Create().

OYAPI oyOptions_s *OYEXPORT oyOptions_New ( oyObject_s  object)
OYAPI int OYEXPORT oyOptions_ObserverAdd ( oyOptions_s object,
oyStruct_s observer,
oyStruct_s user_data,
oyObserver_Signal_f  signalFunc 
)

observe options and its elements

Function oyOptions_ObserverAdd

Parameters
[in]objectthe options
[in]observerthe in observation intereressted object
[in]user_dataadditional static informations
[in]signalFuncthe signal handler
Returns
0 - fine; 1 - error
Version
Oyranos: 0.1.10
Since
2009/10/28 (Oyranos: 0.1.10)
Date
2009/10/28

References oyObserver_s::oyStruct_ObserverAdd(), and oyStructList_s::oyStructList_ObserverAdd().

OYAPI int OYEXPORT oyOptions_ObserversDisable ( oyOptions_s object)

disable signaling

Function oyOptions_ObserversDisable

Parameters
[in]objectthe options
Returns
0 - fine; 1 - error
Version
Oyranos: 0.1.10
Since
2010/04/07 (Oyranos: 0.1.10)
Date
2010/04/07

References oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyObserver_s::oyStruct_DisableSignalSend().

OYAPI int OYEXPORT oyOptions_ObserversEnable ( oyOptions_s object)

disable signaling

Function oyOptions_ObserversEnable

Parameters
[in]objectthe options
Returns
0 - fine; 1 - error
Version
Oyranos: 0.1.10
Since
2010/04/07 (Oyranos: 0.1.10)
Date
2010/04/07

References oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyObserver_s::oyStruct_EnableSignalSend().

OYAPI int OYEXPORT oyOptions_Release ( oyOptions_s **  options)
void oyOptions_Release__Members ( oyOptions_s_ *  options)

Custom Options destructor.

Function oyOptions_Release__Members

OYAPI int OYEXPORT oyOptions_ReleaseAt ( oyOptions_s list,
int  pos 
)

release a element from a Options list

Function oyOptions_ReleaseAt

Parameters
[in,out]listthe list
posposition
Version
Oyranos: 0.1.10
Since
2010/07/05 (Oyranos: 0.1.10)
Date
2010/07/05

References oyOBJECT_OPTIONS_S, oyStructList_s::oyStructList_GetParentObjType(), and oyStructList_s::oyStructList_ReleaseAt().

int oyOptions_Set ( oyOptions_s options,
oyOption_s option,
int  pos,
oyObject_s  object 
)

set a element in a Options list

Function oyOptions_Set

Already listed options are replaced by the new option. A option new to the existing set will be referenced if no object argument is given.

Adding a new element without any checks is as simple as following code:

*     tmp = oyOption_Copy( option, object );
*     oyOptions_MoveIn( options, &tmp, -1 ); 
Version
Oyranos: 0.1.10
Since
2009/10/25 (Oyranos: 0.1.10)
Date
2009/10/25

References oyOption_s::oyOption_Copy(), oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyOptions_MoveIn().

Referenced by oyOptions_SetOpts().

OYAPI int OYEXPORT oyOptions_SetDriverContext ( oyOptions_s **  options,
oyPointer  driver_context,
const char *  driver_context_type,
size_t  driver_context_size,
oyObject_s  object 
)

set a device option from a given external context

Function oyOptions_SetDriverContext

The options will be created in case they do not exist. The driver_context_type accepts "xml". The data in driver_context will be converted to a options set following the Oyranos options XML schemes with the help oyOptions_FromText(). Any other pointer will be converted to a oyBlob_s object. The name of that object will come from driver_context_type.

Parameters
[in,out]optionsoptions for the device
[in]driver_contextdriver context
[in]driver_context_type"xml" or something related to the driver
[in]driver_context_sizesize of driver_context
[in]objecta optional object
Returns
1 - error; 0 - success; -1 - otherwise
Version
Oyranos: 0.1.10
Since
2009/05/18 (Oyranos: 0.1.10)
Date
2009/05/18

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_SetFromData(), oyOption_s::oyOption_StructMoveIn(), oyOptions_FromText(), oyOptions_MoveIn(), oyOptions_New(), and oyOptions_Release().

int oyOptions_SetFromData ( oyOptions_s **  options,
const char *  registration,
oyPointer  ptr,
size_t  size,
uint32_t  flags 
)

set a data blob or plain pointer

Function oyOptions_SetFromData

Parameters
optionsthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt"
ptrthe pointer
sizethe pointer size
flagscan be OY_CREATE_NEW for a new option, or OY_ADD_ALWAYS
Returns
0 - success; 1 - error
Version
Oyranos: 0.1.10
Since
2009/11/07 (Oyranos: 0.1.10)
Date
2009/11/07

Add a new option if the OY_CREATE_NEW flag is present.

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_Release(), oyOption_s::oyOption_SetFromData(), oyOptions_Find(), oyOptions_MoveIn(), and oyOptions_New().

int oyOptions_SetFromDouble ( oyOptions_s **  obj,
const char *  registration,
double  value,
int  pos,
uint32_t  flags 
)

change a value

Function oyOptions_SetFromDouble

Parameters
objthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt"
valuethe value to set
posthe position in a value list
flagscan be OY_CREATE_NEW for a new option, OY_STRING_LIST or OY_ADD_ALWAYS
Returns
0 - success; 1 - error
Version
Oyranos: 0.1.10
Since
2009/05/04 (Oyranos: 0.1.10)
Date
2009/09/10

Add a new option if the OY_CREATE_NEW flag is present.

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_Release(), oyOption_s::oyOption_SetFromDouble(), oyOptions_Find(), oyOptions_MoveIn(), and oyOptions_New().

int oyOptions_SetFromInt ( oyOptions_s **  obj,
const char *  registration,
int32_t  value,
int  pos,
uint32_t  flags 
)

change a value

Function oyOptions_SetFromInt

Parameters
objthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt"
valuethe value to set
posthe position in a value list
flagscan be OY_CREATE_NEW for a new option, OY_STRING_LIST or OY_ADD_ALWAYS
Returns
0 - success; 1 - error
Version
Oyranos: 0.1.10
Since
2009/05/04 (Oyranos: 0.1.10)
Date
2009/05/04

Add a new option if the OY_CREATE_NEW flag is present.

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_Release(), oyOption_s::oyOption_SetFromInt(), oyOptions_Find(), oyOptions_MoveIn(), and oyOptions_New().

int oyOptions_SetFromText ( oyOptions_s **  obj,
const char *  registration,
const char *  value,
uint32_t  flags 
)

change a value

Function oyOptions_SetFromText

Parameters
objthe options list or set to manipulate
registrationthe options registration name, e.g. "org/my_org/openicc/my_app/my_opt"
valuethe value to set
flagscan be OY_CREATE_NEW for a new option, OY_STRING_LIST or OY_ADD_ALWAYS
Version
Oyranos: 0.3.0
Since
2008/11/27 (Oyranos: 0.1.9)
Date
2011/03/15

Add a new option if the OY_CREATE_NEW flag is present.

Flags are passed on to oyOption_SetFromText, e.g. OY_STRING_LIST.

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_FromRegistration(), oyOption_s::oyOption_Release(), oyOption_s::oyOption_SetFromText(), oyOptions_Find(), oyOptions_MoveIn(), and oyOptions_New().

Referenced by oyActivateMonitorProfiles(), oyConfig_s::oyConfig_AddDBData(), oyFilterNode_s::oyFilterNode_SetContext_(), oyGetDisplayNameFromPosition(), oyGetDisplayNameFromPosition2(), oyImage_s::oyImage_CreateForDisplay(), oyImage_FromFile(), oyImage_ToFile(), oyObject_s::oyObject_SetName(), oyProfile_s::oyProfile_GetFileName(), and oySetMonitorProfile().

int oyOptions_SetOpts ( oyOptions_s list,
oyOptions_s add 
)

set options in a Options list

Function oyOptions_SetOpts

Already listed options are replaced by the new options.

See Also
oyOptions_Set It will use copying.
Version
Oyranos: 0.1.10
Since
2009/10/25 (Oyranos: 0.1.10)
Date
2009/10/25

References oyOption_s::oyOption_Release(), oyOptions_Count(), oyOptions_Get(), and oyOptions_Set().

Referenced by oyOptions_CopyFrom().

int oyOptions_SetSource ( oyOptions_s options,
oyOPTIONSOURCE_e  source 
)

set source attribute

Function oyOptions_SetSource

Parameters
optionsthe options list or set to manipulate
sourcethe options new source attribute
Version
Oyranos: 0.1.10
Since
2009/01/27 (Oyranos: 0.1.9)
Date
2009/01/27

References oyOBJECT_OPTIONS_S, oyOption_s::oyOption_Release(), oyOptions_Count(), and oyOptions_Get().

Referenced by oyConfigs_s::oyConfigs_FromDomain(), and oyProfile_s::oyProfile_GetDevice().

OYAPI int OYEXPORT oyOptions_Sort ( oyOptions_s list,
int32_t *  rank_list 
)

sort a list according to a rank_list

Function oyOptions_Sort

Version
Oyranos: 0.3.0
Since
2011/02/01 (Oyranos: 0.3.0)
Date
2011/02/01

References oyOBJECT_OPTIONS_S, and oyStructList_s::oyStructList_Sort().

Field Documentation

oyStruct_Copy_f oyOptions_s::copy

copy function

oyStruct_Release_f oyOptions_s::release

release function