<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libgutenprint API Reference: stp_parameter_t 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.7.4 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">libgutenprint API Reference <span id="projectnumber">5.2.7</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <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="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <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="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">stp_parameter_t Struct Reference<div class="ingroups"><a class="el" href="group__vars.html">vars</a></div></div> </div> </div> <div class="contents"> <!-- doxytag: class="stp_parameter_t" --> <p>Parameter description. <a href="structstp__parameter__t.html#details">More...</a></p> <p><code>#include <vars.h></code></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a092430e582e7560fb532f546f78ca70c">name</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a396e4980926c200e9ce4454f19e7311a">text</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a2cb67e4324a017746ca9bfda772aa50f">category</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a9f0637d6b97f0daa3122840eb2bd13db">help</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#ga9b3d4f47a44c0c8c9b150cddc56d2a91">stp_parameter_type_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#aebe5dea02843240fe03461abf007f154">p_type</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#ga4eba7e712c0e17b76e472f26e202d7b8">stp_parameter_class_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a410388e541bdb14fbd0af2984e229217">p_class</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__vars.html#gaaa9c9265ffe70122bd33659cf2983207">stp_parameter_level_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a2a4a1195c06243e08acb03475fb1e7cc">p_level</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#ace4d02e3665f9cdfe83ed7dd559e1c1a">is_mandatory</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a8b1af01f0874c79b6dbc4d0eca432952">is_active</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a79bc0b76d5d5e238ddd205aa4a97ebad">channel</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a56100203c262c60d4cb18c7a49cde27d">verify_this_parameter</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">unsigned char </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a4421135f9985be49d156cbc9aa74c710">read_only</a></td></tr> <tr><td class="memItemLeft" >union {</td></tr> <tr><td class="memItemLeft" >   <a class="el" href="group__curve.html#ga375a2b23705fb0698ae1d823243c8524">stp_curve_t</a> *   <a class="el" href="structstp__parameter__t.html#ad64f0c31d200d3d413725621b3ef9133">curve</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="structstp__double__bound__t.html">stp_double_bound_t</a>   <a class="el" href="structstp__parameter__t.html#a12fc8869d3056687e576af63c6fbd675">dbl</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a>   <a class="el" href="structstp__parameter__t.html#a32ee2ba322a0b7d16520f52ded591cc5">integer</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="structstp__int__bound__t.html">stp_int_bound_t</a>   <a class="el" href="structstp__parameter__t.html#a29505a2b48cd755e10cedf01f3683d61">dimension</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="string-list_8h.html#a5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a> *   <a class="el" href="structstp__parameter__t.html#abfe1adab94129fefdafe9e64be135fb6">str</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *   <a class="el" href="structstp__parameter__t.html#a28aef58241d3a500968ca65df099ee3a">array</a></td></tr> <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#abb297424036e868212f5086d5c5235fe">bounds</a></td></tr> <tr><td class="memItemLeft" >union {</td></tr> <tr><td class="memItemLeft" >   <a class="el" href="group__curve.html#ga375a2b23705fb0698ae1d823243c8524">stp_curve_t</a> *   <a class="el" href="structstp__parameter__t.html#ad64f0c31d200d3d413725621b3ef9133">curve</a></td></tr> <tr><td class="memItemLeft" >   double   <a class="el" href="structstp__parameter__t.html#a222137e14dadb05adfbdde061679ce61">dbl</a></td></tr> <tr><td class="memItemLeft" >   int   <a class="el" href="structstp__parameter__t.html#a5d8633772783bb1c66ffa66d7f720a9d">dimension</a></td></tr> <tr><td class="memItemLeft" >   int   <a class="el" href="structstp__parameter__t.html#a3563548500d3ec917d8e1cf88c34f8cd">integer</a></td></tr> <tr><td class="memItemLeft" >   int   <a class="el" href="structstp__parameter__t.html#a74aaa2515728660657133ca3191e422c">boolean</a></td></tr> <tr><td class="memItemLeft" >   const char *   <a class="el" href="structstp__parameter__t.html#ae4409d001a6f1b7f8bbf237016900e48">str</a></td></tr> <tr><td class="memItemLeft" >   <a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a> *   <a class="el" href="structstp__parameter__t.html#a28aef58241d3a500968ca65df099ee3a">array</a></td></tr> <tr><td class="memItemLeft" valign="top">} </td><td class="memItemRight" valign="bottom"><a class="el" href="structstp__parameter__t.html#a79042d88fa0ab284a8e3e4ad7b969f90">deflt</a></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Parameter description. </p> </div><hr/><h2>Field Documentation</h2> <a class="anchor" id="a28aef58241d3a500968ca65df099ee3a"></a><!-- doxytag: member="stp_parameter_t::array" ref="a28aef58241d3a500968ca65df099ee3a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__array.html#ga26a474575a39c1c36ad520b95aa813b0">stp_array_t</a>* <a class="el" href="structstp__parameter__t.html#a28aef58241d3a500968ca65df099ee3a">stp_parameter_t::array</a></td> </tr> </table> </div> <div class="memdoc"> <p>array parameter value.</p> <p>Default array parameter value. </p> </div> </div> <a class="anchor" id="a74aaa2515728660657133ca3191e422c"></a><!-- doxytag: member="stp_parameter_t::boolean" ref="a74aaa2515728660657133ca3191e422c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structstp__parameter__t.html#a74aaa2515728660657133ca3191e422c">stp_parameter_t::boolean</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default boolean parameter value. </p> </div> </div> <a class="anchor" id="abb297424036e868212f5086d5c5235fe"></a><!-- doxytag: member="stp_parameter_t::bounds" ref="abb297424036e868212f5086d5c5235fe" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">union { ... } <a class="el" href="structstp__parameter__t.html#abb297424036e868212f5086d5c5235fe">stp_parameter_t::bounds</a></td> </tr> </table> </div> <div class="memdoc"> <p>Limits on the values the parameter may take. </p> </div> </div> <a class="anchor" id="a2cb67e4324a017746ca9bfda772aa50f"></a><!-- doxytag: member="stp_parameter_t::category" ref="a2cb67e4324a017746ca9bfda772aa50f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structstp__parameter__t.html#a2cb67e4324a017746ca9bfda772aa50f">stp_parameter_t::category</a></td> </tr> </table> </div> <div class="memdoc"> <p>User-visible category name. </p> </div> </div> <a class="anchor" id="a79bc0b76d5d5e238ddd205aa4a97ebad"></a><!-- doxytag: member="stp_parameter_t::channel" ref="a79bc0b76d5d5e238ddd205aa4a97ebad" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#a79bc0b76d5d5e238ddd205aa4a97ebad">stp_parameter_t::channel</a></td> </tr> </table> </div> <div class="memdoc"> <p>The channel to which this parameter applies </p> </div> </div> <a class="anchor" id="ad64f0c31d200d3d413725621b3ef9133"></a><!-- doxytag: member="stp_parameter_t::curve" ref="ad64f0c31d200d3d413725621b3ef9133" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__curve.html#ga375a2b23705fb0698ae1d823243c8524">stp_curve_t</a>* <a class="el" href="structstp__parameter__t.html#ad64f0c31d200d3d413725621b3ef9133">stp_parameter_t::curve</a></td> </tr> </table> </div> <div class="memdoc"> <p>curve parameter value.</p> <p>Default curve parameter value. </p> </div> </div> <a class="anchor" id="a222137e14dadb05adfbdde061679ce61"></a><!-- doxytag: member="stp_parameter_t::dbl" ref="a222137e14dadb05adfbdde061679ce61" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">double <a class="el" href="structstp__parameter__t.html#a12fc8869d3056687e576af63c6fbd675">stp_parameter_t::dbl</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default double parameter value. </p> </div> </div> <a class="anchor" id="a12fc8869d3056687e576af63c6fbd675"></a><!-- doxytag: member="stp_parameter_t::dbl" ref="a12fc8869d3056687e576af63c6fbd675" 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#a12fc8869d3056687e576af63c6fbd675">stp_parameter_t::dbl</a></td> </tr> </table> </div> <div class="memdoc"> <p>double_bound parameter value. </p> </div> </div> <a class="anchor" id="a79042d88fa0ab284a8e3e4ad7b969f90"></a><!-- doxytag: member="stp_parameter_t::deflt" ref="a79042d88fa0ab284a8e3e4ad7b969f90" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">union { ... } <a class="el" href="structstp__parameter__t.html#a79042d88fa0ab284a8e3e4ad7b969f90">stp_parameter_t::deflt</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default value of the parameter. </p> </div> </div> <a class="anchor" id="a29505a2b48cd755e10cedf01f3683d61"></a><!-- doxytag: member="stp_parameter_t::dimension" ref="a29505a2b48cd755e10cedf01f3683d61" 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#a29505a2b48cd755e10cedf01f3683d61">stp_parameter_t::dimension</a></td> </tr> </table> </div> <div class="memdoc"> <p>int_bound parameter value. </p> </div> </div> <a class="anchor" id="a5d8633772783bb1c66ffa66d7f720a9d"></a><!-- doxytag: member="stp_parameter_t::dimension" ref="a5d8633772783bb1c66ffa66d7f720a9d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structstp__parameter__t.html#a29505a2b48cd755e10cedf01f3683d61">stp_parameter_t::dimension</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default dimension parameter value. </p> </div> </div> <a class="anchor" id="a9f0637d6b97f0daa3122840eb2bd13db"></a><!-- doxytag: member="stp_parameter_t::help" ref="a9f0637d6b97f0daa3122840eb2bd13db" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structstp__parameter__t.html#a9f0637d6b97f0daa3122840eb2bd13db">stp_parameter_t::help</a></td> </tr> </table> </div> <div class="memdoc"> <p>Help string. </p> </div> </div> <a class="anchor" id="a3563548500d3ec917d8e1cf88c34f8cd"></a><!-- doxytag: member="stp_parameter_t::integer" ref="a3563548500d3ec917d8e1cf88c34f8cd" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int <a class="el" href="structstp__parameter__t.html#a32ee2ba322a0b7d16520f52ded591cc5">stp_parameter_t::integer</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default int parameter value. </p> </div> </div> <a class="anchor" id="a32ee2ba322a0b7d16520f52ded591cc5"></a><!-- doxytag: member="stp_parameter_t::integer" ref="a32ee2ba322a0b7d16520f52ded591cc5" 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#a32ee2ba322a0b7d16520f52ded591cc5">stp_parameter_t::integer</a></td> </tr> </table> </div> <div class="memdoc"> <p>int_bound parameter value. </p> </div> </div> <a class="anchor" id="a8b1af01f0874c79b6dbc4d0eca432952"></a><!-- doxytag: member="stp_parameter_t::is_active" ref="a8b1af01f0874c79b6dbc4d0eca432952" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#a8b1af01f0874c79b6dbc4d0eca432952">stp_parameter_t::is_active</a></td> </tr> </table> </div> <div class="memdoc"> <p>Is the parameter active? </p> </div> </div> <a class="anchor" id="ace4d02e3665f9cdfe83ed7dd559e1c1a"></a><!-- doxytag: member="stp_parameter_t::is_mandatory" ref="ace4d02e3665f9cdfe83ed7dd559e1c1a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#ace4d02e3665f9cdfe83ed7dd559e1c1a">stp_parameter_t::is_mandatory</a></td> </tr> </table> </div> <div class="memdoc"> <p>The parameter is required, even when set inactive. </p> </div> </div> <a class="anchor" id="a092430e582e7560fb532f546f78ca70c"></a><!-- doxytag: member="stp_parameter_t::name" ref="a092430e582e7560fb532f546f78ca70c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structstp__parameter__t.html#a092430e582e7560fb532f546f78ca70c">stp_parameter_t::name</a></td> </tr> </table> </div> <div class="memdoc"> <p>Internal name (key). </p> </div> </div> <a class="anchor" id="a410388e541bdb14fbd0af2984e229217"></a><!-- doxytag: member="stp_parameter_t::p_class" ref="a410388e541bdb14fbd0af2984e229217" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__vars.html#ga4eba7e712c0e17b76e472f26e202d7b8">stp_parameter_class_t</a> <a class="el" href="structstp__parameter__t.html#a410388e541bdb14fbd0af2984e229217">stp_parameter_t::p_class</a></td> </tr> </table> </div> <div class="memdoc"> <p>Parameter class. </p> </div> </div> <a class="anchor" id="a2a4a1195c06243e08acb03475fb1e7cc"></a><!-- doxytag: member="stp_parameter_t::p_level" ref="a2a4a1195c06243e08acb03475fb1e7cc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__vars.html#gaaa9c9265ffe70122bd33659cf2983207">stp_parameter_level_t</a> <a class="el" href="structstp__parameter__t.html#a2a4a1195c06243e08acb03475fb1e7cc">stp_parameter_t::p_level</a></td> </tr> </table> </div> <div class="memdoc"> <p>Parameter level. </p> </div> </div> <a class="anchor" id="aebe5dea02843240fe03461abf007f154"></a><!-- doxytag: member="stp_parameter_t::p_type" ref="aebe5dea02843240fe03461abf007f154" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="group__vars.html#ga9b3d4f47a44c0c8c9b150cddc56d2a91">stp_parameter_type_t</a> <a class="el" href="structstp__parameter__t.html#aebe5dea02843240fe03461abf007f154">stp_parameter_t::p_type</a></td> </tr> </table> </div> <div class="memdoc"> <p>Parameter type. </p> </div> </div> <a class="anchor" id="a4421135f9985be49d156cbc9aa74c710"></a><!-- doxytag: member="stp_parameter_t::read_only" ref="a4421135f9985be49d156cbc9aa74c710" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#a4421135f9985be49d156cbc9aa74c710">stp_parameter_t::read_only</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="abfe1adab94129fefdafe9e64be135fb6"></a><!-- doxytag: member="stp_parameter_t::str" ref="abfe1adab94129fefdafe9e64be135fb6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="string-list_8h.html#a5e3b69c7c2eca2523184cce51ca26543">stp_string_list_t</a>* <a class="el" href="structstp__parameter__t.html#abfe1adab94129fefdafe9e64be135fb6">stp_parameter_t::str</a></td> </tr> </table> </div> <div class="memdoc"> <p>string_list parameter value. </p> </div> </div> <a class="anchor" id="ae4409d001a6f1b7f8bbf237016900e48"></a><!-- doxytag: member="stp_parameter_t::str" ref="ae4409d001a6f1b7f8bbf237016900e48" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structstp__parameter__t.html#abfe1adab94129fefdafe9e64be135fb6">stp_parameter_t::str</a></td> </tr> </table> </div> <div class="memdoc"> <p>Default string parameter value. </p> </div> </div> <a class="anchor" id="a396e4980926c200e9ce4454f19e7311a"></a><!-- doxytag: member="stp_parameter_t::text" ref="a396e4980926c200e9ce4454f19e7311a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* <a class="el" href="structstp__parameter__t.html#a396e4980926c200e9ce4454f19e7311a">stp_parameter_t::text</a></td> </tr> </table> </div> <div class="memdoc"> <p>User-visible name. </p> </div> </div> <a class="anchor" id="a56100203c262c60d4cb18c7a49cde27d"></a><!-- doxytag: member="stp_parameter_t::verify_this_parameter" ref="a56100203c262c60d4cb18c7a49cde27d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">unsigned char <a class="el" href="structstp__parameter__t.html#a56100203c262c60d4cb18c7a49cde27d">stp_parameter_t::verify_this_parameter</a></td> </tr> </table> </div> <div class="memdoc"> <p>Should the verify system check this parameter? </p> </div> </div> <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></li> </ul> </div> <hr class="footer"/><address class="footer"><small>Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address> </body> </html>