<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>gmerlin: Parameter description</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">gmerlin
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<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><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Parameter description</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union  </td><td class="memItemRight" valign="bottom"><a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Container for a parameter value. <a href="unionbg__parameter__value__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Parmeter description. <a href="structbg__parameter__info__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga29d6b1f41653160fc8f7f0be0cbe9d9e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga29d6b1f41653160fc8f7f0be0cbe9d9e">BG_PARAMETER_SYNC</a>   (1<<0)</td></tr>
<tr class="memdesc:ga29d6b1f41653160fc8f7f0be0cbe9d9e"><td class="mdescLeft"> </td><td class="mdescRight">Apply the value whenever the widgets value changes. <a href="#ga29d6b1f41653160fc8f7f0be0cbe9d9e">More...</a><br /></td></tr>
<tr class="separator:ga29d6b1f41653160fc8f7f0be0cbe9d9e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga2293456ab6e3f3b332642e1f8561d559"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga2293456ab6e3f3b332642e1f8561d559">BG_PARAMETER_HIDE_DIALOG</a>   (1<<1)</td></tr>
<tr class="memdesc:ga2293456ab6e3f3b332642e1f8561d559"><td class="mdescLeft"> </td><td class="mdescRight">Don't make a configuration widget (for objects, which change values themselves) <a href="#ga2293456ab6e3f3b332642e1f8561d559">More...</a><br /></td></tr>
<tr class="separator:ga2293456ab6e3f3b332642e1f8561d559"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gae7b85be0e0f82fa669d09d52e80a61ef"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#gae7b85be0e0f82fa669d09d52e80a61ef">BG_PARAMETER_NO_SORT</a>   (1<<2)</td></tr>
<tr class="memdesc:gae7b85be0e0f82fa669d09d52e80a61ef"><td class="mdescLeft"> </td><td class="mdescRight">Don't make a list sortable. <a href="#gae7b85be0e0f82fa669d09d52e80a61ef">More...</a><br /></td></tr>
<tr class="separator:gae7b85be0e0f82fa669d09d52e80a61ef"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0630caa000a881c0d6532b75a40f8518"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga0630caa000a881c0d6532b75a40f8518">BG_PARAMETER_PLUGIN</a>   (1<<3)</td></tr>
<tr class="memdesc:ga0630caa000a881c0d6532b75a40f8518"><td class="mdescLeft"> </td><td class="mdescRight">Parameter refers to a plugin. <a href="#ga0630caa000a881c0d6532b75a40f8518">More...</a><br /></td></tr>
<tr class="separator:ga0630caa000a881c0d6532b75a40f8518"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaafc4aa5fb6b37a57e06adc19561ef099"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#gaafc4aa5fb6b37a57e06adc19561ef099">BG_PARAMETER_OWN_SECTION</a>   (1<<4)</td></tr>
<tr class="memdesc:gaafc4aa5fb6b37a57e06adc19561ef099"><td class="mdescLeft"> </td><td class="mdescRight">For parameters of the type BG_PARAMETER_SECTION: Following parameters should be stored in an own section. <a href="#gaafc4aa5fb6b37a57e06adc19561ef099">More...</a><br /></td></tr>
<tr class="separator:gaafc4aa5fb6b37a57e06adc19561ef099"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga097df6bd98e5dd4145cba7d02412d2e2"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga097df6bd98e5dd4145cba7d02412d2e2">BG_PARAMETER_GLOBAL_PRESET</a>   (1<<5)</td></tr>
<tr class="memdesc:ga097df6bd98e5dd4145cba7d02412d2e2"><td class="mdescLeft"> </td><td class="mdescRight">Typedef for parmeter description. <a href="#ga097df6bd98e5dd4145cba7d02412d2e2">More...</a><br /></td></tr>
<tr class="separator:ga097df6bd98e5dd4145cba7d02412d2e2"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga2938a274fb8dd11ccb09b2443e21d9ab"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga2938a274fb8dd11ccb09b2443e21d9ab">bg_set_parameter_func_t</a> )(void *data, const char *name, const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *v)</td></tr>
<tr class="memdesc:ga2938a274fb8dd11ccb09b2443e21d9ab"><td class="mdescLeft"> </td><td class="mdescRight">Generic prototype for setting parameters in a module. <a href="#ga2938a274fb8dd11ccb09b2443e21d9ab">More...</a><br /></td></tr>
<tr class="separator:ga2938a274fb8dd11ccb09b2443e21d9ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga55a1c10315002062e6072aaab50f0e82"><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga55a1c10315002062e6072aaab50f0e82">bg_get_parameter_func_t</a> )(void *data, const char *name, <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *v)</td></tr>
<tr class="memdesc:ga55a1c10315002062e6072aaab50f0e82"><td class="mdescLeft"> </td><td class="mdescRight">Generic prototype for getting parameters from a module. <a href="#ga55a1c10315002062e6072aaab50f0e82">More...</a><br /></td></tr>
<tr class="separator:ga55a1c10315002062e6072aaab50f0e82"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga485cb1ae1f850f1d28241425e9555a2c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga485cb1ae1f850f1d28241425e9555a2c">bg_parameter_type_t</a> { <br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca25092139aa62c72322d6af45010988eb">BG_PARAMETER_SECTION</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caebdf145ac02247281276038831853660">BG_PARAMETER_CHECKBUTTON</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca51190e0dc82927424c40b5f61065e9b5">BG_PARAMETER_INT</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca6d86c0ec6f5b546d466e03592164e50d">BG_PARAMETER_FLOAT</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caef38d41b53ab4ce303724f2d46d73589">BG_PARAMETER_SLIDER_INT</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca52a7773f9a37d77d697331c9d3cf3c31">BG_PARAMETER_SLIDER_FLOAT</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2cabea75f0e743bba8872db286945d4a48c">BG_PARAMETER_STRING</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca6dd38a507e5c0d970a7b5221432457f8">BG_PARAMETER_STRING_HIDDEN</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca68a1ee4db8dddfb2b330292a9a4b57f0">BG_PARAMETER_STRINGLIST</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca51fc0d7b0f71970831a751cf6f972735">BG_PARAMETER_COLOR_RGB</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca2b24485d870b7d3f7cd78830cb1a85b5">BG_PARAMETER_COLOR_RGBA</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2cad370b957575639c91d0d0bbc9b7875fa">BG_PARAMETER_FONT</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca98aedec58df3ff6f4ea62ae6b6e3812a">BG_PARAMETER_DEVICE</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca5a342226a50a884e83a35d5f6be7c380">BG_PARAMETER_FILE</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caeb5c2655cdb61bf69e972d58f0754143">BG_PARAMETER_DIRECTORY</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca812906528e74bdea167c526522798635">BG_PARAMETER_MULTI_MENU</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caad31fcd30df8574b4cdead5a35868df9">BG_PARAMETER_MULTI_LIST</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caea2d16d14ae816ee5ed471f86624a23c">BG_PARAMETER_MULTI_CHAIN</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca5c75b46116ea6ac57fbd068c8c3e26d3">BG_PARAMETER_TIME</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2caf9c597ad57ab289dfd9ea5eccc6669cf">BG_PARAMETER_POSITION</a>,
<br />
  <a class="el" href="group__parameter.html#gga485cb1ae1f850f1d28241425e9555a2ca2fa9bd874ced11134614ebd57ca11b82">BG_PARAMETER_BUTTON</a>
<br />
}</td></tr>
<tr class="memdesc:ga485cb1ae1f850f1d28241425e9555a2c"><td class="mdescLeft"> </td><td class="mdescRight">Parameter type. <a href="group__parameter.html#ga485cb1ae1f850f1d28241425e9555a2c">More...</a><br /></td></tr>
<tr class="separator:ga485cb1ae1f850f1d28241425e9555a2c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga811d088d112d402b4f1ef398b35164e9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga811d088d112d402b4f1ef398b35164e9">bg_parameter_info_copy</a> (<a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *dst, const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *src)</td></tr>
<tr class="memdesc:ga811d088d112d402b4f1ef398b35164e9"><td class="mdescLeft"> </td><td class="mdescRight">Copy a single parameter info. <a href="#ga811d088d112d402b4f1ef398b35164e9">More...</a><br /></td></tr>
<tr class="separator:ga811d088d112d402b4f1ef398b35164e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9a239948bcaf809ecb797851fd9f14d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga9a239948bcaf809ecb797851fd9f14d8">bg_parameter_info_copy_array</a> (const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *src)</td></tr>
<tr class="memdesc:ga9a239948bcaf809ecb797851fd9f14d8"><td class="mdescLeft"> </td><td class="mdescRight">Copy a NULL terminated parameter array. <a href="#ga9a239948bcaf809ecb797851fd9f14d8">More...</a><br /></td></tr>
<tr class="separator:ga9a239948bcaf809ecb797851fd9f14d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga6775e05f6960267b839b1a9ce9e03f22"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga6775e05f6960267b839b1a9ce9e03f22">bg_parameter_info_set_const_ptrs</a> (<a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info)</td></tr>
<tr class="memdesc:ga6775e05f6960267b839b1a9ce9e03f22"><td class="mdescLeft"> </td><td class="mdescRight">Set the const pointers of a dynamically allocated parameter info. <a href="#ga6775e05f6960267b839b1a9ce9e03f22">More...</a><br /></td></tr>
<tr class="separator:ga6775e05f6960267b839b1a9ce9e03f22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga394bbc66cc56d03f762fd53d1b55cca9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga394bbc66cc56d03f762fd53d1b55cca9">bg_parameter_info_destroy_array</a> (<a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info)</td></tr>
<tr class="memdesc:ga394bbc66cc56d03f762fd53d1b55cca9"><td class="mdescLeft"> </td><td class="mdescRight">Free a NULL terminated parameter array. <a href="#ga394bbc66cc56d03f762fd53d1b55cca9">More...</a><br /></td></tr>
<tr class="separator:ga394bbc66cc56d03f762fd53d1b55cca9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga0f97ab6754e8064506bec87d3fdd2b66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga0f97ab6754e8064506bec87d3fdd2b66">bg_parameter_value_copy</a> (<a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *dst, const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *src, const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info)</td></tr>
<tr class="memdesc:ga0f97ab6754e8064506bec87d3fdd2b66"><td class="mdescLeft"> </td><td class="mdescRight">Copy a parameter value. <a href="#ga0f97ab6754e8064506bec87d3fdd2b66">More...</a><br /></td></tr>
<tr class="separator:ga0f97ab6754e8064506bec87d3fdd2b66"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1722917f8a346c5a8dae7178a5e84522"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga1722917f8a346c5a8dae7178a5e84522">bg_parameter_value_free</a> (<a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *val, <a class="el" href="group__parameter.html#ga485cb1ae1f850f1d28241425e9555a2c">bg_parameter_type_t</a> type)</td></tr>
<tr class="memdesc:ga1722917f8a346c5a8dae7178a5e84522"><td class="mdescLeft"> </td><td class="mdescRight">Free a parameter value. <a href="#ga1722917f8a346c5a8dae7178a5e84522">More...</a><br /></td></tr>
<tr class="separator:ga1722917f8a346c5a8dae7178a5e84522"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga16c7a1ac408ea8840018c627d742bd51"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga16c7a1ac408ea8840018c627d742bd51">bg_parameter_info_concat_arrays</a> (<a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> const **srcs)</td></tr>
<tr class="memdesc:ga16c7a1ac408ea8840018c627d742bd51"><td class="mdescLeft"> </td><td class="mdescRight">Concatenate multiple arrays into one. <a href="#ga16c7a1ac408ea8840018c627d742bd51">More...</a><br /></td></tr>
<tr class="separator:ga16c7a1ac408ea8840018c627d742bd51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga38d92459a765c23f59a754bc1386cd83"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga38d92459a765c23f59a754bc1386cd83">bg_parameter_get_selected</a> (const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info, const char *val)</td></tr>
<tr class="memdesc:ga38d92459a765c23f59a754bc1386cd83"><td class="mdescLeft"> </td><td class="mdescRight">Get the index for a multi-options parameter. <a href="#ga38d92459a765c23f59a754bc1386cd83">More...</a><br /></td></tr>
<tr class="separator:ga38d92459a765c23f59a754bc1386cd83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga39f54bd272e557b5d55e6b7290a5dcb4"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga39f54bd272e557b5d55e6b7290a5dcb4">bg_parameter_find</a> (const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info, const char *name)</td></tr>
<tr class="memdesc:ga39f54bd272e557b5d55e6b7290a5dcb4"><td class="mdescLeft"> </td><td class="mdescRight">Find a parameter info. <a href="#ga39f54bd272e557b5d55e6b7290a5dcb4">More...</a><br /></td></tr>
<tr class="separator:ga39f54bd272e557b5d55e6b7290a5dcb4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaf79bfb7a44e89f9882cd99d6123066ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#gaf79bfb7a44e89f9882cd99d6123066ec">bg_xml_2_parameters</a> (xmlDocPtr xml_doc, xmlNodePtr xml_parameters)</td></tr>
<tr class="memdesc:gaf79bfb7a44e89f9882cd99d6123066ec"><td class="mdescLeft"> </td><td class="mdescRight">Convert a libxml2 node into a parameter array. <a href="#gaf79bfb7a44e89f9882cd99d6123066ec">More...</a><br /></td></tr>
<tr class="separator:gaf79bfb7a44e89f9882cd99d6123066ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga8efd0779e8c6e3425bc345a0d99e3374"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#ga8efd0779e8c6e3425bc345a0d99e3374">bg_parameters_2_xml</a> (const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info, xmlNodePtr xml_parameters)</td></tr>
<tr class="memdesc:ga8efd0779e8c6e3425bc345a0d99e3374"><td class="mdescLeft"> </td><td class="mdescRight">Convert a parameter array into a libxml2 node. <a href="#ga8efd0779e8c6e3425bc345a0d99e3374">More...</a><br /></td></tr>
<tr class="separator:ga8efd0779e8c6e3425bc345a0d99e3374"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gadbe67481b83f530056e6d9684d8f8f6c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__parameter.html#gadbe67481b83f530056e6d9684d8f8f6c">bg_parameters_dump</a> (const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> *info, const char *filename)</td></tr>
<tr class="memdesc:gadbe67481b83f530056e6d9684d8f8f6c"><td class="mdescLeft"> </td><td class="mdescRight">Dump a parameter array into a xml file. <a href="#gadbe67481b83f530056e6d9684d8f8f6c">More...</a><br /></td></tr>
<tr class="separator:gadbe67481b83f530056e6d9684d8f8f6c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Parameters are universal data containers, which are the basis for all configuration mechanisms.</p>
<p>A configurable module foo, should provide at least 2 functions. One, which lets the application get a null-terminated array of parameter description and one of type <a class="el" href="group__parameter.html#ga2938a274fb8dd11ccb09b2443e21d9ab">bg_set_parameter_func_t</a>. It's up to the module, if the parameter array is allocated per instance or if it's just a static array. Some parameters (e.g. window coordinates) are not configured by a dialog. Instead, they are changed by the module. For these parameters, set <a class="el" href="group__parameter.html#ga2293456ab6e3f3b332642e1f8561d559">BG_PARAMETER_HIDE_DIALOG</a> for the flags and provide another function of type <a class="el" href="group__parameter.html#ga55a1c10315002062e6072aaab50f0e82">bg_get_parameter_func_t</a>, which lets the core read the updated value. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga29d6b1f41653160fc8f7f0be0cbe9d9e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_SYNC   (1<<0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Apply the value whenever the widgets value changes. </p>
</div>
</div>
<a class="anchor" id="ga2293456ab6e3f3b332642e1f8561d559"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_HIDE_DIALOG   (1<<1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Don't make a configuration widget (for objects, which change values themselves) </p>
</div>
</div>
<a class="anchor" id="gae7b85be0e0f82fa669d09d52e80a61ef"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_NO_SORT   (1<<2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Don't make a list sortable. </p>
</div>
</div>
<a class="anchor" id="ga0630caa000a881c0d6532b75a40f8518"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_PLUGIN   (1<<3)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter refers to a plugin. </p>
</div>
</div>
<a class="anchor" id="gaafc4aa5fb6b37a57e06adc19561ef099"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_OWN_SECTION   (1<<4)</td>
</tr>
</table>
</div><div class="memdoc">
<p>For parameters of the type BG_PARAMETER_SECTION: Following parameters should be stored in an own section. </p>
</div>
</div>
<a class="anchor" id="ga097df6bd98e5dd4145cba7d02412d2e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BG_PARAMETER_GLOBAL_PRESET   (1<<5)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Typedef for parmeter description. </p>
<p>For parameters of the type BG_PARAMETER_SECTION: There should be one preset for all following sections </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga2938a274fb8dd11ccb09b2443e21d9ab"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* bg_set_parameter_func_t)(void *data, const char *name, const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *v)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic prototype for setting parameters in a module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Instance </td></tr>
<tr><td class="paramname">name</td><td>Name of the parameter </td></tr>
<tr><td class="paramname">v</td><td>Value</td></tr>
</table>
</dd>
</dl>
<p>This function is usually called from "Apply" buttons in config dialogs. It's called subsequently for all defined püarameters. After that, it <em>must</em> be called with a NULL argument for the name to signal, that all parameters are set. Modules can do some additional setup stuff then. If not, the name == NULL case must be handled nevertheless. </p>
</div>
</div>
<a class="anchor" id="ga55a1c10315002062e6072aaab50f0e82"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* bg_get_parameter_func_t)(void *data, const char *name, <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> *v)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Generic prototype for getting parameters from a module. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>Instance </td></tr>
<tr><td class="paramname">name</td><td>Name of the parameter </td></tr>
<tr><td class="paramname">v</td><td>Value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if a parameter was found and set, 0 else.</dd></dl>
<p>Provide this function, if your module changes parameters by itself. Set the <a class="el" href="group__parameter.html#ga2293456ab6e3f3b332642e1f8561d559">BG_PARAMETER_HIDE_DIALOG</a> to prevent building config dialogs for those parameters. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga485cb1ae1f850f1d28241425e9555a2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__parameter.html#ga485cb1ae1f850f1d28241425e9555a2c">bg_parameter_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Parameter type. </p>
<p>These define both the data type and the appearance of an eventual configuration widget. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca25092139aa62c72322d6af45010988eb"></a>BG_PARAMETER_SECTION </td><td class="fielddoc">
<p>Dummy type. It contains no data but acts as a separator in notebook style configuration windows. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caebdf145ac02247281276038831853660"></a>BG_PARAMETER_CHECKBUTTON </td><td class="fielddoc">
<p>Bool. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca51190e0dc82927424c40b5f61065e9b5"></a>BG_PARAMETER_INT </td><td class="fielddoc">
<p>Integer spinbutton. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca6d86c0ec6f5b546d466e03592164e50d"></a>BG_PARAMETER_FLOAT </td><td class="fielddoc">
<p>Float spinbutton. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caef38d41b53ab4ce303724f2d46d73589"></a>BG_PARAMETER_SLIDER_INT </td><td class="fielddoc">
<p>Integer slider. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca52a7773f9a37d77d697331c9d3cf3c31"></a>BG_PARAMETER_SLIDER_FLOAT </td><td class="fielddoc">
<p>Float slider. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2cabea75f0e743bba8872db286945d4a48c"></a>BG_PARAMETER_STRING </td><td class="fielddoc">
<p>String (one line only) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca6dd38a507e5c0d970a7b5221432457f8"></a>BG_PARAMETER_STRING_HIDDEN </td><td class="fielddoc">
<p>Encrypted string (displays as ***) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca68a1ee4db8dddfb2b330292a9a4b57f0"></a>BG_PARAMETER_STRINGLIST </td><td class="fielddoc">
<p>Popdown menu with string values. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca51fc0d7b0f71970831a751cf6f972735"></a>BG_PARAMETER_COLOR_RGB </td><td class="fielddoc">
<p>RGB Color. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca2b24485d870b7d3f7cd78830cb1a85b5"></a>BG_PARAMETER_COLOR_RGBA </td><td class="fielddoc">
<p>RGBA Color. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2cad370b957575639c91d0d0bbc9b7875fa"></a>BG_PARAMETER_FONT </td><td class="fielddoc">
<p>Font (contains fontconfig compatible fontname) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca98aedec58df3ff6f4ea62ae6b6e3812a"></a>BG_PARAMETER_DEVICE </td><td class="fielddoc">
<p>Device. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca5a342226a50a884e83a35d5f6be7c380"></a>BG_PARAMETER_FILE </td><td class="fielddoc">
<p>File. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caeb5c2655cdb61bf69e972d58f0754143"></a>BG_PARAMETER_DIRECTORY </td><td class="fielddoc">
<p>Directory. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca812906528e74bdea167c526522798635"></a>BG_PARAMETER_MULTI_MENU </td><td class="fielddoc">
<p>Menu with config- and infobutton. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caad31fcd30df8574b4cdead5a35868df9"></a>BG_PARAMETER_MULTI_LIST </td><td class="fielddoc">
<p>List with config- and infobutton. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caea2d16d14ae816ee5ed471f86624a23c"></a>BG_PARAMETER_MULTI_CHAIN </td><td class="fielddoc">
<p>Several subitems (including suboptions) can be arranged in a chain. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca5c75b46116ea6ac57fbd068c8c3e26d3"></a>BG_PARAMETER_TIME </td><td class="fielddoc">
<p>Time. </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2caf9c597ad57ab289dfd9ea5eccc6669cf"></a>BG_PARAMETER_POSITION </td><td class="fielddoc">
<p>Position (x/y coordinates, scaled 0..1) </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga485cb1ae1f850f1d28241425e9555a2ca2fa9bd874ced11134614ebd57ca11b82"></a>BG_PARAMETER_BUTTON </td><td class="fielddoc">
<p>Pressing the button causes set_parameter to be called with NULL value. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga811d088d112d402b4f1ef398b35164e9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameter_info_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>src</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy a single parameter info. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source </td></tr>
<tr><td class="paramname">dst</td><td>Destination </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga9a239948bcaf809ecb797851fd9f14d8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a>* bg_parameter_info_copy_array </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy a NULL terminated parameter array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source array</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly allocated parameter array, whose contents are copied from src.</dd></dl>
<p>Use <a class="el" href="group__parameter.html#ga394bbc66cc56d03f762fd53d1b55cca9">bg_parameter_info_destroy_array</a> to free the returned array. </p>
</div>
</div>
<a class="anchor" id="ga6775e05f6960267b839b1a9ce9e03f22"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameter_info_set_const_ptrs </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the const pointers of a dynamically allocated parameter info. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A parameter info</td></tr>
</table>
</dd>
</dl>
<p>This copied the adresses of the *_nc pointers to their constant equivalents. Use this for each parameter in routines, which dynamically allocate parameter infos. </p>
</div>
</div>
<a class="anchor" id="ga394bbc66cc56d03f762fd53d1b55cca9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameter_info_destroy_array </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a NULL terminated parameter array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Parameter array </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga0f97ab6754e8064506bec87d3fdd2b66"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameter_value_copy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> * </td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy a parameter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dst</td><td>Destination </td></tr>
<tr><td class="paramname">src</td><td>Source </td></tr>
<tr><td class="paramname">info</td><td>Parameter description</td></tr>
</table>
</dd>
</dl>
<p>Make sure, that dst is either memset to 0 or contains data, which was created by <a class="el" href="group__parameter.html#ga0f97ab6754e8064506bec87d3fdd2b66">bg_parameter_value_copy</a> </p>
</div>
</div>
<a class="anchor" id="ga1722917f8a346c5a8dae7178a5e84522"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameter_value_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unionbg__parameter__value__t.html">bg_parameter_value_t</a> * </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__parameter.html#ga485cb1ae1f850f1d28241425e9555a2c">bg_parameter_type_t</a> </td>
<td class="paramname"><em>type</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a parameter value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>A parameter value </td></tr>
<tr><td class="paramname">type</td><td>Type of the parameter </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ga16c7a1ac408ea8840018c627d742bd51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a>* bg_parameter_info_concat_arrays </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> const ** </td>
<td class="paramname"><em>srcs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Concatenate multiple arrays into one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">srcs</td><td>NULL terminated array of source arrays </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly allocated array </dd></dl>
</div>
</div>
<a class="anchor" id="ga38d92459a765c23f59a754bc1386cd83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bg_parameter_get_selected </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>val</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index for a multi-options parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A parameter info </td></tr>
<tr><td class="paramname">val</td><td>The value </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The index of val in the multi_names array</dd></dl>
<p>If val does not occur in the multi_names[] array, try the default value. If that fails as well, return 0. </p>
</div>
</div>
<a class="anchor" id="ga39f54bd272e557b5d55e6b7290a5dcb4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a>* bg_parameter_find </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find a parameter info. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>A parameter info </td></tr>
<tr><td class="paramname">name</td><td>The name of the the parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Parameter info matching name or NULL</dd></dl>
<p>This function looks for a parameter info with the given name in an array or parameters. Sub-parameters are also searched. </p>
</div>
</div>
<a class="anchor" id="gaf79bfb7a44e89f9882cd99d6123066ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a>* bg_xml_2_parameters </td>
<td>(</td>
<td class="paramtype">xmlDocPtr </td>
<td class="paramname"><em>xml_doc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"><em>xml_parameters</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a libxml2 node into a parameter array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">xml_doc</td><td>Pointer to the xml document </td></tr>
<tr><td class="paramname">xml_parameters</td><td>Pointer to the xml node containing the parameters </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A newly allocated array</dd></dl>
<p>See the libxml2 documentation for more infos </p>
</div>
</div>
<a class="anchor" id="ga8efd0779e8c6e3425bc345a0d99e3374"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameters_2_xml </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">xmlNodePtr </td>
<td class="paramname"><em>xml_parameters</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a parameter array into a libxml2 node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Parameter array </td></tr>
<tr><td class="paramname">xml_parameters</td><td>Pointer to the xml node for the parameters</td></tr>
</table>
</dd>
</dl>
<p>See the libxml2 documentation for more infos </p>
</div>
</div>
<a class="anchor" id="gadbe67481b83f530056e6d9684d8f8f6c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bg_parameters_dump </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structbg__parameter__info__s.html">bg_parameter_info_t</a> * </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>filename</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Dump a parameter array into a xml file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>Parameter array </td></tr>
<tr><td class="paramname">filename</td><td>File to dump to</td></tr>
</table>
</dd>
</dl>
<p>Used for debugging </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 19 2019 17:35:38 for gmerlin by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.8
</small></address>
</body>
</html>
