<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>vbi_option_info struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindex" href="examples.html">Examples</a> </center>
<hr><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>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 nowrap align=right valign=top><a class="el" href="group__Export.html#a16">vbi_option_type</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m0">type</a></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m1">keyword</a></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m2">label</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m3">def</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m4">min</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m5">max</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="unionvbi__option__value.html">vbi_option_value</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m6">step</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a> </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m7">menu</a></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="structvbi__option__info.html#m8">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#a7">vbi_export_option_info_enum()</a>. <dl compact><dt><b>Examples: </b></dt><dd>
<p>
<a class="el" href="exp-templ_8c-example.html#_a1">exp-templ.c</a>.</dl>
<p>
<hr><h2>Field Documentation</h2>
<a name="m0" doxytag="vbi_option_info::type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="group__Export.html#a16">vbi_option_type</a> vbi_option_info::type
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m1" doxytag="vbi_option_info::keyword"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* vbi_option_info::keyword
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Unique (within the respective export module) keyword to identify this option. Can be stored in configuration files. </td>
</tr>
</table>
<a name="m2" doxytag="vbi_option_info::label"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* vbi_option_info::label
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<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). </td>
</tr>
</table>
<a name="m3" doxytag="vbi_option_info::def"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::def
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m4" doxytag="vbi_option_info::min"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::min
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m5" doxytag="vbi_option_info::max"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::max
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m6" doxytag="vbi_option_info::step"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="unionvbi__option__value.html">vbi_option_value</a> vbi_option_info::step
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m7" doxytag="vbi_option_info::menu"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="unionvbi__option__value__ptr.html">vbi_option_value_ptr</a> vbi_option_info::menu
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="group__Export.html#a16">vbi_option_type</a> </dl> </td>
</tr>
</table>
<a name="m8" doxytag="vbi_option_info::tooltip"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* vbi_option_info::tooltip
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
A brief description (or <code>NULL)</code> for the user. Can be localized with dgettext("zvbi", tooltip). </td>
</tr>
</table>
<hr><address style="align: right;"><small>Generated on Thu Jan 2 16:03:41 2003 for ZVBI Library by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>
