Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > media > main-release > by-pkgid > 1af184c486f5d5f476d50602700ee0a0 > files > 66

lib64zvbi-devel-0.2.33-2mdv2010.0.x86_64.rpm

<!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_link 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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&nbsp;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vbi_link Struct Reference<br>
<small>
[<a class="el" href="group__Event.html">Events</a>]</small>
</h1><!-- doxytag: class="vbi_link" --><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__Event.html#ga8fa9488512f585b82ddd303ae3fb55d">vbi_link_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#0ef701d4a44a454002c116c072397517">type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#5c76efcbde60e41c1324c5a1c89ff999">eacem</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">signed char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#fd89f6d3ef51f0bc1c4969b8890bcb1d">name</a> [80]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4ba7126a995470878d8eae3ab2fc2e0"></a><!-- doxytag: member="vbi_link::url" ref="a4ba7126a995470878d8eae3ab2fc2e0" args="[256]" -->
signed char&nbsp;</td><td class="memItemRight" valign="bottom"><b>url</b> [256]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">signed char&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#70994cdd20219df8790829e1caa6a248">script</a> [256]</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Event.html#gf7674e0718ecde1f3340325e34296b6a">vbi_nuid</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#25db18a1b174a2c196790107ba26464b">nuid</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__HiDec.html#g8711c9b42b61d518b7f79e941fe94eb1">vbi_pgno</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#0c3ebdf0f866e26709f59e8b5b985730">pgno</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b478ff697a292d2156cd09ea853936ac"></a><!-- doxytag: member="vbi_link::subno" ref="b478ff697a292d2156cd09ea853936ac" args="" -->
<a class="el" href="group__HiDec.html#g06ee2e75548bbd0fcca06a71395c940e">vbi_subno</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>subno</b></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#6a817175c5af545750a763d5424d1237">expires</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__Event.html#g2276e95c9c29f0799c4bc1b2b9641bdb">vbi_itv_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#d7c7003788b284ac043ce4d59c772e58">itv_type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#9c59cc1efd0b8cd1560294ed53534b1d">priority</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">vbi_bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structvbi__link.html#ff33e29b5e92b834d16e6aebaeafc20b">autoload</a></td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
General purpose link description for ATVEF (ITV, WebTV in the United States) and EACEM (SuperTeletext et al in Europe) triggers, Teletext TOP and FLOF navigation, and for links "guessed" by libzvbi from the text (e. g. page numbers and URLs). Usually not all fields will be used. <hr><h2>Field Documentation</h2>
<a class="anchor" name="0ef701d4a44a454002c116c072397517"></a><!-- doxytag: member="vbi_link::type" ref="0ef701d4a44a454002c116c072397517" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Event.html#ga8fa9488512f585b82ddd303ae3fb55d">vbi_link_type</a> <a class="el" href="structvbi__link.html#0ef701d4a44a454002c116c072397517">vbi_link::type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
See vbi_link_type. 
</div>
</div><p>
<a class="anchor" name="5c76efcbde60e41c1324c5a1c89ff999"></a><!-- doxytag: member="vbi_link::eacem" ref="5c76efcbde60e41c1324c5a1c89ff999" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool <a class="el" href="structvbi__link.html#5c76efcbde60e41c1324c5a1c89ff999">vbi_link::eacem</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Links can be obtained two ways, via <a class="el" href="event_8h.html#VBI_EVENT_TRIGGER">VBI_EVENT_TRIGGER</a>, then it arrived either through the EACEM or ATVEF transport method as flagged by this field. Or it is a navigational link returned by vbi_resolve_link(), then this field does not apply. 
</div>
</div><p>
<a class="anchor" name="fd89f6d3ef51f0bc1c4969b8890bcb1d"></a><!-- doxytag: member="vbi_link::name" ref="fd89f6d3ef51f0bc1c4969b8890bcb1d" args="[80]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">signed char <a class="el" href="structvbi__link.html#fd89f6d3ef51f0bc1c4969b8890bcb1d">vbi_link::name</a>[80]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Some descriptive text, Latin-1, possibly blank. 
</div>
</div><p>
<a class="anchor" name="70994cdd20219df8790829e1caa6a248"></a><!-- doxytag: member="vbi_link::script" ref="70994cdd20219df8790829e1caa6a248" args="[256]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">signed char <a class="el" href="structvbi__link.html#70994cdd20219df8790829e1caa6a248">vbi_link::script</a>[256]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
A piece of ECMA script (Javascript), this may be used on WebTV or SuperTeletext pages to trigger some action. Usually blank. 
</div>
</div><p>
<a class="anchor" name="25db18a1b174a2c196790107ba26464b"></a><!-- doxytag: member="vbi_link::nuid" ref="25db18a1b174a2c196790107ba26464b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Event.html#gf7674e0718ecde1f3340325e34296b6a">vbi_nuid</a> <a class="el" href="structvbi__link.html#25db18a1b174a2c196790107ba26464b">vbi_link::nuid</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Teletext page links (no Closed Caption counterpart) can can actually reach across networks. That happens for example when vbi_resolve_link() picked up a link on a page after we switch away from that channel, or with EACEM triggers deliberately pointing to a page on another network (sic!). So the network id (if known, otherwise 0) is part of the page number. See vbi_nuid. 
</div>
</div><p>
<a class="anchor" name="0c3ebdf0f866e26709f59e8b5b985730"></a><!-- doxytag: member="vbi_link::pgno" ref="0c3ebdf0f866e26709f59e8b5b985730" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__HiDec.html#g8711c9b42b61d518b7f79e941fe94eb1">vbi_pgno</a> <a class="el" href="structvbi__link.html#0c3ebdf0f866e26709f59e8b5b985730">vbi_link::pgno</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<em>pgno</em> and <em>subno</em> Teletext page number, see vbi_pgno, vbi_subno. 
</div>
</div><p>
<a class="anchor" name="6a817175c5af545750a763d5424d1237"></a><!-- doxytag: member="vbi_link::expires" ref="6a817175c5af545750a763d5424d1237" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structvbi__link.html#6a817175c5af545750a763d5424d1237">vbi_link::expires</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
The time in seconds and fractions since 1970-01-01 00:00 when the link should no longer be offered to the user, similar to a HTTP cache expiration date. 
</div>
</div><p>
<a class="anchor" name="d7c7003788b284ac043ce4d59c772e58"></a><!-- doxytag: member="vbi_link::itv_type" ref="d7c7003788b284ac043ce4d59c772e58" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Event.html#g2276e95c9c29f0799c4bc1b2b9641bdb">vbi_itv_type</a> <a class="el" href="structvbi__link.html#d7c7003788b284ac043ce4d59c772e58">vbi_link::itv_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
See vbi_itv_type. This field applies only to ATVEF triggers, is otherwise <code>VBI_WEBLINK_UNKNOWN</code>. 
</div>
</div><p>
<a class="anchor" name="9c59cc1efd0b8cd1560294ed53534b1d"></a><!-- doxytag: member="vbi_link::priority" ref="9c59cc1efd0b8cd1560294ed53534b1d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structvbi__link.html#9c59cc1efd0b8cd1560294ed53534b1d">vbi_link::priority</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Trigger priority. 0 = emergency, should never be blocked. 1 or 2 = "high", 3 ... 5 = "medium", 6 ... 9 = "low". The default is 9. Apart of filtering triggers, this is also used to determine at which priority multiple links should be presented to the user. This field applies only to EACEM triggers, is otherwise 9. 
</div>
</div><p>
<a class="anchor" name="ff33e29b5e92b834d16e6aebaeafc20b"></a><!-- doxytag: member="vbi_link::autoload" ref="ff33e29b5e92b834d16e6aebaeafc20b" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vbi_bool <a class="el" href="structvbi__link.html#ff33e29b5e92b834d16e6aebaeafc20b">vbi_link::autoload</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Open the target without user confirmation. (Supposedly this flag will be used to trigger scripts, not to open pages, but I have yet to see such a trigger.) 
</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&nbsp;
<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>