doc/html/qmailmessagepartcontainer-location.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- qmailmessage.cpp -->
<head>
  <title>Location Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><img src="images/qtlogo.png" align="left" border="0" /></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a></td>
<td align="right" valign="top" width="230"><img src="images/codeless.png"  border="0" /></td></tr></table><h1 class="title">Location Class Reference<br /><span class="small-subtitle">(QMailMessagePartContainer::Location)<br /></span>
</h1>
<p>The Location class contains a specification of the location of a message part with the message that contains it. <a href="#details">More...</a></p>
<pre>    #include &lt;<a href="qmailmessagepartcontainer.html">QMailMessagePartContainer</a>&gt;</pre><p><b>This class is under development and is subject to change.</b></p>
<ul>
<li><a href="qmailmessagepartcontainer-location-members.html">List of all members, including inherited members</a></li>
</ul>
<hr />
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#Location">Location</a></b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#Location-2">Location</a></b> ( const QString &amp; <i>description</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#Location-3">Location</a></b> ( const Location &amp; <i>other</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QMailMessageId </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#containingMessageId">containingMessageId</a></b> () const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#isValid">isValid</a></b> ( bool <i>extended</i> = true ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#setContainingMessageId">setContainingMessageId</a></b> ( const QMailMessageId &amp; <i>id</i> )</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#toString">toString</a></b> ( bool <i>extended</i> ) const</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailmessagepartcontainer-location.html#operator-eq-eq">operator==</a></b> ( const QMailMessagePartContainer::Location &amp; <i>other</i> ) const</td></tr>
</table>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The Location class contains a specification of the location of a message part with the message that contains it.</p>
<p>A Location object is used to refer to a single part within a multi-part message. The location can be used to reference a part within a <a href="qmailmessage.html">QMailMessage</a> object, via the <a href="qmailmessage.html#partAt">partAt</a> function.</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="Location"></a>Location::Location ()</h3>
<p>Creates an empty part location object.</p>
<h3 class="fn"><a name="Location-2"></a>Location::Location ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> &amp; <i>description</i> )</h3>
<p>Creates a part location object referring to the location given by <i>description</i>.</p>
<p>See also <a href="qmailmessagepartcontainer-location.html#toString">toString</a>().</p>
<h3 class="fn"><a name="Location-3"></a>Location::Location ( const Location &amp; <i>other</i> )</h3>
<p>Creates a part location object containing a copy of <i>other</i>.</p>
<h3 class="fn"><a name="containingMessageId"></a><a href="qmailmessageid.html">QMailMessageId</a> Location::containingMessageId () const</h3>
<p>Returns the identifier of the message that contains the part with this location.</p>
<p>See also <a href="qmailmessagepartcontainer-location.html#setContainingMessageId">setContainingMessageId</a>().</p>
<h3 class="fn"><a name="isValid"></a>bool Location::isValid ( bool <i>extended</i> = true ) const</h3>
<p>Returns true if the location object contains the location of a valid message part. If <i>extended</i> is true, the location must also contain a valid message identifier.</p>
<h3 class="fn"><a name="setContainingMessageId"></a>void Location::setContainingMessageId ( const <a href="qmailmessageid.html">QMailMessageId</a> &amp; <i>id</i> )</h3>
<p>Sets the identifier of the message that contains the part with this location to <i>id</i>.</p>
<p>See also <a href="qmailmessagepartcontainer-location.html#containingMessageId">containingMessageId</a>().</p>
<h3 class="fn"><a name="toString"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> Location::toString ( bool <i>extended</i> ) const</h3>
<p>Returns a textual representation of the part location. If <i>extended</i> is true, the representation contains the identifier of the containing message.</p>
<h3 class="fn"><a name="operator-eq-eq"></a>bool Location::operator== ( const QMailMessagePartContainer::Location &amp; <i>other</i> ) const</h3>
<p>Returns true if <i>other</i> is referring to the same location</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td align="left">Copyright &copy; 2010 QtSoftware</td>
<td align="right"><div align="right">Messaging Framework</div></td>
</tr></table></div></address></body>
</html>