Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 473

vtk-doc-5.4.2-5mdv2010.0.noarch.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>VTK: vtkEventForwarderCommand Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<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="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkEventForwarderCommand Class Reference</h1><!-- doxytag: class="vtkEventForwarderCommand" --><!-- doxytag: inherits="vtkCommand" --><code>#include &lt;<a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkEventForwarderCommand:</div>
<div class="dynsection">
<p><center><img src="a09494.png" border="0" usemap="#a09495" alt="Inheritance graph"></center>
<map name="a09495">
<area shape="rect" href="a00291.html" title="superclass for callback/observer methods" alt="" coords="54,80,158,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="51,6,160,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkEventForwarderCommand:</div>
<div class="dynsection">
<p><center><img src="a09496.png" border="0" usemap="#a09497" alt="Collaboration graph"></center>
<map name="a09497">
<area shape="rect" href="a00291.html" title="superclass for callback/observer methods" alt="" coords="8,96,112,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="5,6,115,32"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="136,96,216,123"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="139,6,248,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a09498.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
a simple event forwarder command 
<p>
Use <a class="el" href="a00470.html" title="a simple event forwarder command">vtkEventForwarderCommand</a> to forward an event to a new object. This command will intercept the event, and use InvokeEvent on a 'target' as if that object was the one that invoked the event instead of the object this commmand was attached to using AddObserver.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00291.html" title="superclass for callback/observer methods">vtkCommand</a> </dd></dl>

<p>Definition at line <a class="el" href="a03814.html#l00032">32</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#25ed940ce3c3eaf8f766c5d8883559a4">Execute</a> (<a class="el" href="a01084.html">vtkObject</a> *caller, unsigned long eid, void *callData)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#1790fcd2f4a72c159cfe37292da06ab1">SetTarget</a> (<a class="el" href="a01084.html">vtkObject</a> *obj)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#638bc23a944af76c71929aa3166b9770">GetTarget</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00470.html">vtkEventForwarderCommand</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#73adeee05bcca300e4b8363f3a9ac8b8">New</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#8133e63b66d329442ca7802afb56a6e4">vtkEventForwarderCommand</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#b49f8bb6cf54b28f59d79ba6c5c55d3c">~vtkEventForwarderCommand</a> ()</td></tr>

<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00470.html#13d93a0c9c0d6b517a920b161b9a1c64">Target</a></td></tr>

</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="8133e63b66d329442ca7802afb56a6e4"></a><!-- doxytag: member="vtkEventForwarderCommand::vtkEventForwarderCommand" ref="8133e63b66d329442ca7802afb56a6e4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkEventForwarderCommand::vtkEventForwarderCommand           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="b49f8bb6cf54b28f59d79ba6c5c55d3c"></a><!-- doxytag: member="vtkEventForwarderCommand::~vtkEventForwarderCommand" ref="b49f8bb6cf54b28f59d79ba6c5c55d3c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkEventForwarderCommand::~vtkEventForwarderCommand           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03814.html#l00058">58</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="73adeee05bcca300e4b8363f3a9ac8b8"></a><!-- doxytag: member="vtkEventForwarderCommand::New" ref="73adeee05bcca300e4b8363f3a9ac8b8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a00470.html">vtkEventForwarderCommand</a>* vtkEventForwarderCommand::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. 
<p>Reimplemented from <a class="el" href="a01085.html#1ad146652efe695e9ace7bc29b3e0f74">vtkObjectBase</a>.</p>

<p>Definition at line <a class="el" href="a03814.html#l00035">35</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="25ed940ce3c3eaf8f766c5d8883559a4"></a><!-- doxytag: member="vtkEventForwarderCommand::Execute" ref="25ed940ce3c3eaf8f766c5d8883559a4" args="(vtkObject *caller, unsigned long eid, void *callData)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkEventForwarderCommand::Execute           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>caller</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned long&nbsp;</td>
          <td class="paramname"> <em>eid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>callData</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Satisfy the superclass API for callbacks. Recall that the caller is the instance invoking the event; eid is the event id (see <a class="el" href="a01999.html">vtkCommand.h</a>); and calldata is information sent when the callback was invoked (e.g., progress value in the <a class="el" href="a00291.html#59a8690330ebcb1af6b66b0f3121f8fefb47f80db1dddfdd4b238a7beb587eba">vtkCommand::ProgressEvent</a>). 
<p>Implements <a class="el" href="a00291.html#ac06ef44b864cd7956ea778191730588">vtkCommand</a>.</p>

</div>
</div><p>
<a class="anchor" name="1790fcd2f4a72c159cfe37292da06ab1"></a><!-- doxytag: member="vtkEventForwarderCommand::SetTarget" ref="1790fcd2f4a72c159cfe37292da06ab1" args="(vtkObject *obj)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkEventForwarderCommand::SetTarget           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>obj</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods to set and get client and callback information, and the callback function. 
<p>Definition at line <a class="el" href="a03814.html#l00047">47</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="638bc23a944af76c71929aa3166b9770"></a><!-- doxytag: member="vtkEventForwarderCommand::GetTarget" ref="638bc23a944af76c71929aa3166b9770" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void* vtkEventForwarderCommand::GetTarget           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Methods to set and get client and callback information, and the callback function. 
<p>Definition at line <a class="el" href="a03814.html#l00049">49</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="13d93a0c9c0d6b517a920b161b9a1c64"></a><!-- doxytag: member="vtkEventForwarderCommand::Target" ref="13d93a0c9c0d6b517a920b161b9a1c64" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a01084.html">vtkObject</a>* <a class="el" href="a00470.html#13d93a0c9c0d6b517a920b161b9a1c64">vtkEventForwarderCommand::Target</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a03814.html#l00055">55</a> of file <a class="el" href="a03814.html">vtkEventForwarderCommand.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03814.html">vtkEventForwarderCommand.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:01:27 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>