oyConfig_s Struct Reference

a group of options for a device More...

#include <oyranos_alpha.h>

Public Member Functions
oyRankPad *	oyRankMapCopy (const oyRankPad *rank_map, oyAlloc_f allocateFunc)
	copy a rank map
OYAPI oyConfig_s *OYEXPORT	oyConfig_New (const char *registration, oyObject_s object)
	allocate a new Config object
OYAPI int OYEXPORT	oyConfig_GetDB (oyConfig_s *device, int32_t *rank_value)
	search a configuration in the DB for a configuration from module
OYAPI oyConfig_s *OYEXPORT	oyConfig_Copy (oyConfig_s *obj, oyObject_s object)
	copy or reference a Config object
OYAPI int OYEXPORT	oyConfig_Release (oyConfig_s **obj)
	release and possibly deallocate a Config object
OYAPI int OYEXPORT	oyConfig_AddDBData (oyConfig_s *config, const char *key, const char *value, uint32_t flags)
	add a key value pair to a oyConfig_s::db
OYAPI int OYEXPORT	oyConfig_ClearDBData (oyConfig_s *config)
	remove all additional data from the oyConfig_s::db object cache
OYAPI int OYEXPORT	oyConfig_SaveToDB (oyConfig_s *config)
	store a oyConfig_s in DB
int	oyRegistrationEraseFromDB (const char *registration)
	remove a registration config from DB
OYAPI int OYEXPORT	oyConfig_EraseFromDB (oyConfig_s *config)
	remove a oyConfig_s from DB
int	oyConfig_Compare (oyConfig_s *module_device, oyConfig_s *db_pattern, int32_t *rank_value)
	check for matching to a given pattern
OYAPI int OYEXPORT	oyConfig_DomainRank (oyConfig_s *config)
	check for being recognised by a given module
OYAPI const char *OYEXPORT	oyConfig_FindString (oyConfig_s *config, const char *key, const char *value)
	search in data sets for a key/value
OYAPI oyOption_s *OYEXPORT	oyConfig_Find (oyConfig_s *config, const char *key)
	search in data sets for a key
OYAPI int OYEXPORT	oyConfig_Has (oyConfig_s *config, const char *key)
	search in data sets for a key
OYAPI int OYEXPORT	oyConfig_Count (oyConfig_s *config)
	number of all options
OYAPI oyOption_s *OYEXPORT	oyConfig_Get (oyConfig_s *config, int pos)
	get one option
Data Fields
oyStruct_Copy_f	copy
oyStruct_Release_f	release
uint32_t	id
char *	registration
int	version [3]
oyOptions_s *	db
oyOptions_s *	backend_core
oyOptions_s *	data
oyRankPad *	rank_map

---

Detailed Description

a group of options for a device

Version:

Oyranos: 0.1.10

Since:

2009/01/15 (Oyranos: 0.1.10)

Date:

2009/01/15

---

Field Documentation

oyOptions_s* oyConfig_s::backend_core

These are the module core properties, the ones to identify the device and store in DB. They must be filled by the module. e.g. "shared/freedesktop.org/imaging/config.monitor.xorg/manufacturer=EIZO"

Referenced by oyConfig_Count(), oyConfig_Find(), oyConfig_FindString(), oyConfig_Get(), oyConfig_Has(), oyConfig_Release(), oyConfig_SaveToDB(), oyConfigs_s::oyConfigs_FromDomain(), oyDeviceGetInfo(), oyDeviceSetProfile(), oyProfile_s::oyProfile_DeviceGet(), and oyProfiles_s::oyProfiles_DeviceRank().

oyStruct_Copy_f oyConfig_s::copy

copy function

oyOptions_s* oyConfig_s::data

Additional informations from modules, with non identification purpose, can be stored herein, e.g. "shared/freedesktop.org/imaging/config.monitor.xorg/edid=oyBlob_s*"

Referenced by oyConfig_Count(), oyConfig_Find(), oyConfig_FindString(), oyConfig_Get(), oyConfig_Has(), oyConfig_Release(), oyConfigs_s::oyConfigs_FromDomain(), oyDeviceGetInfo(), and oyDeviceSetup().

oyOptions_s* oyConfig_s::db

data base (Elektra) properties, e.g. "shared/freedesktop.org/imaging/config.monitor.xorg/1/manufacturer=EIZO"

Referenced by oyConfig_AddDBData(), oyConfig_ClearDBData(), oyConfig_Compare(), oyConfig_Count(), oyConfig_EraseFromDB(), oyConfig_Find(), oyConfig_FindString(), oyConfig_Get(), oyConfig_GetDB(), oyConfig_Has(), oyConfig_Release(), oyConfig_SaveToDB(), oyConfigs_s::oyConfigs_FromDB(), oyDeviceProfileFromDB(), and oyProfiles_s::oyProfiles_DeviceRank().

uint32_t oyConfig_s::id

id to map to events and widgets

oyRankPad* oyConfig_s::rank_map

zero terminated list; key compare

Referenced by oyConfig_Compare(), oyConfig_Release(), and oyConfigs_s::oyConfigs_FromDB().

char* oyConfig_s::registration

This property contains the identifier for communication with a Oyranos or a module through Oyranos. It defines the basic key path name to store configuration.
e.g. "shared/freedesktop.org/imaging/config.monitor.xorg"
see as well Registration

Referenced by oyConfig_AddDBData(), oyConfig_DomainRank(), oyConfig_EraseFromDB(), oyConfig_GetDB(), oyConfig_SaveToDB(), oyConfigs_s::oyConfigs_Modify(), oyDeviceAskProfile2(), oyDeviceBackendCall(), oyDeviceGetInfo(), oyDeviceSetProfile(), oyDeviceSetup(), oyDeviceUnset(), oyProfile_s::oyProfile_DeviceGet(), and oyProfiles_s::oyProfiles_DeviceRank().

oyStruct_Release_f oyConfig_s::release

release function

Referenced by oyConfig_New().

int oyConfig_s::version[3]

as for oyCMMapi4_s::version