<!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>gstreamermm: Gst::Navigation Class 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><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGst.html">Gst</a>::<a class="el" href="classGst_1_1Navigation.html">Navigation</a>
</div>
</div>
<div class="contents">
<h1>Gst::Navigation Class Reference<br/>
<small>
[<a class="el" href="group__GstInterfaces.html">gstreamermm Interfaces</a>]</small>
</h1><!-- doxytag: class="Gst::Navigation" --><!-- doxytag: inherits="Glib::Interface" -->
<p>Gst::Naviagtion - <a class="el" href="classGst_1_1Interface.html" title="Core interface implemented by Gst::Element instances that allows runtime querying...">Interface</a> for elements that provide navigation functionality. <a href="#_details">More...</a></p>
<p>Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html">Glib::Interface</a>.</p>
<p>Inherited by <a class="el" href="classGst_1_1XImageSink.html">Gst::XImageSink</a>, and <a class="el" href="classGst_1_1XvImageSink.html">Gst::XvImageSink</a>.</p>
<div class="dynheader">
Collaboration diagram for Gst::Navigation:</div>
<div class="dynsection">
<div class="center"><img src="classGst_1_1Navigation__coll__graph.png" border="0" usemap="#Gst_1_1Navigation_coll__map" alt="Collaboration graph"/></div>
<map name="Gst_1_1Navigation_coll__map" id="Gst_1_1Navigation_coll__map">
<area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="13,160,117,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,125,112"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,5,119,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classGst_1_1Navigation-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#af2ddbf2042486f25a9e83078d4c24d69">~Navigation</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">GstNavigation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a5e13c4cd13e2a470cee2eb309d9e9fe3">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5e13c4cd13e2a470cee2eb309d9e9fe3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const GstNavigation* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a6f4da9633b060ba13527101712d441ce">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a6f4da9633b060ba13527101712d441ce"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a850b60ee3bab6b61b73011b23cb4419d">send_event</a> (<a class="el" href="classGst_1_1Structure.html">Gst::Structure</a>& structure)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#aecf2ee9a41b73d754324cf173da592ca">send_key_event</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& event, const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& key)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#ace7ce1be358bd73693322f3e8126b47c">send_mouse_event</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& event, int button, double x, double y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends a mouse event to the navigation interface. <a href="#ace7ce1be358bd73693322f3e8126b47c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a05d8729ba22810f95c58ed074aa4c6cf">send_command</a> (<a class="el" href="group__gstreamermmEnums.html#ga413477e37a69fc3af5f1261c842bd0a5">Gst::NavigationCommand</a> command)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sends the indicated command to the navigation interface. <a href="#a05d8729ba22810f95c58ed074aa4c6cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#ae9a5468ac150396a51e5b05842433a70">send_event_vfunc</a> (<a class="el" href="classGst_1_1Structure.html">Gst::Structure</a>& structure)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when an event has been sent to the <a class="el" href="classGst_1_1Navigation.html" title="Gst::Naviagtion - Interface for elements that provide navigation functionality.">Gst::Navigation</a>. <a href="#ae9a5468ac150396a51e5b05842433a70"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a67e015e6066474ef7954d7742ecb8576">add_interface</a> (GType gtype_implementer)</td></tr>
<tr><td colspan="2"><h2>Related Functions</h2></td></tr>
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
<br/><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Navigation.html">Gst::Navigation</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1Navigation.html#a6e929595e5b1e03af7c7ae1fa0d04065">wrap</a> (GstNavigation* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a6e929595e5b1e03af7c7ae1fa0d04065"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Gst::Naviagtion - <a class="el" href="classGst_1_1Interface.html" title="Core interface implemented by Gst::Element instances that allows runtime querying...">Interface</a> for elements that provide navigation functionality. </p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="af2ddbf2042486f25a9e83078d4c24d69"></a><!-- doxytag: member="Gst::Navigation::~Navigation" ref="af2ddbf2042486f25a9e83078d4c24d69" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gst::Navigation::~Navigation </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a67e015e6066474ef7954d7742ecb8576"></a><!-- doxytag: member="Gst::Navigation::add_interface" ref="a67e015e6066474ef7954d7742ecb8576" args="(GType gtype_implementer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void Gst::Navigation::add_interface </td>
<td>(</td>
<td class="paramtype">GType </td>
<td class="paramname"> <em>gtype_implementer</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a6f4da9633b060ba13527101712d441ce"></a><!-- doxytag: member="Gst::Navigation::gobj" ref="a6f4da9633b060ba13527101712d441ce" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GstNavigation* Gst::Navigation::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a70a443071a69d3372c2cdd7128a91ed1">Glib::Interface</a>.</p>
<p>Reimplemented in <a class="el" href="classGst_1_1XImageSink.html#a0116a958dffad1e999e37f9881e66ae8">Gst::XImageSink</a>, and <a class="el" href="classGst_1_1XvImageSink.html#a64c355226d6a554a95bbcb098ba0c486">Gst::XvImageSink</a>.</p>
</div>
</div>
<a class="anchor" id="a5e13c4cd13e2a470cee2eb309d9e9fe3"></a><!-- doxytag: member="Gst::Navigation::gobj" ref="a5e13c4cd13e2a470cee2eb309d9e9fe3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GstNavigation* Gst::Navigation::gobj </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provides access to the underlying C GObject. </p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html#a969e9396f75132a9577428f4fa932d42">Glib::Interface</a>.</p>
<p>Reimplemented in <a class="el" href="classGst_1_1XImageSink.html#ad8cef78951240a673c1f9d9b8bb1928f">Gst::XImageSink</a>, and <a class="el" href="classGst_1_1XvImageSink.html#a02718e655cab456f9b607a6ad76c7dc8">Gst::XvImageSink</a>.</p>
</div>
</div>
<a class="anchor" id="a05d8729ba22810f95c58ed074aa4c6cf"></a><!-- doxytag: member="Gst::Navigation::send_command" ref="a05d8729ba22810f95c58ed074aa4c6cf" args="(Gst::NavigationCommand command)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Navigation::send_command </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__gstreamermmEnums.html#ga413477e37a69fc3af5f1261c842bd0a5">Gst::NavigationCommand</a> </td>
<td class="paramname"> <em>command</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends the indicated command to the navigation interface. </p>
<dl class="since_0_10"><dt><b><a class="el" href="since_0_10.html#_since_0_10000064">Since gstreamermm 0.10:</a></b></dt><dd>.23 </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>command</em> </td><td>The command to issue. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a850b60ee3bab6b61b73011b23cb4419d"></a><!-- doxytag: member="Gst::Navigation::send_event" ref="a850b60ee3bab6b61b73011b23cb4419d" args="(Gst::Structure &structure)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Navigation::send_event </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1Structure.html">Gst::Structure</a>& </td>
<td class="paramname"> <em>structure</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ae9a5468ac150396a51e5b05842433a70"></a><!-- doxytag: member="Gst::Navigation::send_event_vfunc" ref="ae9a5468ac150396a51e5b05842433a70" args="(Gst::Structure &structure)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Gst::Navigation::send_event_vfunc </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classGst_1_1Structure.html">Gst::Structure</a>& </td>
<td class="paramname"> <em>structure</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Called when an event has been sent to the <a class="el" href="classGst_1_1Navigation.html" title="Gst::Naviagtion - Interface for elements that provide navigation functionality.">Gst::Navigation</a>. </p>
</div>
</div>
<a class="anchor" id="aecf2ee9a41b73d754324cf173da592ca"></a><!-- doxytag: member="Gst::Navigation::send_key_event" ref="aecf2ee9a41b73d754324cf173da592ca" args="(const Glib::ustring &event, const Glib::ustring &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Navigation::send_key_event </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ace7ce1be358bd73693322f3e8126b47c"></a><!-- doxytag: member="Gst::Navigation::send_mouse_event" ref="ace7ce1be358bd73693322f3e8126b47c" args="(const Glib::ustring &event, int button, double x, double y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Gst::Navigation::send_mouse_event </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>event</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>button</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sends a mouse event to the navigation interface. </p>
<p>Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element implementing the <a class="el" href="classGst_1_1Navigation.html" title="Gst::Naviagtion - Interface for elements that provide navigation functionality.">Gst::Navigation</a> interface. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>event</em> </td><td>The type of mouse event, as a text string. Recognised values are "mouse-button-press", "mouse-button-release" and "mouse-move". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>button</em> </td><td>The button number of the button being pressed or released. Pass 0 for mouse-move events. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>x</em> </td><td>The x coordinate of the mouse event. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>y</em> </td><td>The y coordinate of the mouse event. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="a6e929595e5b1e03af7c7ae1fa0d04065"></a><!-- doxytag: member="Gst::Navigation::wrap" ref="a6e929595e5b1e03af7c7ae1fa0d04065" args="(GstNavigation *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1Navigation.html">Gst::Navigation</a> > wrap </td>
<td>(</td>
<td class="paramtype">GstNavigation * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>gstreamermm/navigation.h</li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 22:32:59 2009 for gstreamermm 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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
7a65d2578765429f23843d9c8d1c0efa
>
files
>
621
