You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kshowmail/doc/html/classKshowmailDoc.html

265 lines
13 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>kshowmail.tdevelop: KshowmailDoc 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.0 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.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="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>
<h1>KshowmailDoc Class Reference</h1><!-- doxytag: class="KshowmailDoc" --><code>#include &lt;<a class="el" href="kshowmaildoc_8h-source.html">kshowmaildoc.h</a>&gt;</code>
<p>
<a href="classKshowmailDoc-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 Slots</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#2feac43fb28fdb4971fb601520d17c54">slotUpdateAllViews</a> (<a class="el" href="classKshowmailView.html">KshowmailView</a> *sender)</td></tr>
<tr><td colspan="2"><br><h2>Public 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="classKshowmailDoc.html#02b11dd19d0c777a043a491d8811a553">KshowmailDoc</a> (TQWidget *parent, const char *name=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#fe8d064e8b1d44683fde4e3261333841">~KshowmailDoc</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#d9c7e004cad6927dd62d7a0d8f1f29b1">addView</a> (<a class="el" href="classKshowmailView.html">KshowmailView</a> *view)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#e9cd9ebc0c1bbbdf1d4178bc92fe5f55">removeView</a> (<a class="el" href="classKshowmailView.html">KshowmailView</a> *view)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#929fdd9ad1f89ed9a000cf8c96d9f711">newDocument</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const KURL &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#a498d92a8c3b8a41f2bbf198f593435a">URL</a> () const</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#aad1bfe0342bb8ef8b48e4feae5a4e7c">setURL</a> (const KURL &amp;url)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classKshowmailView.html">KshowmailView</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#c3f05aa2557d4b0f94392530ea62bbd4">pView</a></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">KURL&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKshowmailDoc.html#4c93bab9aac95af03ca857ab3e09cf21">doc_url</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classKshowmailDoc.html">KshowmailDoc</a> provides a document object for a document-view model.<p>
The <a class="el" href="classKshowmailDoc.html">KshowmailDoc</a> class provides a document object that can be used in conjunction with the classes KshowmailApp and <a class="el" href="classKshowmailView.html">KshowmailView</a> to create a document-view model for standard KDE applications based on TDEApplication and TDEMainWindow. Thereby, the document object is created by the KshowmailApp instance and contains the document structure with the according methods for manipulation of the document data by <a class="el" href="classKshowmailView.html">KshowmailView</a> objects. Also, <a class="el" href="classKshowmailDoc.html">KshowmailDoc</a> contains the methods for serialization of the document data from and to files.<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Source Framework Automatically Generated by KDevelop, (c) The KDevelop Team. </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd>KDevelop version 1.2 code generation </dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="02b11dd19d0c777a043a491d8811a553"></a><!-- doxytag: member="KshowmailDoc::KshowmailDoc" ref="02b11dd19d0c777a043a491d8811a553" args="(TQWidget *parent, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KshowmailDoc::KshowmailDoc </td>
<td>(</td>
<td class="paramtype">TQWidget *&nbsp;</td>
<td class="paramname"> <em>parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>name</em> = <code>0</code></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor for the fileclass of the application
</div>
</div><p>
<a class="anchor" name="fe8d064e8b1d44683fde4e3261333841"></a><!-- doxytag: member="KshowmailDoc::~KshowmailDoc" ref="fe8d064e8b1d44683fde4e3261333841" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KshowmailDoc::~KshowmailDoc </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor for the fileclass of the application
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d9c7e004cad6927dd62d7a0d8f1f29b1"></a><!-- doxytag: member="KshowmailDoc::addView" ref="d9c7e004cad6927dd62d7a0d8f1f29b1" args="(KshowmailView *view)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KshowmailDoc::addView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKshowmailView.html">KshowmailView</a> *&nbsp;</td>
<td class="paramname"> <em>view</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
adds a view to the document which represents the document contents. Usually this is your main view.
</div>
</div><p>
<a class="anchor" name="e9cd9ebc0c1bbbdf1d4178bc92fe5f55"></a><!-- doxytag: member="KshowmailDoc::removeView" ref="e9cd9ebc0c1bbbdf1d4178bc92fe5f55" args="(KshowmailView *view)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KshowmailDoc::removeView </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKshowmailView.html">KshowmailView</a> *&nbsp;</td>
<td class="paramname"> <em>view</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
removes a view from the list of currently connected views
</div>
</div><p>
<a class="anchor" name="929fdd9ad1f89ed9a000cf8c96d9f711"></a><!-- doxytag: member="KshowmailDoc::newDocument" ref="929fdd9ad1f89ed9a000cf8c96d9f711" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KshowmailDoc::newDocument </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
initializes the document generally
</div>
</div><p>
<a class="anchor" name="a498d92a8c3b8a41f2bbf198f593435a"></a><!-- doxytag: member="KshowmailDoc::URL" ref="a498d92a8c3b8a41f2bbf198f593435a" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const KURL &amp; KshowmailDoc::URL </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
returns the KURL of the document
</div>
</div><p>
<a class="anchor" name="aad1bfe0342bb8ef8b48e4feae5a4e7c"></a><!-- doxytag: member="KshowmailDoc::setURL" ref="aad1bfe0342bb8ef8b48e4feae5a4e7c" args="(const KURL &amp;url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KshowmailDoc::setURL </td>
<td>(</td>
<td class="paramtype">const KURL &amp;&nbsp;</td>
<td class="paramname"> <em>url</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
sets the URL of the document
</div>
</div><p>
<a class="anchor" name="2feac43fb28fdb4971fb601520d17c54"></a><!-- doxytag: member="KshowmailDoc::slotUpdateAllViews" ref="2feac43fb28fdb4971fb601520d17c54" args="(KshowmailView *sender)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KshowmailDoc::slotUpdateAllViews </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKshowmailView.html">KshowmailView</a> *&nbsp;</td>
<td class="paramname"> <em>sender</em> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
calls repaint() on all views connected to the document object and is called by the view by which the document has been changed. As this view normally repaints itself, it is excluded from the paintEvent.
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="c3f05aa2557d4b0f94392530ea62bbd4"></a><!-- doxytag: member="KshowmailDoc::pView" ref="c3f05aa2557d4b0f94392530ea62bbd4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKshowmailView.html">KshowmailView</a> * <a class="el" href="classKshowmailDoc.html#c3f05aa2557d4b0f94392530ea62bbd4">KshowmailDoc::pView</a><code> [static]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the list of the views currently connected to the document
</div>
</div><p>
<a class="anchor" name="4c93bab9aac95af03ca857ab3e09cf21"></a><!-- doxytag: member="KshowmailDoc::doc_url" ref="4c93bab9aac95af03ca857ab3e09cf21" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KURL <a class="el" href="classKshowmailDoc.html#4c93bab9aac95af03ca857ab3e09cf21">KshowmailDoc::doc_url</a><code> [private]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the modified flag of the current document
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>Daten/Documents/programmieren/kshowmail/kshowmail/kshowmail/<a class="el" href="kshowmaildoc_8h-source.html">kshowmaildoc.h</a><li>Daten/Documents/programmieren/kshowmail/kshowmail/kshowmail/<a class="el" href="kshowmaildoc_8cpp.html">kshowmaildoc.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Apr 1 21:59:50 2008 for kshowmail.tdevelop by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>