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/classKFeedbackForm.html

301 lines
16 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: KFeedbackForm 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>KFeedbackForm Class Reference</h1><!-- doxytag: class="KFeedbackForm" --><code>#include &lt;<a class="el" href="kfeedback_8h-source.html">kfeedback.h</a>&gt;</code>
<p>
<a href="classKFeedbackForm-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#72b8b30801614c35e271c5e519f10c8b">sendMail</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#ec2b411546d45e31c9b412f1fa6d8897">mailSent</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#c328809367354cf8ff97e7c78b521345">checkComplete</a> ()</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="classKFeedbackForm.html#78d888d1554e9403a62d7c9b0c6e4a2e">KFeedbackForm</a> (const TQString &amp;feedbackMailAddress, TQWidget *parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#b22414a85a37ca217e028bde8a663ac4">~KFeedbackForm</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#6840e07fe3245d4e9c11ee0160af6068">readyToSend</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classKFeedbackQuestionList.html">KFeedbackQuestionList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#51b1d4e1e48d18c6155203b9f72ada5e">questionList</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected 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="classKFeedbackForm.html#5ec1c36c978229b6e14e9005b595d69e">slotCheckComplete</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TQString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#08ace5fb7dd689ced012aa722b690b71">formatComment</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="anchor" name="4e667e814dc1de15bf601217c08f077f"></a><!-- doxytag: member="KFeedbackForm::_feedbackMailAddress" ref="4e667e814dc1de15bf601217c08f077f" args="" -->
TQString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#4e667e814dc1de15bf601217c08f077f">_feedbackMailAddress</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e8c28be58b2684f090c396ad52f64ad3"></a><!-- doxytag: member="KFeedbackForm::_questionList" ref="e8c28be58b2684f090c396ad52f64ad3" args="" -->
<a class="el" href="classKFeedbackQuestionList.html">KFeedbackQuestionList</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#e8c28be58b2684f090c396ad52f64ad3">_questionList</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="862ae3fd81afe2f61f19d41d927c537b"></a><!-- doxytag: member="KFeedbackForm::_comment" ref="862ae3fd81afe2f61f19d41d927c537b" args="" -->
TQMultiLineEdit *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKFeedbackForm.html#862ae3fd81afe2f61f19d41d927c537b">_comment</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
User feedback form:<p>
User is asked a list of questions, the answers of which will be sent via mail back to a feedback mail address.
<p>
<p>
Definition at line <a class="el" href="kfeedback_8h-source.html#l00098">98</a> of file <a class="el" href="kfeedback_8h-source.html">kfeedback.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="78d888d1554e9403a62d7c9b0c6e4a2e"></a><!-- doxytag: member="KFeedbackForm::KFeedbackForm" ref="78d888d1554e9403a62d7c9b0c6e4a2e" args="(const TQString &amp;feedbackMailAddress, TQWidget *parent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KFeedbackForm::KFeedbackForm </td>
<td>(</td>
<td class="paramtype">const TQString &amp;&nbsp;</td>
<td class="paramname"> <em>feedbackMailAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TQWidget *&nbsp;</td>
<td class="paramname"> <em>parent</em></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.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00080">80</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
<p>
References <a class="el" href="kfeedback_8h-source.html#l00179">_comment</a>, <a class="el" href="kfeedback_8h-source.html#l00178">_questionList</a>, <a class="el" href="kfeedback_8moc_8cpp-source.html#l00191">checkComplete()</a>, and <a class="el" href="kfeedback_8cpp-source.html#l00208">slotCheckComplete()</a>.
</div>
</div><p>
<a class="anchor" name="b22414a85a37ca217e028bde8a663ac4"></a><!-- doxytag: member="KFeedbackForm::~KFeedbackForm" ref="b22414a85a37ca217e028bde8a663ac4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">KFeedbackForm::~KFeedbackForm </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00146">146</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="72b8b30801614c35e271c5e519f10c8b"></a><!-- doxytag: member="KFeedbackForm::sendMail" ref="72b8b30801614c35e271c5e519f10c8b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KFeedbackForm::sendMail </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Compose a mail from the user's answers and send it to the feedback mail address passed to the constructor.<p>
This method will check with <a class="el" href="classKFeedbackForm.html#6840e07fe3245d4e9c11ee0160af6068">readyToSend()</a> if the mail can be sent with the questions answered until now and prompt the user to answer more questions if not.<p>
Connect the <a class="el" href="classKFeedbackForm.html#ec2b411546d45e31c9b412f1fa6d8897">mailSent()</a> signal if you are interested when exactly all this was successful.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00153">153</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
<p>
References <a class="el" href="kfeedback_8h-source.html#l00177">_feedbackMailAddress</a>, <a class="el" href="kfeedback_8h-source.html#l00178">_questionList</a>, <a class="el" href="kfeedback_8cpp-source.html#l00215">formatComment()</a>, <a class="el" href="kfeedback_8moc_8cpp-source.html#l00185">mailSent()</a>, and <a class="el" href="kfeedback_8cpp-source.html#l00270">KFeedbackQuestionList::result()</a>.
</div>
</div><p>
<a class="anchor" name="6840e07fe3245d4e9c11ee0160af6068"></a><!-- doxytag: member="KFeedbackForm::readyToSend" ref="6840e07fe3245d4e9c11ee0160af6068" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool KFeedbackForm::readyToSend </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if the mail is ready to send, i.e. if all required fields are filled.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00229">229</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
<p>
References <a class="el" href="kfeedback_8h-source.html#l00178">_questionList</a>, and <a class="el" href="kfeedback_8cpp-source.html#l00254">KFeedbackQuestionList::isComplete()</a>.
<p>
Referenced by <a class="el" href="kfeedback_8cpp-source.html#l00071">KFeedbackDialog::checkSendButton()</a>.
</div>
</div><p>
<a class="anchor" name="51b1d4e1e48d18c6155203b9f72ada5e"></a><!-- doxytag: member="KFeedbackForm::questionList" ref="51b1d4e1e48d18c6155203b9f72ada5e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKFeedbackQuestionList.html">KFeedbackQuestionList</a>* KFeedbackForm::questionList </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the <a class="el" href="classKFeedbackQuestionList.html">KFeedbackQuestionList</a> .
<p>
Definition at line <a class="el" href="kfeedback_8h-source.html#l00142">142</a> of file <a class="el" href="kfeedback_8h-source.html">kfeedback.h</a>.
<p>
References <a class="el" href="kfeedback_8h-source.html#l00178">_questionList</a>.
<p>
Referenced by <a class="el" href="kshowmailfeedback_8cpp-source.html#l00023">KShowMailApp::slotSendFeedbackMail()</a>.
</div>
</div><p>
<a class="anchor" name="ec2b411546d45e31c9b412f1fa6d8897"></a><!-- doxytag: member="KFeedbackForm::mailSent" ref="ec2b411546d45e31c9b412f1fa6d8897" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KFeedbackForm::mailSent </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emitted when the user has sent the feedback mail - i.e. when he clicked on the "Send mail" button and the mail has successfully been forwarded to the mailer. He can still choose not to send the mail from within the mailer, though.
<p>
Definition at line <a class="el" href="kfeedback_8moc_8cpp-source.html#l00185">185</a> of file <a class="el" href="kfeedback_8moc_8cpp-source.html">kfeedback.moc.cpp</a>.
<p>
Referenced by <a class="el" href="kfeedback_8cpp-source.html#l00153">sendMail()</a>.
</div>
</div><p>
<a class="anchor" name="c328809367354cf8ff97e7c78b521345"></a><!-- doxytag: member="KFeedbackForm::checkComplete" ref="c328809367354cf8ff97e7c78b521345" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KFeedbackForm::checkComplete </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Emitted when it is time to check for completeness of all information in this form: Either when a new question is added or when a question is answered.
<p>
Definition at line <a class="el" href="kfeedback_8moc_8cpp-source.html#l00191">191</a> of file <a class="el" href="kfeedback_8moc_8cpp-source.html">kfeedback.moc.cpp</a>.
<p>
Referenced by <a class="el" href="kfeedback_8cpp-source.html#l00080">KFeedbackForm()</a>, and <a class="el" href="kfeedback_8cpp-source.html#l00208">slotCheckComplete()</a>.
</div>
</div><p>
<a class="anchor" name="5ec1c36c978229b6e14e9005b595d69e"></a><!-- doxytag: member="KFeedbackForm::slotCheckComplete" ref="5ec1c36c978229b6e14e9005b595d69e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KFeedbackForm::slotCheckComplete </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check for completeness of this form.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00208">208</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
<p>
References <a class="el" href="kfeedback_8moc_8cpp-source.html#l00191">checkComplete()</a>.
<p>
Referenced by <a class="el" href="kfeedback_8cpp-source.html#l00080">KFeedbackForm()</a>.
</div>
</div><p>
<a class="anchor" name="08ace5fb7dd689ced012aa722b690b71"></a><!-- doxytag: member="KFeedbackForm::formatComment" ref="08ace5fb7dd689ced012aa722b690b71" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TQString KFeedbackForm::formatComment </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Format the "personal comments" field for sending mail.
<p>
Definition at line <a class="el" href="kfeedback_8cpp-source.html#l00215">215</a> of file <a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a>.
<p>
References <a class="el" href="kfeedback_8h-source.html#l00179">_comment</a>.
<p>
Referenced by <a class="el" href="kfeedback_8cpp-source.html#l00153">sendMail()</a>.
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>kshowmail/<a class="el" href="kfeedback_8h-source.html">kfeedback.h</a><li>kshowmail/<a class="el" href="kfeedback_8cpp-source.html">kfeedback.cpp</a><li>kshowmail/<a class="el" href="kfeedback_8moc_8cpp-source.html">kfeedback.moc.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jul 5 19:36:09 2007 for kshowmail 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>