Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > eebc325dc36bd6e3b09b9b45133e42f8 > files > 3406

HippoDraw-devel-docs-1.21.1-10.fc13.i686.rpm

<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HippoDraw Class Library</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="hippoApp.ico">
</head><body>
<!-- Generated by Doxygen 1.6.2 -->
<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="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</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 class="navpath"><a class="el" href="namespacehippodraw.html">hippodraw</a>::<a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a>
  </div>
</div>
<div class="contents">
<h1>SaveAsImageEvent Class Reference</h1><!-- doxytag: class="hippodraw::SaveAsImageEvent" --><!-- doxytag: inherits="QCustomEvent" -->
<p>A derived class of <a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html">QCustomEvent</a> to handle saving a <a class="el" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> object as image file events.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="SaveAsImageEvent_8h_source.html">SaveAsImageEvent.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for SaveAsImageEvent:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1SaveAsImageEvent__inherit__graph.gif" border="0" usemap="#SaveAsImageEvent_inherit__map" alt="Inheritance graph"/></div>
<map name="SaveAsImageEvent_inherit__map" id="SaveAsImageEvent_inherit__map">
<area shape="rect" id="node2" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html" title="QCustomEvent" alt="" coords="19,5,131,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for SaveAsImageEvent:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1SaveAsImageEvent__coll__graph.gif" border="0" usemap="#SaveAsImageEvent_coll__map" alt="Collaboration graph"/></div>
<map name="SaveAsImageEvent_coll__map" id="SaveAsImageEvent_coll__map">
<area shape="rect" id="node2" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html" title="QCustomEvent" alt="" coords="5,85,117,115"/><area shape="rect" id="node4" title="STL class." alt="" coords="141,85,195,115"/><area shape="rect" id="node6" title="STL class." alt="" coords="97,5,239,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classhippodraw_1_1SaveAsImageEvent-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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html#data">data</a> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#af70efc71c067a130ad3286c88df651ef">filename</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the filename for the image.  <a href="#af70efc71c067a130ad3286c88df651ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhippodraw_1_1PlotterBase.html">PlotterBase</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#a3ea4ecda28161919ff211eb43356f3ea">plotter</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the <a class="el" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> object that created the update event.  <a href="#a3ea4ecda28161919ff211eb43356f3ea"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#a0adc5420a6675449a666771f3aa0e09a">SaveAsImageEvent</a> (const <a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a> &amp;)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The copy constructor.  <a href="#a0adc5420a6675449a666771f3aa0e09a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#ace9453cb90b60fcc2b0cef0d7c499f10">SaveAsImageEvent</a> (const <a class="el" href="classhippodraw_1_1PlotterBase.html">PlotterBase</a> *plotter, const std::string &amp;filename)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor taking the <em>plotter</em> object and image <em>filename</em> as arguments.  <a href="#ace9453cb90b60fcc2b0cef0d7c499f10"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html#setData">setData</a> (void *<a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html#data">data</a>)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#ae7e949f908098ce56aeac10dc4e98150">~SaveAsImageEvent</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The required virtual destructor.  <a href="#ae7e949f908098ce56aeac10dc4e98150"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#abeab36922e15d948509bdf36c5a46cd9">m_filename</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The filename for the image.  <a href="#abeab36922e15d948509bdf36c5a46cd9"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A derived class of <a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html">QCustomEvent</a> to handle saving a <a class="el" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> object as image file events. </p>
<p>A derived class of <a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html">QCustomEvent</a> to handle saving a <a class="el" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> object as image file.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000179">Todo:</a></b></dt><dd>This class can go away.</dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Paul F. Kunz &lt;<a href="mailto:Paul_Kunz@slac.stanford.edu">Paul_Kunz@slac.stanford.edu</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8h_source.html#l00042">42</a> of file <a class="el" href="SaveAsImageEvent_8h_source.html">SaveAsImageEvent.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ace9453cb90b60fcc2b0cef0d7c499f10"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::SaveAsImageEvent" ref="ace9453cb90b60fcc2b0cef0d7c499f10" args="(const PlotterBase *plotter, const std::string &amp;filename)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classhippodraw_1_1PlotterBase.html">PlotterBase</a> *&nbsp;</td>
          <td class="paramname"> <em>plotter</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const std::string &amp;&nbsp;</td>
          <td class="paramname"> <em>filename</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The constructor taking the <em>plotter</em> object and image <em>filename</em> as arguments. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00024">24</a> of file <a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a>.</p>

</div>
</div>
<a class="anchor" id="a0adc5420a6675449a666771f3aa0e09a"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::SaveAsImageEvent" ref="a0adc5420a6675449a666771f3aa0e09a" args="(const SaveAsImageEvent &amp;)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a> </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>event</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The copy constructor. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00032">32</a> of file <a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a>.</p>

</div>
</div>
<a class="anchor" id="ae7e949f908098ce56aeac10dc4e98150"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::~SaveAsImageEvent" ref="ae7e949f908098ce56aeac10dc4e98150" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">~<a class="el" href="classhippodraw_1_1SaveAsImageEvent.html">SaveAsImageEvent</a> </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The required virtual destructor. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00038">38</a> of file <a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af70efc71c067a130ad3286c88df651ef"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::filename" ref="af70efc71c067a130ad3286c88df651ef" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::string &amp; filename </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the filename for the image. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00053">53</a> of file <a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a>.</p>

<p>References <a class="el" href="SaveAsImageEvent_8h_source.html#l00049">SaveAsImageEvent::m_filename</a>.</p>

</div>
</div>
<a class="anchor" id="a3ea4ecda28161919ff211eb43356f3ea"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::plotter" ref="a3ea4ecda28161919ff211eb43356f3ea" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classhippodraw_1_1PlotterBase.html">PlotterBase</a> * plotter </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Returns the <a class="el" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> object that created the update event. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00044">44</a> of file <a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a>.</p>

<p>References <a class="elRef" doxygen="qt.tag:http://doc.trolltech.com/3.3/" href="http://doc.trolltech.com/3.3/qcustomevent.html#data">QCustomEvent::data()</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="abeab36922e15d948509bdf36c5a46cd9"></a><!-- doxytag: member="hippodraw::SaveAsImageEvent::m_filename" ref="abeab36922e15d948509bdf36c5a46cd9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::string <a class="el" href="classhippodraw_1_1SaveAsImageEvent.html#abeab36922e15d948509bdf36c5a46cd9">m_filename</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The filename for the image. </p>

<p>Definition at line <a class="el" href="SaveAsImageEvent_8h_source.html#l00049">49</a> of file <a class="el" href="SaveAsImageEvent_8h_source.html">SaveAsImageEvent.h</a>.</p>

<p>Referenced by <a class="el" href="SaveAsImageEvent_8cxx_source.html#l00053">SaveAsImageEvent::filename()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="SaveAsImageEvent_8h_source.html">SaveAsImageEvent.h</a></li>
<li><a class="el" href="SaveAsImageEvent_8cxx_source.html">SaveAsImageEvent.cxx</a></li>
</ul>
</div>
<hr size="1"><address style="align: right;"><small>
Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0>
</a> </small></address>
</body>
</html>