Sophie

Sophie

distrib > Mageia > 6 > x86_64 > media > core-release > by-pkgid > 2a781e5f78e233aedaa1e51ed196dcc3 > files > 134

lib64zvbi-devel-0.2.35-5.mga6.x86_64.rpm

<!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.11"/>
<title>ZVBI Library: vbi_option_info Struct Reference</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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ZVBI Library
   &#160;<span id="projectnumber">0.2.35</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">vbi_option_info Struct Reference<div class="ingroups"><a class="el" href="group__HiDec.html">High Level Decoding</a> &raquo; <a class="el" href="group__Export.html">Exporting formatted Teletext and Closed Caption pages</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Information about an export option.  
 <a href="structvbi__option__info.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a364b4389e2ef22fe55e41a58a214b256"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a364b4389e2ef22fe55e41a58a214b256">type</a></td></tr>
<tr class="separator:a364b4389e2ef22fe55e41a58a214b256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d191050f97ab85f5066767519e47b76"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a4d191050f97ab85f5066767519e47b76">keyword</a></td></tr>
<tr class="separator:a4d191050f97ab85f5066767519e47b76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae3acfd80a23478631a72975118758770"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#ae3acfd80a23478631a72975118758770">label</a></td></tr>
<tr class="separator:ae3acfd80a23478631a72975118758770"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07d498c16856fe5f138d38efea740ea5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a07d498c16856fe5f138d38efea740ea5">def</a></td></tr>
<tr class="separator:a07d498c16856fe5f138d38efea740ea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a475ea9114c688bf06df5104c05462388"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a475ea9114c688bf06df5104c05462388">min</a></td></tr>
<tr class="separator:a475ea9114c688bf06df5104c05462388"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a931d86b787ed5597a537938172be8eae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a931d86b787ed5597a537938172be8eae">max</a></td></tr>
<tr class="separator:a931d86b787ed5597a537938172be8eae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d22687c4e5d379fe50096b854a5a4e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a6d22687c4e5d379fe50096b854a5a4e4">step</a></td></tr>
<tr class="separator:a6d22687c4e5d379fe50096b854a5a4e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afaad46a4148a5c8e79ecf3dace748796"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#afaad46a4148a5c8e79ecf3dace748796">menu</a></td></tr>
<tr class="separator:afaad46a4148a5c8e79ecf3dace748796"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1830d5ca540f535372f7e2d330b65d81"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#a1830d5ca540f535372f7e2d330b65d81">tooltip</a></td></tr>
<tr class="separator:a1830d5ca540f535372f7e2d330b65d81"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Information about an export option. </p>
<p>Although export options can be accessed by a static keyword they are by definition opaque: the client can present them to the user and manipulate them without knowing about their presence or purpose. To do so, some information about the option is necessary, given in this structure.</p>
<p>You can obtain this information with <a class="el" href="group__Export.html#ga700aed0e0a661593d573e26c31920448">vbi_export_option_info_enum()</a>. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="src_2exp-templ_8c-example.html#_a1">src/exp-templ.c</a>.</dd>
</dl></div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a364b4389e2ef22fe55e41a58a214b256"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> vbi_option_info::type</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

<p>Referenced by <a class="el" href="group__Export.html#gae471bb59f53847d20dffb2b12fde04db">vbi_export_info_export()</a>, <a class="el" href="group__Exmod.html#gacbceab3a49fc720f1df144e399dffb76">vbi_export_invalid_option()</a>, <a class="el" href="group__Export.html#gae397ba965b3620b7e58f6be9cf9d439e">vbi_export_option_menu_get()</a>, and <a class="el" href="group__Export.html#ga3f3ffe1fd0b7b143392076b4bfaef8fa">vbi_export_option_menu_set()</a>.</p>

</div>
</div>
<a class="anchor" id="a4d191050f97ab85f5066767519e47b76"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* vbi_option_info::keyword</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Unique (within the respective export module) keyword to identify this option. Can be stored in configuration files. </p>

<p>Referenced by <a class="el" href="group__Export.html#gae471bb59f53847d20dffb2b12fde04db">vbi_export_info_export()</a>, and <a class="el" href="group__Export.html#ga33ee2f2315315a18cfb54c138354d615">vbi_export_option_info_keyword()</a>.</p>

</div>
</div>
<a class="anchor" id="ae3acfd80a23478631a72975118758770"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* vbi_option_info::label</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Name of the option to be shown to the user. This can be <code>NULL</code> to indicate this option shall not be listed. Can be localized with dgettext("zvbi", label). </p>

</div>
</div>
<a class="anchor" id="a07d498c16856fe5f138d38efea740ea5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::def</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

<p>Referenced by <a class="el" href="group__Export.html#gae471bb59f53847d20dffb2b12fde04db">vbi_export_info_export()</a>.</p>

</div>
</div>
<a class="anchor" id="a475ea9114c688bf06df5104c05462388"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::min</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

<p>Referenced by <a class="el" href="group__Export.html#gae397ba965b3620b7e58f6be9cf9d439e">vbi_export_option_menu_get()</a>.</p>

</div>
</div>
<a class="anchor" id="a931d86b787ed5597a537938172be8eae"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::max</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

<p>Referenced by <a class="el" href="group__Export.html#ga3f3ffe1fd0b7b143392076b4bfaef8fa">vbi_export_option_menu_set()</a>.</p>

</div>
</div>
<a class="anchor" id="a6d22687c4e5d379fe50096b854a5a4e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::step</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

</div>
</div>
<a class="anchor" id="afaad46a4148a5c8e79ecf3dace748796"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a> vbi_option_info::menu</td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__Export.html#ga962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>

<p>Referenced by <a class="el" href="group__Export.html#gae471bb59f53847d20dffb2b12fde04db">vbi_export_info_export()</a>, <a class="el" href="group__Export.html#gae397ba965b3620b7e58f6be9cf9d439e">vbi_export_option_menu_get()</a>, and <a class="el" href="group__Export.html#ga3f3ffe1fd0b7b143392076b4bfaef8fa">vbi_export_option_menu_set()</a>.</p>

</div>
</div>
<a class="anchor" id="a1830d5ca540f535372f7e2d330b65d81"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* vbi_option_info::tooltip</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A brief description (or <code>NULL</code>) for the user. Can be localized with dgettext("zvbi", tooltip). </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>