Oyranos Colour Management System API
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Macros | Enumerations | Functions
oyranos_object.h File Reference
#include <oyranos_core.h>

Macros

#define OY_SELECT_FILTER   2048
 select from filter More...
 
#define OY_SELECT_COMMON   4096
 select from policySelect typical from a associatable oyCMMapi9_s type of filter for providing common options. More...
 

Enumerations

enum  oyOBJECT_e { ,
  oyOBJECT_OBJECT_S, oyOBJECT_MONITOR_S, oyOBJECT_NAMED_COLOUR_S, oyOBJECT_NAMED_COLOURS_S,
  oyOBJECT_PROFILE_S, oyOBJECT_PROFILE_TAG_S, oyOBJECT_PROFILES_S, oyOBJECT_OPTION_S,
  oyOBJECT_OPTIONS_S, oyOBJECT_RECTANGLE_S, oyOBJECT_IMAGE_S, oyOBJECT_ARRAY2D_S,
  oyOBJECT_COLOUR_CONVERSION_S, oyOBJECT_CONNECTOR_S = 20, oyOBJECT_CONNECTOR_IMAGING_S, oyOBJECT_CONNECTOR_MAX_S,
  oyOBJECT_FILTER_PLUG_S = 30, oyOBJECT_FILTER_PLUGS_S, oyOBJECT_FILTER_SOCKET_S, oyOBJECT_FILTER_CORE_S,
  oyOBJECT_FILTER_CORES_S, oyOBJECT_FILTER_NODE_S, oyOBJECT_FILTER_NODES_S, oyOBJECT_FILTER_GRAPH_S,
  oyOBJECT_PIXEL_ACCESS_S, oyOBJECT_CONVERSION_S, oyOBJECT_CMM_HANDLE_S = 50, oyOBJECT_POINTER_S,
  oyOBJECT_CMM_INFO_S, oyOBJECT_CMM_API_S, oyOBJECT_CMM_APIS_S, oyOBJECT_CMM_API1_S,
  oyOBJECT_CMM_API2_S, oyOBJECT_CMM_API3_S, oyOBJECT_CMM_API4_S, oyOBJECT_CMM_API5_S,
  oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API7_S, oyOBJECT_CMM_DATA_TYPES_S, oyOBJECT_CMM_API8_S,
  oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_FILTERS_S, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_API10_S,
  oyOBJECT_CMM_UI_S, oyOBJECT_CMM_OBJECT_TYPE_S, oyOBJECT_CMM_API_MAX, oyOBJECT_ICON_S = 80,
  oyOBJECT_MODULE_S, oyOBJECT_EXTERNFUNC_S, oyOBJECT_NAME_S, oyOBJECT_COMP_S_,
  oyOBJECT_FILE_LIST_S_, oyOBJECT_HASH_S, oyOBJECT_STRUCT_LIST_S, oyOBJECT_BLOB_S,
  oyOBJECT_CONFIG_S, oyOBJECT_CONFIGS_S, oyOBJECT_UI_HANDLER_S, oyOBJECT_FORMS_ARGS_S,
  oyOBJECT_CALLBACK_S, oyOBJECT_OBSERVER_S, oyOBJECT_CONF_DOMAIN_S, oyOBJECT_INFO_STATIC_S
}
 Oyranos structure type. More...
 
enum  oyNAME_e { oyNAME_NAME, oyNAME_NICK, oyNAME_DESCRIPTION }
 describe the base types of a oyObject_s name More...
 
enum  oyOPTIONATTRIBUTE_e {
  oyOPTIONATTRIBUTE_BASIC = 0, oyOPTIONATTRIBUTE_EDIT = 32, oyOPTIONATTRIBUTE_AUTOMATIC = 64, oyOPTIONATTRIBUTE_ADVANCED = 128,
  oyOPTIONATTRIBUTE_FRONT = 256, oyOPTIONATTRIBUTE_DOUBLE = 512
}
 usage typeThe types of Oyranos default settings to include into the options set. So proofing makes no sense for toolkit widgets, but for advanced graphics displaying. All other Oyranos behaviour settings should be taken over untouched. More...
 
enum  oyBOOLEAN_e { oyBOOLEAN_INTERSECTION, oyBOOLEAN_SUBSTRACTION, oyBOOLEAN_DIFFERENZ, oyBOOLEAN_UNION }
 boolean operations More...
 
enum  oyFILTER_REG_e { ,
  oyFILTER_REG_TOP = 0x01, oyFILTER_REG_DOMAIN = 0x02, oyFILTER_REG_TYPE = 0x04, oyFILTER_REG_APPLICATION = 0x08,
  oyFILTER_REG_OPTION = 0x10
}
 
enum  oySTATUS_e
 File status type. More...
 
enum  oyERROR_e { oyERROR_USER = 10, oyERROR_DATA_READ, oyERROR_DATA_WRITE, oyERROR_DATA_AMBIGUITY }
 

Functions

const char * oyStructTypeToText (oyOBJECT_e type)
 Objects type to small string. More...
 

Detailed Description

[Template file inheritance graph] +– oyranos_object.template.h

Oyranos is an open source Colour Management System

Copyright:
2004-2012 (C) Kai-Uwe Behrmann
Author
Kai-Uwe Behrmann ku.b@.nosp@m.gmx..nosp@m.de
License:
new BSD - see: http://www.opensource.org/licenses/bsd-license.php
Date
2012/11/15

Macro Definition Documentation

#define OY_SELECT_COMMON   4096

select from policySelect typical from a associatable oyCMMapi9_s type of filter for providing common options.

Version
Oyranos: 0.1.10
Since
2009/07/27 (Oyranos: 0.1.10)
Date
2009/07/27
#define OY_SELECT_FILTER   2048

select from filter

Version
Oyranos: 0.1.10
Since
2009/07/27 (Oyranos: 0.1.10)
Date
2009/07/27

Referenced by oyImage_FromFile(), and oyImage_ToFile().

Enumeration Type Documentation

boolean operations

Version
Oyranos: 0.1.8
Since
2008/06/28 (Oyranos: 0.1.8)
Date
2008/06/28
Enumerator
oyBOOLEAN_INTERSECTION 

and, the part covered by A and B

oyBOOLEAN_SUBSTRACTION 

minus, the part covered by A but not by B

oyBOOLEAN_DIFFERENZ 

xor, exclusive parts of A and B

oyBOOLEAN_UNION 

or, the parts covered by A or B or both

enum oyERROR_e
Enumerator
oyERROR_USER 

wrong or missing argument

oyERROR_DATA_READ 

input error

oyERROR_DATA_WRITE 

output error

oyERROR_DATA_AMBIGUITY 

uniqueness of data is conflicted

usage typeThe types of Oyranos default settings to include into the options set. So proofing makes no sense for toolkit widgets, but for advanced graphics displaying. All other Oyranos behaviour settings should be taken over untouched.

The ".invisible" attribute says a option shall not be displayed in a GUI. The ".readonly" attribute alllows for unchangeable, static options. They might be used for passing additional informations. The ".font" and ".advanced" attributes are described for the according enum values.

See as well Registration

Version
Oyranos: 0.1.9
Since
2008/10/08 (Oyranos: 0.1.8)
Date
2008/11/27
Enumerator
oyOPTIONATTRIBUTE_BASIC 

basic settings, as typical for toolkits and office/web applications, e.g. disable proofing or disable mark out of gamut colours

oyOPTIONATTRIBUTE_EDIT 

user modified, e.g. after oyOption_SetFromText()

oyOPTIONATTRIBUTE_AUTOMATIC 

automatically modified, e.g. by a CMM

oyOPTIONATTRIBUTE_ADVANCED 

advanced settings, as typical for editing, e.g. include proofing (options appended with ".advanced")

oyOPTIONATTRIBUTE_FRONT 

front end options, handled by the framework or policy module, e.g. ".front"

oyOPTIONATTRIBUTE_DOUBLE 

tell this options is included twice

Function Documentation

const char* oyStructTypeToText ( oyOBJECT_e  type)

Objects type to small string.

Function oyStructTypeToText Give a basic description of inbuild object types.

Version
Oyranos: 0.5.0
Since
2008/06/24 (Oyranos: 0.1.8)
Date
2012/09/05

References oyOBJECT_ARRAY2D_S, oyOBJECT_BLOB_S, oyOBJECT_CALLBACK_S, oyOBJECT_CMM_API10_S, oyOBJECT_CMM_API1_S, oyOBJECT_CMM_API2_S, oyOBJECT_CMM_API3_S, oyOBJECT_CMM_API4_S, oyOBJECT_CMM_API5_S, oyOBJECT_CMM_API6_S, oyOBJECT_CMM_API7_S, oyOBJECT_CMM_API8_S, oyOBJECT_CMM_API9_S, oyOBJECT_CMM_API_FILTER_S, oyOBJECT_CMM_API_FILTERS_S, oyOBJECT_CMM_API_MAX, oyOBJECT_CMM_API_S, oyOBJECT_CMM_APIS_S, oyOBJECT_CMM_DATA_TYPES_S, oyOBJECT_CMM_HANDLE_S, oyOBJECT_CMM_INFO_S, oyOBJECT_CMM_OBJECT_TYPE_S, oyOBJECT_CMM_UI_S, oyOBJECT_COLOUR_CONVERSION_S, oyOBJECT_COMP_S_, oyOBJECT_CONF_DOMAIN_S, oyOBJECT_CONFIG_S, oyOBJECT_CONFIGS_S, oyOBJECT_CONNECTOR_IMAGING_S, oyOBJECT_CONNECTOR_MAX_S, oyOBJECT_CONNECTOR_S, oyOBJECT_CONVERSION_S, oyOBJECT_EXTERNFUNC_S, oyOBJECT_FILE_LIST_S_, oyOBJECT_FILTER_CORE_S, oyOBJECT_FILTER_CORES_S, oyOBJECT_FILTER_GRAPH_S, oyOBJECT_FILTER_NODE_S, oyOBJECT_FILTER_NODES_S, oyOBJECT_FILTER_PLUG_S, oyOBJECT_FILTER_PLUGS_S, oyOBJECT_FILTER_SOCKET_S, oyOBJECT_FORMS_ARGS_S, oyOBJECT_HASH_S, oyOBJECT_ICON_S, oyOBJECT_IMAGE_S, oyOBJECT_INFO_STATIC_S, oyOBJECT_MODULE_S, oyOBJECT_MONITOR_S, oyOBJECT_NAME_S, oyOBJECT_NAMED_COLOUR_S, oyOBJECT_NAMED_COLOURS_S, oyOBJECT_OBJECT_S, oyOBJECT_OBSERVER_S, oyOBJECT_OPTION_S, oyOBJECT_OPTIONS_S, oyOBJECT_PIXEL_ACCESS_S, oyOBJECT_POINTER_S, oyOBJECT_PROFILE_S, oyOBJECT_PROFILE_TAG_S, oyOBJECT_PROFILES_S, oyOBJECT_RECTANGLE_S, oyOBJECT_STRUCT_LIST_S, and oyOBJECT_UI_HANDLER_S.

Referenced by oyFilterGraph_s::oyFilterGraph_ToText(), oyFilterPlug_s::oyFilterPlug_ConnectIntoSocket(), oyMessageFormat(), oyObject_s::oyObject_UnRef(), oyStruct_GetInfo(), and oyStruct_s::oyStruct_GetText().