<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgutenprint API Reference: stp_parameter_t Struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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 class="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>stp_parameter_t Struct Reference<br>
<small>
[<a class="el" href="group__vars.html">vars</a>]</small>
</h1><!-- doxytag: class="stp_parameter_t" -->Parameter description.
<a href="#_details">More...</a>
<p>
<code>#include <vars.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">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#092430e582e7560fb532f546f78ca70c">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#396e4980926c200e9ce4454f19e7311a">text</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#2cb67e4324a017746ca9bfda772aa50f">category</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#9f0637d6b97f0daa3122840eb2bd13db">help</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#g9b3d4f47a44c0c8c9b150cddc56d2a91">stp_parameter_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#ebe5dea02843240fe03461abf007f154">p_type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#g4eba7e712c0e17b76e472f26e202d7b8">stp_parameter_class_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#410388e541bdb14fbd0af2984e229217">p_class</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__vars.html#gaa9c9265ffe70122bd33659cf2983207">stp_parameter_level_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#2a4a1195c06243e08acb03475fb1e7cc">p_level</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#ce4d02e3665f9cdfe83ed7dd559e1c1a">is_mandatory</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#8b1af01f0874c79b6dbc4d0eca432952">is_active</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#79bc0b76d5d5e238ddd205aa4a97ebad">channel</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#56100203c262c60d4cb18c7a49cde27d">verify_this_parameter</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#4421135f9985be49d156cbc9aa74c710">read_only</a></td></tr>
<tr><td class="memItemLeft" nowrap>union {</td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="group__curve.html#g375a2b23705fb0698ae1d823243c8524">stp_curve_t</a> * <a class="el" href="structstp__parameter__t.html#d64f0c31d200d3d413725621b3ef9133">curve</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="structstp__double__bound__t.html">stp_double_bound_t</a> <a class="el" href="structstp__parameter__t.html#12fc8869d3056687e576af63c6fbd675">dbl</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a> <a class="el" href="structstp__parameter__t.html#32ee2ba322a0b7d16520f52ded591cc5">integer</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a> <a class="el" href="structstp__parameter__t.html#29505a2b48cd755e10cedf01f3683d61">dimension</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="string-list_8h.html#5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a> * <a class="el" href="structstp__parameter__t.html#bfe1adab94129fefdafe9e64be135fb6">str</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="group__array.html#g26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * <a class="el" href="structstp__parameter__t.html#28aef58241d3a500968ca65df099ee3a">array</a></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#bb297424036e868212f5086d5c5235fe">bounds</a></td></tr>
<tr><td class="memItemLeft" nowrap>union {</td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="group__curve.html#g375a2b23705fb0698ae1d823243c8524">stp_curve_t</a> * <a class="el" href="structstp__parameter__t.html#d64f0c31d200d3d413725621b3ef9133">curve</a></td></tr>
<tr><td class="memItemLeft" nowrap> double <a class="el" href="structstp__parameter__t.html#222137e14dadb05adfbdde061679ce61">dbl</a></td></tr>
<tr><td class="memItemLeft" nowrap> int <a class="el" href="structstp__parameter__t.html#5d8633772783bb1c66ffa66d7f720a9d">dimension</a></td></tr>
<tr><td class="memItemLeft" nowrap> int <a class="el" href="structstp__parameter__t.html#3563548500d3ec917d8e1cf88c34f8cd">integer</a></td></tr>
<tr><td class="memItemLeft" nowrap> int <a class="el" href="structstp__parameter__t.html#74aaa2515728660657133ca3191e422c">boolean</a></td></tr>
<tr><td class="memItemLeft" nowrap> const char * <a class="el" href="structstp__parameter__t.html#e4409d001a6f1b7f8bbf237016900e48">str</a></td></tr>
<tr><td class="memItemLeft" nowrap> <a class="el" href="group__array.html#g26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> * <a class="el" href="structstp__parameter__t.html#28aef58241d3a500968ca65df099ee3a">array</a></td></tr>
<tr><td class="memItemLeft" nowrap valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#79042d88fa0ab284a8e3e4ad7b969f90">deflt</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Parameter description.
<p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="092430e582e7560fb532f546f78ca70c"></a><!-- doxytag: member="stp_parameter_t::name" ref="092430e582e7560fb532f546f78ca70c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structstp__parameter__t.html#092430e582e7560fb532f546f78ca70c">stp_parameter_t::name</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Internal name (key).
</div>
</div><p>
<a class="anchor" name="396e4980926c200e9ce4454f19e7311a"></a><!-- doxytag: member="stp_parameter_t::text" ref="396e4980926c200e9ce4454f19e7311a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structstp__parameter__t.html#396e4980926c200e9ce4454f19e7311a">stp_parameter_t::text</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
User-visible name.
</div>
</div><p>
<a class="anchor" name="2cb67e4324a017746ca9bfda772aa50f"></a><!-- doxytag: member="stp_parameter_t::category" ref="2cb67e4324a017746ca9bfda772aa50f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structstp__parameter__t.html#2cb67e4324a017746ca9bfda772aa50f">stp_parameter_t::category</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
User-visible category name.
</div>
</div><p>
<a class="anchor" name="9f0637d6b97f0daa3122840eb2bd13db"></a><!-- doxytag: member="stp_parameter_t::help" ref="9f0637d6b97f0daa3122840eb2bd13db" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structstp__parameter__t.html#9f0637d6b97f0daa3122840eb2bd13db">stp_parameter_t::help</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Help string.
</div>
</div><p>
<a class="anchor" name="ebe5dea02843240fe03461abf007f154"></a><!-- doxytag: member="stp_parameter_t::p_type" ref="ebe5dea02843240fe03461abf007f154" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vars.html#g9b3d4f47a44c0c8c9b150cddc56d2a91">stp_parameter_type_t</a> <a class="el" href="structstp__parameter__t.html#ebe5dea02843240fe03461abf007f154">stp_parameter_t::p_type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parameter type.
</div>
</div><p>
<a class="anchor" name="410388e541bdb14fbd0af2984e229217"></a><!-- doxytag: member="stp_parameter_t::p_class" ref="410388e541bdb14fbd0af2984e229217" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vars.html#g4eba7e712c0e17b76e472f26e202d7b8">stp_parameter_class_t</a> <a class="el" href="structstp__parameter__t.html#410388e541bdb14fbd0af2984e229217">stp_parameter_t::p_class</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parameter class.
</div>
</div><p>
<a class="anchor" name="2a4a1195c06243e08acb03475fb1e7cc"></a><!-- doxytag: member="stp_parameter_t::p_level" ref="2a4a1195c06243e08acb03475fb1e7cc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__vars.html#gaa9c9265ffe70122bd33659cf2983207">stp_parameter_level_t</a> <a class="el" href="structstp__parameter__t.html#2a4a1195c06243e08acb03475fb1e7cc">stp_parameter_t::p_level</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parameter level.
</div>
</div><p>
<a class="anchor" name="ce4d02e3665f9cdfe83ed7dd559e1c1a"></a><!-- doxytag: member="stp_parameter_t::is_mandatory" ref="ce4d02e3665f9cdfe83ed7dd559e1c1a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#ce4d02e3665f9cdfe83ed7dd559e1c1a">stp_parameter_t::is_mandatory</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The parameter is required, even when set inactive.
</div>
</div><p>
<a class="anchor" name="8b1af01f0874c79b6dbc4d0eca432952"></a><!-- doxytag: member="stp_parameter_t::is_active" ref="8b1af01f0874c79b6dbc4d0eca432952" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#8b1af01f0874c79b6dbc4d0eca432952">stp_parameter_t::is_active</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Is the parameter active?
</div>
</div><p>
<a class="anchor" name="79bc0b76d5d5e238ddd205aa4a97ebad"></a><!-- doxytag: member="stp_parameter_t::channel" ref="79bc0b76d5d5e238ddd205aa4a97ebad" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#79bc0b76d5d5e238ddd205aa4a97ebad">stp_parameter_t::channel</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The channel to which this parameter applies
</div>
</div><p>
<a class="anchor" name="56100203c262c60d4cb18c7a49cde27d"></a><!-- doxytag: member="stp_parameter_t::verify_this_parameter" ref="56100203c262c60d4cb18c7a49cde27d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#56100203c262c60d4cb18c7a49cde27d">stp_parameter_t::verify_this_parameter</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Should the verify system check this parameter?
</div>
</div><p>
<a class="anchor" name="4421135f9985be49d156cbc9aa74c710"></a><!-- doxytag: member="stp_parameter_t::read_only" ref="4421135f9985be49d156cbc9aa74c710" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#4421135f9985be49d156cbc9aa74c710">stp_parameter_t::read_only</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="d64f0c31d200d3d413725621b3ef9133"></a><!-- doxytag: member="stp_parameter_t::curve" ref="d64f0c31d200d3d413725621b3ef9133" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__curve.html#g375a2b23705fb0698ae1d823243c8524">stp_curve_t</a>* <a class="el" href="structstp__parameter__t.html#d64f0c31d200d3d413725621b3ef9133">stp_parameter_t::curve</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
curve parameter value.<p>
Default curve parameter value.
</div>
</div><p>
<a class="anchor" name="12fc8869d3056687e576af63c6fbd675"></a><!-- doxytag: member="stp_parameter_t::dbl" ref="12fc8869d3056687e576af63c6fbd675" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstp__double__bound__t.html">stp_double_bound_t</a> <a class="el" href="structstp__parameter__t.html#12fc8869d3056687e576af63c6fbd675">stp_parameter_t::dbl</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
double_bound parameter value.
</div>
</div><p>
<a class="anchor" name="32ee2ba322a0b7d16520f52ded591cc5"></a><!-- doxytag: member="stp_parameter_t::integer" ref="32ee2ba322a0b7d16520f52ded591cc5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a> <a class="el" href="structstp__parameter__t.html#32ee2ba322a0b7d16520f52ded591cc5">stp_parameter_t::integer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
int_bound parameter value.
</div>
</div><p>
<a class="anchor" name="29505a2b48cd755e10cedf01f3683d61"></a><!-- doxytag: member="stp_parameter_t::dimension" ref="29505a2b48cd755e10cedf01f3683d61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a> <a class="el" href="structstp__parameter__t.html#29505a2b48cd755e10cedf01f3683d61">stp_parameter_t::dimension</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
int_bound parameter value.
</div>
</div><p>
<a class="anchor" name="bfe1adab94129fefdafe9e64be135fb6"></a><!-- doxytag: member="stp_parameter_t::str" ref="bfe1adab94129fefdafe9e64be135fb6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="string-list_8h.html#5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a>* <a class="el" href="structstp__parameter__t.html#bfe1adab94129fefdafe9e64be135fb6">stp_parameter_t::str</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
string_list parameter value.
</div>
</div><p>
<a class="anchor" name="28aef58241d3a500968ca65df099ee3a"></a><!-- doxytag: member="stp_parameter_t::array" ref="28aef58241d3a500968ca65df099ee3a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__array.html#g26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* <a class="el" href="structstp__parameter__t.html#28aef58241d3a500968ca65df099ee3a">stp_parameter_t::array</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
array parameter value.<p>
Default array parameter value.
</div>
</div><p>
<a class="anchor" name="bb297424036e868212f5086d5c5235fe"></a><!-- doxytag: member="stp_parameter_t::bounds" ref="bb297424036e868212f5086d5c5235fe" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } <a class="el" href="structstp__parameter__t.html#bb297424036e868212f5086d5c5235fe">stp_parameter_t::bounds</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Limits on the values the parameter may take.
</div>
</div><p>
<a class="anchor" name="222137e14dadb05adfbdde061679ce61"></a><!-- doxytag: member="stp_parameter_t::dbl" ref="222137e14dadb05adfbdde061679ce61" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double <a class="el" href="structstp__parameter__t.html#12fc8869d3056687e576af63c6fbd675">stp_parameter_t::dbl</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default double parameter value.
</div>
</div><p>
<a class="anchor" name="5d8633772783bb1c66ffa66d7f720a9d"></a><!-- doxytag: member="stp_parameter_t::dimension" ref="5d8633772783bb1c66ffa66d7f720a9d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structstp__parameter__t.html#29505a2b48cd755e10cedf01f3683d61">stp_parameter_t::dimension</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default dimension parameter value.
</div>
</div><p>
<a class="anchor" name="3563548500d3ec917d8e1cf88c34f8cd"></a><!-- doxytag: member="stp_parameter_t::integer" ref="3563548500d3ec917d8e1cf88c34f8cd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structstp__parameter__t.html#32ee2ba322a0b7d16520f52ded591cc5">stp_parameter_t::integer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default int parameter value.
</div>
</div><p>
<a class="anchor" name="74aaa2515728660657133ca3191e422c"></a><!-- doxytag: member="stp_parameter_t::boolean" ref="74aaa2515728660657133ca3191e422c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="structstp__parameter__t.html#74aaa2515728660657133ca3191e422c">stp_parameter_t::boolean</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default boolean parameter value.
</div>
</div><p>
<a class="anchor" name="e4409d001a6f1b7f8bbf237016900e48"></a><!-- doxytag: member="stp_parameter_t::str" ref="e4409d001a6f1b7f8bbf237016900e48" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structstp__parameter__t.html#bfe1adab94129fefdafe9e64be135fb6">stp_parameter_t::str</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default string parameter value.
</div>
</div><p>
<a class="anchor" name="79042d88fa0ab284a8e3e4ad7b969f90"></a><!-- doxytag: member="stp_parameter_t::deflt" ref="79042d88fa0ab284a8e3e4ad7b969f90" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">union { ... } <a class="el" href="structstp__parameter__t.html#79042d88fa0ab284a8e3e4ad7b969f90">stp_parameter_t::deflt</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default value of the parameter.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>include/gutenprint/<a class="el" href="vars_8h.html">vars.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Aug 10 20:32:51 2010 for libgutenprint API Reference by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
