<!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"/>
<title>libkate: kate_event 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.6.1 -->
<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="files.html"><span>Files</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>kate_event Struct Reference</h1><!-- doxytag: class="kate_event" -->
<p><code>#include <<a class="el" href="kate_8h_source.html">kate.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ac27b75614b6be88d1f34b06a68707718">start</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ab64597170d6f5846856b511976d13ef1">duration</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ac2d40ab7a382849ef04516cac502d89c">backlink</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_float </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ad51c57b3be877b92877689e59f60713b">start_time</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_float </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a32b8fb798d3aeb6b089c218aa6af3029">end_time</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a0a6098c2607c99dbaf2afbd20d1a70b8">id</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="kate_8h.html#a9e8a915382d068016312baad10053902">kate_text_encoding</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a9e44f3d25703ce86eccc7fc692b8d9d2">text_encoding</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="kate_8h.html#accb7b9d9ec6e956fa1096f2064a6321e">kate_text_directionality</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a04035a6778e1587a5c74fa5488cca88f">text_directionality</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a7720b51cbd553648b268bab54d30c78b">language</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ae10745a5078521816cc07a09654fbfd4">text</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a1248458b9fe7a7f51ca90cddf952c056">len</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a0ba64f13c042b512a0a16e9baef3f08b">len0</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#aa0d93c4f71a2aa32a253afd6a3676a28">nmotions</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__motion.html">kate_motion</a> <br class="typebreak"/>
*kate_const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ac35329e23855fa49d5d5132f78552103">motions</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__region.html">kate_region</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a55fc1e968d784c76cb41edefd06536bc">region</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__style.html">kate_style</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ac9a93dcff7df4ba077a7e6208c8d2c94">style</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__style.html">kate_style</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a86a059704037808ce36119008af58b14">secondary_style</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__font__mapping.html">kate_font_mapping</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a672aa826358c2af300d781adc83a599d">font_mapping</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__palette.html">kate_palette</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ae978159e8d25213ee6d7b3e33588eb69">palette</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#a9fe1fe113309e07b13a65a2835b85335">bitmap</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="kate_8h.html#a300e0138b6959cdad4a33068abc89464">kate_markup_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ad48b629f73a3cc49c7b5dfab2d21b561">text_markup_type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ad942c3dc121637459e61fe4e56572483">nbitmaps</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">kate_const <a class="el" href="structkate__bitmap.html">kate_bitmap</a> <br class="typebreak"/>
*kate_const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structkate__event.html#ad61693c32f3b294208125296ee802834">bitmaps</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is an event passed to the user. A <a class="el" href="structkate__tracker.html">kate_tracker</a> may be used to track animation changes to this event. </p>
<dl><dt><b>Examples: </b></dt><dd>
<p><a class="el" href="decoding_8c-example.html#_a3">decoding.c</a>, and <a class="el" href="high_8c-example.html#_a1">high.c</a>.</p>
</dd>
</dl><hr/><h2>Field Documentation</h2>
<a class="anchor" id="ac2d40ab7a382849ef04516cac502d89c"></a><!-- doxytag: member="kate_event::backlink" ref="ac2d40ab7a382849ef04516cac502d89c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t <a class="el" href="structkate__event.html#ac2d40ab7a382849ef04516cac502d89c">kate_event::backlink</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the relative offset in granules since the start of the earliest still active event (positive or zero) </p>
</div>
</div>
<a class="anchor" id="a9fe1fe113309e07b13a65a2835b85335"></a><!-- doxytag: member="kate_event::bitmap" ref="a9fe1fe113309e07b13a65a2835b85335" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__bitmap.html">kate_bitmap</a>* <a class="el" href="structkate__event.html#a9fe1fe113309e07b13a65a2835b85335">kate_event::bitmap</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>bitmap to use as background (may be NULL for none) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00147">kate_tracker_remap()</a>.</p>
</div>
</div>
<a class="anchor" id="ad61693c32f3b294208125296ee802834"></a><!-- doxytag: member="kate_event::bitmaps" ref="ad61693c32f3b294208125296ee802834" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__bitmap.html">kate_bitmap</a>* kate_const* <a class="el" href="structkate__event.html#ad61693c32f3b294208125296ee802834">kate_event::bitmaps</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the list of attached bitmaps (may be NULL if none) </p>
</div>
</div>
<a class="anchor" id="ab64597170d6f5846856b511976d13ef1"></a><!-- doxytag: member="kate_event::duration" ref="ab64597170d6f5846856b511976d13ef1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t <a class="el" href="structkate__event.html#ab64597170d6f5846856b511976d13ef1">kate_event::duration</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the duration in granules </p>
</div>
</div>
<a class="anchor" id="a32b8fb798d3aeb6b089c218aa6af3029"></a><!-- doxytag: member="kate_event::end_time" ref="a32b8fb798d3aeb6b089c218aa6af3029" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_float <a class="el" href="structkate__event.html#a32b8fb798d3aeb6b089c218aa6af3029">kate_event::end_time</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the time at which this event ends </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00147">kate_tracker_remap()</a>, and <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="a672aa826358c2af300d781adc83a599d"></a><!-- doxytag: member="kate_event::font_mapping" ref="a672aa826358c2af300d781adc83a599d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__font__mapping.html">kate_font_mapping</a>* <a class="el" href="structkate__event.html#a672aa826358c2af300d781adc83a599d">kate_event::font_mapping</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>font mapping to use for the text (may be NULL for no particular mapping) </p>
</div>
</div>
<a class="anchor" id="a0a6098c2607c99dbaf2afbd20d1a70b8"></a><!-- doxytag: member="kate_event::id" ref="a0a6098c2607c99dbaf2afbd20d1a70b8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int32_t <a class="el" href="structkate__event.html#a0a6098c2607c99dbaf2afbd20d1a70b8">kate_event::id</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>unique id to identify this event </p>
</div>
</div>
<a class="anchor" id="a7720b51cbd553648b268bab54d30c78b"></a><!-- doxytag: member="kate_event::language" ref="a7720b51cbd553648b268bab54d30c78b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const char* <a class="el" href="structkate__event.html#a7720b51cbd553648b268bab54d30c78b">kate_event::language</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>language of the text in this event (may be NULL if no override) </p>
</div>
</div>
<a class="anchor" id="a1248458b9fe7a7f51ca90cddf952c056"></a><!-- doxytag: member="kate_event::len" ref="a1248458b9fe7a7f51ca90cddf952c056" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="structkate__event.html#a1248458b9fe7a7f51ca90cddf952c056">kate_event::len</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>length in bytes of the text </p>
</div>
</div>
<a class="anchor" id="a0ba64f13c042b512a0a16e9baef3f08b"></a><!-- doxytag: member="kate_event::len0" ref="a0ba64f13c042b512a0a16e9baef3f08b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="structkate__event.html#a0ba64f13c042b512a0a16e9baef3f08b">kate_event::len0</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>length in bytes of the text, including terminating zero(s) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00033">kate_tracker_init()</a>.</p>
</div>
</div>
<a class="anchor" id="ac35329e23855fa49d5d5132f78552103"></a><!-- doxytag: member="kate_event::motions" ref="ac35329e23855fa49d5d5132f78552103" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__motion.html">kate_motion</a>* kate_const* <a class="el" href="structkate__event.html#ac35329e23855fa49d5d5132f78552103">kate_event::motions</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the list of attached motions (may be NULL if none) </p>
</div>
</div>
<a class="anchor" id="ad942c3dc121637459e61fe4e56572483"></a><!-- doxytag: member="kate_event::nbitmaps" ref="ad942c3dc121637459e61fe4e56572483" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="structkate__event.html#ad942c3dc121637459e61fe4e56572483">kate_event::nbitmaps</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>number of attached bitmaps (may be zero) </p>
</div>
</div>
<a class="anchor" id="aa0d93c4f71a2aa32a253afd6a3676a28"></a><!-- doxytag: member="kate_event::nmotions" ref="aa0d93c4f71a2aa32a253afd6a3676a28" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="structkate__event.html#aa0d93c4f71a2aa32a253afd6a3676a28">kate_event::nmotions</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>number of attached motions (may be zero) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="ae978159e8d25213ee6d7b3e33588eb69"></a><!-- doxytag: member="kate_event::palette" ref="ae978159e8d25213ee6d7b3e33588eb69" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__palette.html">kate_palette</a>* <a class="el" href="structkate__event.html#ae978159e8d25213ee6d7b3e33588eb69">kate_event::palette</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>palette to use as background (may be NULL for none) </p>
</div>
</div>
<a class="anchor" id="a55fc1e968d784c76cb41edefd06536bc"></a><!-- doxytag: member="kate_event::region" ref="a55fc1e968d784c76cb41edefd06536bc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__region.html">kate_region</a>* <a class="el" href="structkate__event.html#a55fc1e968d784c76cb41edefd06536bc">kate_event::region</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>region to display in (may be NULL for no particular region) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="a86a059704037808ce36119008af58b14"></a><!-- doxytag: member="kate_event::secondary_style" ref="a86a059704037808ce36119008af58b14" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__style.html">kate_style</a>* <a class="el" href="structkate__event.html#a86a059704037808ce36119008af58b14">kate_event::secondary_style</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>secondary style to display text (may be NULL for no particular style) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="ac27b75614b6be88d1f34b06a68707718"></a><!-- doxytag: member="kate_event::start" ref="ac27b75614b6be88d1f34b06a68707718" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_int64_t <a class="el" href="structkate__event.html#ac27b75614b6be88d1f34b06a68707718">kate_event::start</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the time at offset rate at which this event starts </p>
</div>
</div>
<a class="anchor" id="ad51c57b3be877b92877689e59f60713b"></a><!-- doxytag: member="kate_event::start_time" ref="ad51c57b3be877b92877689e59f60713b" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_float <a class="el" href="structkate__event.html#ad51c57b3be877b92877689e59f60713b">kate_event::start_time</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the time at which this event starts </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00147">kate_tracker_remap()</a>, and <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="ac9a93dcff7df4ba077a7e6208c8d2c94"></a><!-- doxytag: member="kate_event::style" ref="ac9a93dcff7df4ba077a7e6208c8d2c94" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const <a class="el" href="structkate__style.html">kate_style</a>* <a class="el" href="structkate__event.html#ac9a93dcff7df4ba077a7e6208c8d2c94">kate_event::style</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>style to display text (may be NULL for no particular style) </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00327">kate_tracker_update()</a>.</p>
</div>
</div>
<a class="anchor" id="ae10745a5078521816cc07a09654fbfd4"></a><!-- doxytag: member="kate_event::text" ref="ae10745a5078521816cc07a09654fbfd4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">kate_const char* <a class="el" href="structkate__event.html#ae10745a5078521816cc07a09654fbfd4">kate_event::text</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>the event text (may be NULL if none) </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_8c-example.html#a10">decoding.c</a>, and <a class="el" href="high_8c-example.html#a6">high.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00033">kate_tracker_init()</a>.</p>
</div>
</div>
<a class="anchor" id="a04035a6778e1587a5c74fa5488cca88f"></a><!-- doxytag: member="kate_event::text_directionality" ref="a04035a6778e1587a5c74fa5488cca88f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="kate_8h.html#accb7b9d9ec6e956fa1096f2064a6321e">kate_text_directionality</a> <a class="el" href="structkate__event.html#a04035a6778e1587a5c74fa5488cca88f">kate_event::text_directionality</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>directionality of the text in this event </p>
</div>
</div>
<a class="anchor" id="a9e44f3d25703ce86eccc7fc692b8d9d2"></a><!-- doxytag: member="kate_event::text_encoding" ref="a9e44f3d25703ce86eccc7fc692b8d9d2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="kate_8h.html#a9e8a915382d068016312baad10053902">kate_text_encoding</a> <a class="el" href="structkate__event.html#a9e44f3d25703ce86eccc7fc692b8d9d2">kate_event::text_encoding</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>character encoding for the text in this event </p>
<p>Referenced by <a class="el" href="kate__tracker_8c_source.html#l00033">kate_tracker_init()</a>.</p>
</div>
</div>
<a class="anchor" id="ad48b629f73a3cc49c7b5dfab2d21b561"></a><!-- doxytag: member="kate_event::text_markup_type" ref="ad48b629f73a3cc49c7b5dfab2d21b561" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="kate_8h.html#a300e0138b6959cdad4a33068abc89464">kate_markup_type</a> <a class="el" href="structkate__event.html#ad48b629f73a3cc49c7b5dfab2d21b561">kate_event::text_markup_type</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>how to interpret any markup found in the text </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>/home/mandrake/rpm/BUILD/libkate-0.3.7/include/kate/<a class="el" href="kate_8h_source.html">kate.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Wed Dec 23 04:05:07 2009 for libkate by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
