<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ZVBI Library: vbi_option_info Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<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>vbi_option_info Struct Reference<br>
<small>
[<a class="el" href="group__Export.html">Exporting formatted Teletext and Closed Caption pages</a>]</small>
</h1><!-- doxytag: class="vbi_option_info" -->Information about an export option.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#364b4389e2ef22fe55e41a58a214b256">type</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#4d191050f97ab85f5066767519e47b76">keyword</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#e3acfd80a23478631a72975118758770">label</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#07d498c16856fe5f138d38efea740ea5">def</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#475ea9114c688bf06df5104c05462388">min</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#931d86b787ed5597a537938172be8eae">max</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#6d22687c4e5d379fe50096b854a5a4e4">step</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#faad46a4148a5c8e79ecf3dace748796">menu</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__option__info.html#1830d5ca540f535372f7e2d330b65d81">tooltip</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Information about an export option.
<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>
You can obtain this information with <a class="el" href="group__Export.html#g700aed0e0a661593d573e26c31920448">vbi_export_option_info_enum()</a>. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="src_2exp-templ_8c-example.html#_a1">src/exp-templ.c</a>.</dl><hr><h2>Field Documentation</h2>
<a class="anchor" name="364b4389e2ef22fe55e41a58a214b256"></a><!-- doxytag: member="vbi_option_info::type" ref="364b4389e2ef22fe55e41a58a214b256" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> <a class="el" href="structvbi__option__info.html#364b4389e2ef22fe55e41a58a214b256">vbi_option_info::type</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="4d191050f97ab85f5066767519e47b76"></a><!-- doxytag: member="vbi_option_info::keyword" ref="4d191050f97ab85f5066767519e47b76" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structvbi__option__info.html#4d191050f97ab85f5066767519e47b76">vbi_option_info::keyword</a> </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.
</div>
</div><p>
<a class="anchor" name="e3acfd80a23478631a72975118758770"></a><!-- doxytag: member="vbi_option_info::label" ref="e3acfd80a23478631a72975118758770" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structvbi__option__info.html#e3acfd80a23478631a72975118758770">vbi_option_info::label</a> </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).
</div>
</div><p>
<a class="anchor" name="07d498c16856fe5f138d38efea740ea5"></a><!-- doxytag: member="vbi_option_info::def" ref="07d498c16856fe5f138d38efea740ea5" args="" -->
<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> <a class="el" href="structvbi__option__info.html#07d498c16856fe5f138d38efea740ea5">vbi_option_info::def</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="475ea9114c688bf06df5104c05462388"></a><!-- doxytag: member="vbi_option_info::min" ref="475ea9114c688bf06df5104c05462388" args="" -->
<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> <a class="el" href="structvbi__option__info.html#475ea9114c688bf06df5104c05462388">vbi_option_info::min</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="931d86b787ed5597a537938172be8eae"></a><!-- doxytag: member="vbi_option_info::max" ref="931d86b787ed5597a537938172be8eae" args="" -->
<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> <a class="el" href="structvbi__option__info.html#931d86b787ed5597a537938172be8eae">vbi_option_info::max</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="6d22687c4e5d379fe50096b854a5a4e4"></a><!-- doxytag: member="vbi_option_info::step" ref="6d22687c4e5d379fe50096b854a5a4e4" args="" -->
<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> <a class="el" href="structvbi__option__info.html#6d22687c4e5d379fe50096b854a5a4e4">vbi_option_info::step</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="faad46a4148a5c8e79ecf3dace748796"></a><!-- doxytag: member="vbi_option_info::menu" ref="faad46a4148a5c8e79ecf3dace748796" args="" -->
<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> <a class="el" href="structvbi__option__info.html#faad46a4148a5c8e79ecf3dace748796">vbi_option_info::menu</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__Export.html#g962c6347c02825825c4dc57cef624e18">vbi_option_type</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="1830d5ca540f535372f7e2d330b65d81"></a><!-- doxytag: member="vbi_option_info::tooltip" ref="1830d5ca540f535372f7e2d330b65d81" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="structvbi__option__info.html#1830d5ca540f535372f7e2d330b65d81">vbi_option_info::tooltip</a> </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).
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed May 27 04:47:58 2009 for ZVBI Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
1af184c486f5d5f476d50602700ee0a0
>
files
>
68
