GED 2006 (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>GED 2006: Image 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.2 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</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 List</span></a></li>
<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>
<h1>Image Class Reference</h1><!-- doxytag: class="Image" --><!-- doxytag: inherits="FrameBuffer,CmdHistory" --><code>#include <<a class="el" href="image_8h-source.html">image.h</a>></code>
<p>
<p>Inheritance diagram for Image:
<p><center><img src="classImage.png" usemap="#Image_map" border="0" alt=""></center>
<map name="Image_map">
<area href="classFrameBuffer.html" alt="FrameBuffer" shape="rect" coords="0,0,83,24">
<area href="classCmdHistory.html" alt="CmdHistory" shape="rect" coords="93,0,176,24">
<area href="classPluginImage.html" alt="PluginImage" shape="rect" coords="0,112,83,136">
<area href="classPNGImage.html" alt="PNGImage" shape="rect" coords="93,112,176,136">
</map>
<a href="classImage-members.html">List of all members.</a><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">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#9ce445b5bc1f5a8c31dc67c684ec32d2">~Image</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#cebc358ffa664fb9397de18c308b9e2d">save</a> (const std::string &fileName)=0</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#239519d3820f15b3ee6e07fc22bcfffb">bNew</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#55424a3421cd07bcfb868eb5cf5f0756">name</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#b286ff4c04452277a6862ba602a9ec75">filePattern</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#3d42ac9497d99663635693ac0b739025">name</a> (const std::string &name)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classImage.html">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#2952f609feb02d0b33dc57d6ecb84192">operator<<</a> (<a class="el" href="classCmd.html">Cmd</a> *pCmd)</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="classImage.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#47eaa75da30cbe059f3ee8d76c4c93d4">readImageFromFile</a> (const char *szFileName)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#4e098ad259e4343efdab66ef3237ef67">Image</a> (const <a class="el" href="structBoxSize.html">BoxSize</a> &size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage.html#da7e8d01e9e2c59b3286f2c57d9474c2">Image</a> (const std::string &fileName)</td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage_1_1ErrLoad.html">ErrLoad</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage_1_1ErrSave.html">ErrSave</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classImage_1_1ErrUnknownFF.html">ErrUnknownFF</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract class <a class="el" href="classImage.html">Image</a>
<p>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00019">19</a> of file <a class="el" href="image_8h-source.html">image.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9ce445b5bc1f5a8c31dc67c684ec32d2"></a><!-- doxytag: member="Image::~Image" ref="9ce445b5bc1f5a8c31dc67c684ec32d2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Image::~Image </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00027">27</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
</div>
</div><p>
<a class="anchor" name="4e098ad259e4343efdab66ef3237ef67"></a><!-- doxytag: member="Image::Image" ref="4e098ad259e4343efdab66ef3237ef67" args="(const BoxSize &size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structBoxSize.html">BoxSize</a> & </td>
<td class="paramname"> <em>size</em> </td>
<td> ) </td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize base. Use <a class="el" href="classAppWnd.html#aa9dcb82768a36e651ec2fafbfcbafa6">AppWnd::newDocName()</a> method to obtain image name. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Desired size of image. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="da7e8d01e9e2c59b3286f2c57d9474c2"></a><!-- doxytag: member="Image::Image" ref="da7e8d01e9e2c59b3286f2c57d9474c2" args="(const std::string &fileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Image::Image </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>fileName</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize base. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fileName</em> </td><td>File name for new image. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00096">96</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="47eaa75da30cbe059f3ee8d76c4c93d4"></a><!-- doxytag: member="Image::readImageFromFile" ref="47eaa75da30cbe059f3ee8d76c4c93d4" args="(const char *szFileName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classImage.html">Image</a>* Image::readImageFromFile </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>szFileName</em> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read image from file and create <a class="el" href="classImage.html">Image</a> object. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>szFileName</em> </td><td><a class="el" href="classImage.html">Image</a> file name. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to <a class="el" href="classImage.html">Image</a> object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cebc358ffa664fb9397de18c308b9e2d"></a><!-- doxytag: member="Image::save" ref="cebc358ffa664fb9397de18c308b9e2d" args="(const std::string &fileName)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Image::save </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>fileName</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save image to desired file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fileName</em> </td><td>File name to save with. </td></tr>
</table>
</dl>
<p>
Implemented in <a class="el" href="classPluginImage.html#a7010f2a0955e9fe5ffab83c5889f9d8">PluginImage</a>, and <a class="el" href="classPNGImage.html#7b0afa1f4cc1d19a3f25f78f1b37386b">PNGImage</a>.
</div>
</div><p>
<a class="anchor" name="239519d3820f15b3ee6e07fc22bcfffb"></a><!-- doxytag: member="Image::bNew" ref="239519d3820f15b3ee6e07fc22bcfffb" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Image::bNew </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if image is not from file </dd></dl>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00038">38</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
</div>
</div><p>
<a class="anchor" name="55424a3421cd07bcfb868eb5cf5f0756"></a><!-- doxytag: member="Image::name" ref="55424a3421cd07bcfb868eb5cf5f0756" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Image::name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return image file name. </dd></dl>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00043">43</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
</div>
</div><p>
<a class="anchor" name="b286ff4c04452277a6862ba602a9ec75"></a><!-- doxytag: member="Image::filePattern" ref="b286ff4c04452277a6862ba602a9ec75" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string Image::filePattern </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return file pattern for fl_file_chooser dialog argument. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3d42ac9497d99663635693ac0b739025"></a><!-- doxytag: member="Image::name" ref="3d42ac9497d99663635693ac0b739025" args="(const std::string &name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Image::name </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set image name. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Desired name. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="image_8h-source.html#l00054">54</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
</div>
</div><p>
<a class="anchor" name="2952f609feb02d0b33dc57d6ecb84192"></a><!-- doxytag: member="Image::operator<<" ref="2952f609feb02d0b33dc57d6ecb84192" args="(Cmd *pCmd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classImage.html">Image</a>& Image::operator<< </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCmd.html">Cmd</a> * </td>
<td class="paramname"> <em>pCmd</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put command to history list and execute command. *pCmd object must by allocated on the heap and can never be destroyed. <a class="el" href="classCmdHistory.html">CmdHistory</a> destroys it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pCmd</em> </td><td>Pointer to command. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Reference to this. Needed for << operator concatenation. </dd></dl>
<p>
Reimplemented from <a class="el" href="classCmdHistory.html#844f048ae189e30c90ca21ba4cd5da31">CmdHistory</a>.
<p>
Definition at line <a class="el" href="image_8h-source.html#l00062">62</a> of file <a class="el" href="image_8h-source.html">image.h</a>.
<p>
References <a class="el" href="classCmd.html#91ebd2007a41d4943ea2d47f16706d97">Cmd::exec()</a>, and <a class="el" href="classCmdHistory.html#844f048ae189e30c90ca21ba4cd5da31">CmdHistory::operator<<()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="image_8h-source.html">image.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Aug 29 00:01:04 2007 for GED 2006 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classImage.html [Download]