<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Oyranos: oyOption_s Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>oyOption_s Struct Reference<br>
<small>
[<a class="el" href="group__objects__value.html">Values Handling</a>]</small>
</h1><!-- doxytag: class="oyOption_s" -->Option for rendering.
<a href="#_details">More...</a>
<p>
<code>#include <oyranos_alpha.h></code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__objects__generic.html#ga62ef859fd449252e08ccba088cf4f20">oyOBJECT_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#704e6a14b3dd7dcef019392069873abd">type_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oyStruct_Copy_f </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#92ba0619d3f1517def168ed0140c6110">copy</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">oyStruct_Release_f </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#937daf5a882ba9690e2752a51d803947">release</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyObject__s.html">oyObject_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#e9743e225af6bd848f65f2ccdd43696f">oy_</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#5420a2b281a80e279b2c131deb044196">id</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#1be5691c55c51dd3cda70394f8cd4b6f">registration</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#3143863fb89e0a1c9fa455bf37ed5703">version</a> [3]</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="oyranos__alpha_8h.html#78bd1a2a5f284ace978e588333110ce4">oyVALUETYPE_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#e28662b571486a047e6023e7f68b6ab7">value_type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionoyValue__u.html">oyValue_u</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#8e91a0c6d21f5d1910deda251fdcf2b1">value</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="oyranos__alpha_8h.html#2619f72943ac508e2459b488a812b8df">oyOPTIONSOURCE_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#4e1e775337cc1d05796ce950d1ed4f84">source</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structoyOption__s.html#2256a21e1c93db189e1a9a89e785a364">flags</a></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyOption__s.html">oyOption_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#g3392c0dbfa193f3d3631f84105c971b0">oyOption_New</a> (<a class="el" href="structoyObject__s.html">oyObject_s</a> object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">new option <a href="group__objects__value.html#g3392c0dbfa193f3d3631f84105c971b0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structoyOption__s.html">oyOption_s</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#gd1f76e329dbbe6ccf66c53e50314afb2">oyOption_Copy</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *option, <a class="el" href="structoyObject__s.html">oyObject_s</a> object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">copy or reference a option <a href="group__objects__value.html#gd1f76e329dbbe6ccf66c53e50314afb2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#g9525fb4929198373f7cd8a281d2042c6">oyOption_Release</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> **obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">release a option <a href="group__objects__value.html#g9525fb4929198373f7cd8a281d2042c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#g2e0209f5562f44c2b336d722a7002cf9">oyOption_Clear</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">clear a option <a href="group__objects__value.html#g2e0209f5562f44c2b336d722a7002cf9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#g2902e17ca390d78b2f3a6b7843d67bc0">oyOption_GetId</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *obj)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the identification number of a option <a href="group__objects__value.html#g2902e17ca390d78b2f3a6b7843d67bc0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#g6e14dd625f47098043ec136b68c194ee">oyOption_GetValueText</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *obj, <a class="el" href="oyranos_8h.html#c8c6790602510b0b1cdfb5d0c06f99c9">oyAlloc_f</a> allocateFunc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get value as a text dump <a href="group__objects__value.html#g6e14dd625f47098043ec136b68c194ee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#ga3ff1cbf79b0927eed9cba150dcd7217">oyOption_GetText</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *obj, <a class="el" href="group__objects__generic.html#g843f8ac2692fc9726f7152966fea1f6f">oyNAME_e</a> type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get a text dump <a href="group__objects__value.html#ga3ff1cbf79b0927eed9cba150dcd7217"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__objects__value.html#gc2548f838b688ed3318430b7b62b6351">oyOption_SetFromText</a> (<a class="el" href="structoyOption__s.html">oyOption_s</a> *obj, const char *text)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">set a option value from a string <a href="group__objects__value.html#gc2548f838b688ed3318430b7b62b6351"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Option for rendering.
<p>
<dl class="todo" compact><dt><b><a class="el" href="todo.html#_todo000014">Todo:</a></b></dt><dd>include the oyOptions_t_ type for gui elements should be used in a list oyColourTransformOptions_s to form a options set oyOptions_t_ covers as well the UI part which should be separated as of the SimpleToolkitAbstraction project: <a href="http://www.oyranos.org/wiki/index.php?title=XML_Plug-in_options">http://www.oyranos.org/wiki/index.php?title=XML_Plug-in_options</a> As of this architecture change The UI part must be decided to obtain a place. Probably in <a class="el" href="structoyOptions__s.html" title="generic OptionsOptions can be any flag or rendering intent and other informations...">oyOptions_s</a>? Thus the oyOption_s::name member should be removed.</dd></dl>
The id field maps to a oyWidget_s object. Options and widgets are to be queried by the according function / CMM combination.<p>
<dl class="version" compact><dt><b>Version:</b></dt><dd>Oyranos: 0.1.8 </dd></dl>
<dl class="since" compact><dt><b>Since:</b></dt><dd>2007/00/00 (Oyranos: 0.1.x) </dd></dl>
<dl class="date" compact><dt><b>Date:</b></dt><dd>2008/04/14 </dd></dl>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="92ba0619d3f1517def168ed0140c6110"></a><!-- doxytag: member="oyOption_s::copy" ref="92ba0619d3f1517def168ed0140c6110" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oyStruct_Copy_f <a class="el" href="structoyOption__s.html#92ba0619d3f1517def168ed0140c6110">oyOption_s::copy</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
copy function
</div>
</div><p>
<a class="anchor" name="2256a21e1c93db189e1a9a89e785a364"></a><!-- doxytag: member="oyOption_s::flags" ref="2256a21e1c93db189e1a9a89e785a364" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structoyOption__s.html#2256a21e1c93db189e1a9a89e785a364">oyOption_s::flags</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
| oyOPTIONATTRIBUTE_e
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04876">oyOption_Clear()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05133">oyOption_SetFromText()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05546">oyOptions_s::oyOptions_DoFilter()</a>.</p>
</div>
</div><p>
<a class="anchor" name="5420a2b281a80e279b2c131deb044196"></a><!-- doxytag: member="oyOption_s::id" ref="5420a2b281a80e279b2c131deb044196" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="structoyOption__s.html#5420a2b281a80e279b2c131deb044196">oyOption_s::id</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
id to map to events and widgets
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04907">oyOption_GetId()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l04830">oyOption_Release()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e9743e225af6bd848f65f2ccdd43696f"></a><!-- doxytag: member="oyOption_s::oy_" ref="e9743e225af6bd848f65f2ccdd43696f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structoyObject__s.html">oyObject_s</a> <a class="el" href="structoyOption__s.html#e9743e225af6bd848f65f2ccdd43696f">oyOption_s::oy_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
base object
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04876">oyOption_Clear()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l04801">oyOption_Copy()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05033">oyOption_GetText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l04830">oyOption_Release()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05133">oyOption_SetFromText()</a>.</p>
</div>
</div><p>
<a class="anchor" name="1be5691c55c51dd3cda70394f8cd4b6f"></a><!-- doxytag: member="oyOption_s::registration" ref="1be5691c55c51dd3cda70394f8cd4b6f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structoyOption__s.html#1be5691c55c51dd3cda70394f8cd4b6f">oyOption_s::registration</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
full key path name to store configuration, e.g. "sw/oyranos.org/generic/scale/x"
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04876">oyOption_Clear()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05033">oyOption_GetText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06007">oyOptions_s::oyOptions_Add()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05546">oyOptions_s::oyOptions_DoFilter()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06130">oyOptions_s::oyOptions_Find()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06177">oyOptions_s::oyOptions_FindString()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05268">oyOptions_s::oyOptions_FromBoolean()</a>.</p>
</div>
</div><p>
<a class="anchor" name="937daf5a882ba9690e2752a51d803947"></a><!-- doxytag: member="oyOption_s::release" ref="937daf5a882ba9690e2752a51d803947" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">oyStruct_Release_f <a class="el" href="structoyOption__s.html#937daf5a882ba9690e2752a51d803947">oyOption_s::release</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
release function
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04683">oyOption_New()</a>.</p>
</div>
</div><p>
<a class="anchor" name="4e1e775337cc1d05796ce950d1ed4f84"></a><!-- doxytag: member="oyOption_s::source" ref="4e1e775337cc1d05796ce950d1ed4f84" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="oyranos__alpha_8h.html#2619f72943ac508e2459b488a812b8df">oyOPTIONSOURCE_e</a> <a class="el" href="structoyOption__s.html#4e1e775337cc1d05796ce950d1ed4f84">oyOption_s::source</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the source of this value
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l05546">oyOptions_s::oyOptions_DoFilter()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05659">oyOptions_s::oyOptions_ForFilter_()</a>.</p>
</div>
</div><p>
<a class="anchor" name="704e6a14b3dd7dcef019392069873abd"></a><!-- doxytag: member="oyOption_s::type_" ref="704e6a14b3dd7dcef019392069873abd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__objects__generic.html#ga62ef859fd449252e08ccba088cf4f20">oyOBJECT_e</a> <a class="el" href="structoyOption__s.html#704e6a14b3dd7dcef019392069873abd">oyOption_s::type_</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
struct type oyOBJECT_OPTION_S
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04830">oyOption_Release()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06130">oyOptions_s::oyOptions_Find()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06177">oyOptions_s::oyOptions_FindString()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05908">oyOptions_s::oyOptions_MoveIn()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8e91a0c6d21f5d1910deda251fdcf2b1"></a><!-- doxytag: member="oyOption_s::value" ref="8e91a0c6d21f5d1910deda251fdcf2b1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="unionoyValue__u.html">oyValue_u</a>* <a class="el" href="structoyOption__s.html#8e91a0c6d21f5d1910deda251fdcf2b1">oyOption_s::value</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the actual value
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04876">oyOption_Clear()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05033">oyOption_GetText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l04927">oyOption_GetValueText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05133">oyOption_SetFromText()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l06177">oyOptions_s::oyOptions_FindString()</a>.</p>
</div>
</div><p>
<a class="anchor" name="e28662b571486a047e6023e7f68b6ab7"></a><!-- doxytag: member="oyOption_s::value_type" ref="e28662b571486a047e6023e7f68b6ab7" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="oyranos__alpha_8h.html#78bd1a2a5f284ace978e588333110ce4">oyVALUETYPE_e</a> <a class="el" href="structoyOption__s.html#e28662b571486a047e6023e7f68b6ab7">oyOption_s::value_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the type in value
<p>Referenced by <a class="el" href="oyranos__alpha_8c_source.html#l04876">oyOption_Clear()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l04927">oyOption_GetValueText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l05133">oyOption_SetFromText()</a>, <a class="el" href="oyranos__alpha_8c_source.html#l06177">oyOptions_s::oyOptions_FindString()</a>, and <a class="el" href="oyranos__alpha_8c_source.html#l05268">oyOptions_s::oyOptions_FromBoolean()</a>.</p>
</div>
</div><p>
<a class="anchor" name="3143863fb89e0a1c9fa455bf37ed5703"></a><!-- doxytag: member="oyOption_s::version" ref="3143863fb89e0a1c9fa455bf37ed5703" args="[3]" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structoyOption__s.html#3143863fb89e0a1c9fa455bf37ed5703">oyOption_s::version</a>[3] </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
as for oyCMMapi4_s::version
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 27 04:18:00 2009 for Oyranos by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
