<!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>libcaca documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- $Id$ -->
<!-- Generated by Doxygen 1.5.9 -->
<div class="contents">
<h1>libcaca event handling</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g98e74dedbe1629c0fc9460761696e050">caca_get_event</a> (<a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> *, int, <a class="el" href="structcaca__event.html">caca_event_t</a> *, int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next mouse or keyboard input event. <a href="#g98e74dedbe1629c0fc9460761696e050"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gf01ff2ff5f63e38eed2052b53181da2d">caca_get_mouse_x</a> (<a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the X mouse coordinate. <a href="#gf01ff2ff5f63e38eed2052b53181da2d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gc3310eaf44cc95e46be5c3e9a8a6818e">caca_get_mouse_y</a> (<a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the Y mouse coordinate. <a href="#gc3310eaf44cc95e46be5c3e9a8a6818e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern enum <a class="el" href="caca_8h.html#40754185ca237fc44a95357afba34aea">caca_event_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799">caca_get_event_type</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an event's type. <a href="#gd25829294affb5693a11aa237d3fe799"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g946d19f0da7be7a53b848f8dd4251de7">caca_get_event_key_ch</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a key press or key release event's value. <a href="#g946d19f0da7be7a53b848f8dd4251de7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gfe4050ef5bbaa8c2bce622beadc7df8d">caca_get_event_key_utf32</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a key press or key release event's Unicode value. <a href="#gfe4050ef5bbaa8c2bce622beadc7df8d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gd1e178b837e26e04893e4fd00b16300d">caca_get_event_key_utf8</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *, char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a key press or key release event's UTF-8 value. <a href="#gd1e178b837e26e04893e4fd00b16300d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g717e5140c28618ff1e7b9f5b8088bd30">caca_get_event_mouse_button</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a mouse press or mouse release event's button. <a href="#g717e5140c28618ff1e7b9f5b8088bd30"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g43631e56f18159f29500b7ff9f2f86dc">caca_get_event_mouse_x</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a mouse motion event's X coordinate. <a href="#g43631e56f18159f29500b7ff9f2f86dc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g0a8a947bba8fe524f5b1885581585205">caca_get_event_mouse_y</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a mouse motion event's Y coordinate. <a href="#g0a8a947bba8fe524f5b1885581585205"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#gf37f40ebbd84e1febfb45980e33ce861">caca_get_event_resize_width</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a resize event's display width value. <a href="#gf37f40ebbd84e1febfb45980e33ce861"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__event.html#g20d8da5ded5ae58fa3050c8fadc40a46">caca_get_event_resize_height</a> (<a class="el" href="structcaca__event.html">caca_event_t</a> const *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a resize event's display height value. <a href="#g20d8da5ded5ae58fa3050c8fadc40a46"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
These functions handle user events such as keyboard input and mouse clicks. <hr><h2>Function Documentation</h2>
<a class="anchor" name="g98e74dedbe1629c0fc9460761696e050"></a><!-- doxytag: member="caca.h::caca_get_event" ref="g98e74dedbe1629c0fc9460761696e050" args="(caca_display_t *, int, caca_event_t *, int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> * </td>
<td class="paramname"> <em>dp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>event_mask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> * </td>
<td class="paramname"> <em>ev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>timeout</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Poll the event queue for mouse or keyboard events matching the event mask and return the first matching event. Non-matching events are discarded. If <code>event_mask</code> is zero, the function returns immediately.<p>
The timeout value tells how long this function needs to wait for an event. A value of zero returns immediately and the function returns zero if no more events are pending in the queue. A negative value causes the function to wait indefinitely until a matching event is received.<p>
If not null, <code>ev</code> will be filled with information about the event received. If null, the function will return but no information about the event will be sent.<p>
This function never fails.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dp</em> </td><td>The libcaca graphical context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>event_mask</em> </td><td>Bitmask of requested events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>A timeout value in microseconds, -1 for blocking behaviour </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>A pointer to a <a class="el" href="structcaca__event.html" title="Handling of user events.">caca_event</a> structure, or NULL. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>1 if a matching event was received, or 0 if the wait timeouted. </dd></dl>
<p>References <a class="el" href="caca_8h_source.html#l00096">CACA_EVENT_NONE</a>.</p>
</div>
</div><p>
<a class="anchor" name="gf01ff2ff5f63e38eed2052b53181da2d"></a><!-- doxytag: member="caca.h::caca_get_mouse_x" ref="gf01ff2ff5f63e38eed2052b53181da2d" args="(caca_display_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_mouse_x </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> const * </td>
<td class="paramname"> <em>dp</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the X coordinate of the mouse position last time it was detected. This function is not reliable if the ncurses or S-Lang drivers are being used, because mouse position is only detected when the mouse is clicked. Other drivers such as X11 work well.<p>
This function never fails.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dp</em> </td><td>The libcaca graphical context. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The X mouse coordinate. </dd></dl>
<p>References <a class="el" href="canvas_8c_source.html#l00239">caca_get_canvas_width()</a>.</p>
</div>
</div><p>
<a class="anchor" name="gc3310eaf44cc95e46be5c3e9a8a6818e"></a><!-- doxytag: member="caca.h::caca_get_mouse_y" ref="gc3310eaf44cc95e46be5c3e9a8a6818e" args="(caca_display_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_mouse_y </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#da5af7a20f3e2f6c103078181b07393e">caca_display_t</a> const * </td>
<td class="paramname"> <em>dp</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the Y coordinate of the mouse position last time it was detected. This function is not reliable if the ncurses or S-Lang drivers are being used, because mouse position is only detected when the mouse is clicked. Other drivers such as X11 work well.<p>
This function never fails.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>dp</em> </td><td>The libcaca graphical context. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The Y mouse coordinate. </dd></dl>
<p>References <a class="el" href="canvas_8c_source.html#l00253">caca_get_canvas_height()</a>.</p>
</div>
</div><p>
<a class="anchor" name="gd25829294affb5693a11aa237d3fe799"></a><!-- doxytag: member="caca.h::caca_get_event_type" ref="gd25829294affb5693a11aa237d3fe799" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern enum <a class="el" href="caca_8h.html#40754185ca237fc44a95357afba34aea">caca_event_type</a> caca_get_event_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the type of an event. This function may always be called on an event after <a class="el" href="group__caca__event.html#g98e74dedbe1629c0fc9460761696e050" title="Get the next mouse or keyboard input event.">caca_get_event()</a> was called, and its return value indicates which other functions may be called:<ul>
<li><code>CACA_EVENT_NONE:</code> no other function may be called.</li><li><code>CACA_EVENT_KEY_PRESS</code>, <code>CACA_EVENT_KEY_RELEASE:</code> <a class="el" href="group__caca__event.html#g946d19f0da7be7a53b848f8dd4251de7" title="Return a key press or key release event's value.">caca_get_event_key_ch()</a>, <a class="el" href="group__caca__event.html#gfe4050ef5bbaa8c2bce622beadc7df8d" title="Return a key press or key release event's Unicode value.">caca_get_event_key_utf32()</a> and <a class="el" href="group__caca__event.html#gd1e178b837e26e04893e4fd00b16300d" title="Return a key press or key release event's UTF-8 value.">caca_get_event_key_utf8()</a> may be called.</li><li><code>CACA_EVENT_MOUSE_PRESS</code>, <code>CACA_EVENT_MOUSE_RELEASE:</code> <a class="el" href="group__caca__event.html#g717e5140c28618ff1e7b9f5b8088bd30" title="Return a mouse press or mouse release event's button.">caca_get_event_mouse_button()</a> may be called.</li><li><code>CACA_EVENT_MOUSE_MOTION:</code> <a class="el" href="group__caca__event.html#g43631e56f18159f29500b7ff9f2f86dc" title="Return a mouse motion event's X coordinate.">caca_get_event_mouse_x()</a> and <a class="el" href="group__caca__event.html#g0a8a947bba8fe524f5b1885581585205" title="Return a mouse motion event's Y coordinate.">caca_get_event_mouse_y()</a> may be called.</li><li><code>CACA_EVENT_RESIZE:</code> <a class="el" href="group__caca__event.html#gf37f40ebbd84e1febfb45980e33ce861" title="Return a resize event's display width value.">caca_get_event_resize_width()</a> and <a class="el" href="group__caca__event.html#g20d8da5ded5ae58fa3050c8fadc40a46" title="Return a resize event's display height value.">caca_get_event_resize_height()</a> may be called.</li><li><code>CACA_EVENT_QUIT:</code> no other function may be called.</li></ul>
<p>
This function never fails.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's type. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g946d19f0da7be7a53b848f8dd4251de7"></a><!-- doxytag: member="caca.h::caca_get_event_key_ch" ref="g946d19f0da7be7a53b848f8dd4251de7" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_key_ch </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return either the ASCII value for an event's key, or if the key is not an ASCII character, an appropriate <em>enum</em> <em>caca_key</em> value.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_KEY_PRESS</code> or <code>CACA_EVENT_KEY_RELEASE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The key value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gfe4050ef5bbaa8c2bce622beadc7df8d"></a><!-- doxytag: member="caca.h::caca_get_event_key_utf32" ref="gfe4050ef5bbaa8c2bce622beadc7df8d" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern uint32_t caca_get_event_key_utf32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the UTF-32/UCS-4 value for an event's key if it resolves to a printable character.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_KEY_PRESS</code> or <code>CACA_EVENT_KEY_RELEASE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The key's Unicode value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gd1e178b837e26e04893e4fd00b16300d"></a><!-- doxytag: member="caca.h::caca_get_event_key_utf8" ref="gd1e178b837e26e04893e4fd00b16300d" args="(caca_event_t const *, char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_key_utf8 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>utf8</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write the UTF-8 value for an event's key if it resolves to a printable character. Up to 6 UTF-8 bytes and a null termination are written.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_KEY_PRESS</code> or <code>CACA_EVENT_KEY_RELEASE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>This function always returns 0. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g717e5140c28618ff1e7b9f5b8088bd30"></a><!-- doxytag: member="caca.h::caca_get_event_mouse_button" ref="g717e5140c28618ff1e7b9f5b8088bd30" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_mouse_button </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the mouse button index for an event.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_MOUSE_PRESS</code> or <code>CACA_EVENT_MOUSE_RELEASE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's mouse button. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g43631e56f18159f29500b7ff9f2f86dc"></a><!-- doxytag: member="caca.h::caca_get_event_mouse_x" ref="g43631e56f18159f29500b7ff9f2f86dc" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_mouse_x </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the X coordinate for a mouse motion event.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_MOUSE_MOTION</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's X mouse coordinate. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g0a8a947bba8fe524f5b1885581585205"></a><!-- doxytag: member="caca.h::caca_get_event_mouse_y" ref="g0a8a947bba8fe524f5b1885581585205" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_mouse_y </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the Y coordinate for a mouse motion event.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_MOUSE_MOTION</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's Y mouse coordinate. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gf37f40ebbd84e1febfb45980e33ce861"></a><!-- doxytag: member="caca.h::caca_get_event_resize_width" ref="gf37f40ebbd84e1febfb45980e33ce861" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_resize_width </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the width value for a display resize event.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_RESIZE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's new display width value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g20d8da5ded5ae58fa3050c8fadc40a46"></a><!-- doxytag: member="caca.h::caca_get_event_resize_height" ref="g20d8da5ded5ae58fa3050c8fadc40a46" args="(caca_event_t const *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_get_event_resize_height </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structcaca__event.html">caca_event_t</a> const * </td>
<td class="paramname"> <em>ev</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the height value for a display resize event.<p>
This function never fails, but must only be called with a valid event of type <code>CACA_EVENT_RESIZE</code>, or the results will be undefined. See <a class="el" href="group__caca__event.html#gd25829294affb5693a11aa237d3fe799" title="Return an event's type.">caca_get_event_type()</a> for more information.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ev</em> </td><td>The libcaca event. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The event's new display height value. </dd></dl>
</div>
</div><p>
</div>
<!-- $Id$ -->
</body>
</html>
