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: DocWnd 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>DocWnd Class Reference</h1><!-- doxytag: class="DocWnd" --><code>#include <<a class="el" href="docwnd_8h-source.html">docwnd.h</a>></code>
<p>
<p>Inheritance diagram for DocWnd:
<p><center><img src="classDocWnd.png" usemap="#DocWnd_map" border="0" alt=""></center>
<map name="DocWnd_map">
<area href="classDocument.html" alt="Document" shape="rect" coords="0,56,68,80">
</map>
<a href="classDocWnd-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#3fcdee68df26ca12684fc9e4a5f3c00c">DocWnd</a> (<a class="el" href="classImage.html">Image</a> *img)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#0cafa2f545788609c9a57cf47526fb95">~DocWnd</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#760da280ff1048148fb08391ec337b09">save</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#cc33d77184cec0288018e6e13bdb7f19">saveAs</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#661da6b6921b3a9c89d2ed463e8686de">tryClose</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#aa746f5e10586f0c1bb5a0b7f6645477">undo</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#381941df1a3ce6ec5ada31e0e2b8e577">redo</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#b60bcdc34dd01133ecde3fdedebab867">unSelect</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#3fd3fdd95d31287260106f241003e75f">filterGray</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#402111d45e81968f3f2b42833ed0bdfc">filterInvert</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#338f5cafc4227098b3df875ad9178be2">applyPlugin</a> (std::string plugin, const char *szArgs=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#cbfbaf164b4a8b35d23a4b0f971dc38a">macLoad</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#14856cb5973a364e846cb07f03944914">macCreate</a> (const char *szName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#01bc9c61c1dba6ba2db132d39d9e5675">applyMacro</a> (std::string macroName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#be632fe402a77512c6dee367f96b32e2">setStatusMsg</a> (const char *szMsg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#5b433e039f9d69a91f2989b80547915a">setStatusMsg</a> (const std::string &msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#b78c9705987fc37206b21b2c087e13ae">redraw</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDocWnd.html#fb6699808076e25c81a0ee2f40487f07">drawStatus</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classDocument.html">Document</a> window class.
<p>
<p>
Definition at line <a class="el" href="docwnd_8h-source.html#l00032">32</a> of file <a class="el" href="docwnd_8h-source.html">docwnd.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3fcdee68df26ca12684fc9e4a5f3c00c"></a><!-- doxytag: member="DocWnd::DocWnd" ref="3fcdee68df26ca12684fc9e4a5f3c00c" args="(Image *img)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DocWnd::DocWnd </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classImage.html">Image</a> * </td>
<td class="paramname"> <em>img</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create <a class="el" href="classDocument.html">Document</a> window. This does not mean that window is shown. Use Fl_Window::show() method to do this. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>img</em> </td><td>Pointer to <a class="el" href="classImage.html">Image</a> object to work with. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0cafa2f545788609c9a57cf47526fb95"></a><!-- doxytag: member="DocWnd::~DocWnd" ref="0cafa2f545788609c9a57cf47526fb95" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual DocWnd::~DocWnd </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor is needed for collaboration with <a class="el" href="classDocument.html">Document</a> class.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="760da280ff1048148fb08391ec337b09"></a><!-- doxytag: member="DocWnd::save" ref="760da280ff1048148fb08391ec337b09" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DocWnd::save </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save current image. <a class="el" href="classImage.html">Image</a> will have the same name if already has one. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if really saved. Saving can be also canceled by user. See program documentation for more information. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cc33d77184cec0288018e6e13bdb7f19"></a><!-- doxytag: member="DocWnd::saveAs" ref="cc33d77184cec0288018e6e13bdb7f19" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DocWnd::saveAs </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save current image with new name. User will be prompted for new name. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if really saved. Saving can be also canceled by user. See program documentation for more information. </dd></dl>
</div>
</div><p>
<a class="anchor" name="661da6b6921b3a9c89d2ed463e8686de"></a><!-- doxytag: member="DocWnd::tryClose" ref="661da6b6921b3a9c89d2ed463e8686de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool DocWnd::tryClose </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Close current document window. User will be asked for saving current document if document was changed since last saving. <dl class="return" compact><dt><b>Returns:</b></dt><dd>Return true if really closed. Closing can be also canceled by user. See program documentation for more information. </dd></dl>
</div>
</div><p>
<a class="anchor" name="aa746f5e10586f0c1bb5a0b7f6645477"></a><!-- doxytag: member="DocWnd::undo" ref="aa746f5e10586f0c1bb5a0b7f6645477" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::undo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Undo last change. This can throw <a class="el" href="classCmdHistory_1_1ErrUnderflow.html">CmdHistory::ErrUnderflow</a> exception. See <a class="el" href="classCmdHistory.html">CmdHistory</a> documentation for more information.
</div>
</div><p>
<a class="anchor" name="381941df1a3ce6ec5ada31e0e2b8e577"></a><!-- doxytag: member="DocWnd::redo" ref="381941df1a3ce6ec5ada31e0e2b8e577" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::redo </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Undo last undo. This can throw <a class="el" href="classCmdHistory_1_1ErrUnderflow.html">CmdHistory::ErrUnderflow</a> exception. See <a class="el" href="classCmdHistory.html">CmdHistory</a> documentation for more information.
</div>
</div><p>
<a class="anchor" name="b60bcdc34dd01133ecde3fdedebab867"></a><!-- doxytag: member="DocWnd::unSelect" ref="b60bcdc34dd01133ecde3fdedebab867" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::unSelect </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set selected area to whole image.
</div>
</div><p>
<a class="anchor" name="3fd3fdd95d31287260106f241003e75f"></a><!-- doxytag: member="DocWnd::filterGray" ref="3fd3fdd95d31287260106f241003e75f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::filterGray </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply filter "grayscale"
</div>
</div><p>
<a class="anchor" name="402111d45e81968f3f2b42833ed0bdfc"></a><!-- doxytag: member="DocWnd::filterInvert" ref="402111d45e81968f3f2b42833ed0bdfc" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::filterInvert </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply filter "invert"
</div>
</div><p>
<a class="anchor" name="338f5cafc4227098b3df875ad9178be2"></a><!-- doxytag: member="DocWnd::applyPlugin" ref="338f5cafc4227098b3df875ad9178be2" args="(std::string plugin, const char *szArgs=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::applyPlugin </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>plugin</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>szArgs</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply plugin to current image. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>plugin</em> </td><td>Plugin name (identification) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>szArgs</em> </td><td>Arguments passed to plugin </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="cbfbaf164b4a8b35d23a4b0f971dc38a"></a><!-- doxytag: member="DocWnd::macLoad" ref="cbfbaf164b4a8b35d23a4b0f971dc38a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::macLoad </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start macro loading
</div>
</div><p>
<a class="anchor" name="14856cb5973a364e846cb07f03944914"></a><!-- doxytag: member="DocWnd::macCreate" ref="14856cb5973a364e846cb07f03944914" args="(const char *szName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::macCreate </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>szName</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop macro loading and create new macro. This macro is immediately saved to configuration 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>szName</em> </td><td>New macro name. Macro is overwrited whithout prompt if already exist. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="01bc9c61c1dba6ba2db132d39d9e5675"></a><!-- doxytag: member="DocWnd::applyMacro" ref="01bc9c61c1dba6ba2db132d39d9e5675" args="(std::string macroName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::applyMacro </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"> <em>macroName</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Apply macro on current image. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>macroName</em> </td><td>Name of macro to apply. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="be632fe402a77512c6dee367f96b32e2"></a><!-- doxytag: member="DocWnd::setStatusMsg" ref="be632fe402a77512c6dee367f96b32e2" args="(const char *szMsg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::setStatusMsg </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>szMsg</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set status bar text. Call <a class="el" href="classDocWnd.html#b78c9705987fc37206b21b2c087e13ae">DocWnd::redraw()</a> method to apply this change. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>szMsg</em> </td><td>New text to view in status bar. </td></tr>
</table>
</dl>
<p>
Referenced by <a class="el" href="docwnd_8h-source.html#l00129">setStatusMsg()</a>.
</div>
</div><p>
<a class="anchor" name="5b433e039f9d69a91f2989b80547915a"></a><!-- doxytag: member="DocWnd::setStatusMsg" ref="5b433e039f9d69a91f2989b80547915a" args="(const std::string &msg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::setStatusMsg </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>msg</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set status bar text. Call <a class="el" href="classDocWnd.html#b78c9705987fc37206b21b2c087e13ae">DocWnd::redraw()</a> method to apply this change. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>msg</em> </td><td>New text to view in status bar. </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="docwnd_8h-source.html#l00129">129</a> of file <a class="el" href="docwnd_8h-source.html">docwnd.h</a>.
<p>
References <a class="el" href="classDocWnd.html#be632fe402a77512c6dee367f96b32e2">setStatusMsg()</a>.
</div>
</div><p>
<a class="anchor" name="b78c9705987fc37206b21b2c087e13ae"></a><!-- doxytag: member="DocWnd::redraw" ref="b78c9705987fc37206b21b2c087e13ae" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void DocWnd::redraw </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Redraw document window
</div>
</div><p>
<a class="anchor" name="fb6699808076e25c81a0ee2f40487f07"></a><!-- doxytag: member="DocWnd::drawStatus" ref="fb6699808076e25c81a0ee2f40487f07" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void DocWnd::drawStatus </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Low level draw of status bar. Do not use since you really know what you are doing.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="docwnd_8h-source.html">docwnd.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
classDocWnd.html [Download]