diff options
Diffstat (limited to 'doc/html/qmailviewerinterface.html')
| -rw-r--r-- | doc/html/qmailviewerinterface.html | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/doc/html/qmailviewerinterface.html b/doc/html/qmailviewerinterface.html new file mode 100644 index 00000000..7fa6b447 --- /dev/null +++ b/doc/html/qmailviewerinterface.html @@ -0,0 +1,156 @@ +<?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"> +<!-- qmailviewer.cpp --> +<head> + <title>QMailViewerInterface 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"> </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">QMailViewerInterface Class Reference</h1> +<p>The QMailViewerInterface class defines the interface to objects that can display a mail message. <a href="#details">More...</a></p> +<pre> #include <QMailViewerInterface></pre><p>Inherits <a href="http://doc.trolltech.com/4.5/qobject.html">QObject</a>.</p> +<ul> +<li><a href="qmailviewerinterface-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="qmailviewerinterface.html#QMailViewerInterface">QMailViewerInterface</a></b> ( QWidget * <i>parent</i> = 0 )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#dtor.QMailViewerInterface">~QMailViewerInterface</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#addActions">addActions</a></b> ( const QList<QAction *> & <i>actions</i> ) = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#handleIncomingMessages">handleIncomingMessages</a></b> ( const QMailMessageIdList & <i>list</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#handleOutgoingMessages">handleOutgoingMessages</a></b> ( const QMailMessageIdList & <i>list</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#isSupported">isSupported</a></b> ( QMailMessage::ContentType <i>t</i>, QMailViewerFactory::PresentationType <i>pres</i> ) const</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#key">key</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QMailViewerFactory::PresentationType </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#presentation">presentation</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#removeAction">removeAction</a></b> ( QAction * <i>action</i> ) = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#scrollToAnchor">scrollToAnchor</a></b> ( const QString & <i>link</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QList<QMailMessage::ContentType> </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#types">types</a></b> () const = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QWidget * </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#widget">widget</a></b> () const = 0</td></tr> +</table> +<ul> +<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-functions">QObject</a></li> +</ul> +<hr /> +<a name="public-slots"></a> +<h2>Public Slots</h2> +<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#clear">clear</a></b> () = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#setMessage">setMessage</a></b> ( const QMailMessage & <i>mail</i> ) = 0</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#setResource">setResource</a></b> ( const QUrl & <i>name</i>, QVariant <i>value</i> )</td></tr> +</table> +<ul> +<li><div bar="2" class="fn"></div>1 public slot inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-slots">QObject</a></li> +</ul> +<hr /> +<a name="signals"></a> +<h2>Signals</h2> +<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%"> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#anchorClicked">anchorClicked</a></b> ( const QUrl & <i>link</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#contactDetails">contactDetails</a></b> ( const QContact & <i>contact</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#finished">finished</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#messageChanged">messageChanged</a></b> ( const QMailMessageId & <i>id</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#respondToMessage">respondToMessage</a></b> ( QMailMessage::ResponseType <i>type</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#respondToMessagePart">respondToMessagePart</a></b> ( const QMailMessagePart::Location & <i>partLocation</i>, QMailMessage::ResponseType <i>type</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#retrieveMessage">retrieveMessage</a></b> ()</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#retrieveMessagePart">retrieveMessagePart</a></b> ( const QMailMessagePart & <i>part</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#retrieveMessagePartPortion">retrieveMessagePartPortion</a></b> ( const QMailMessagePart & <i>part</i>, uint <i>bytes</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#retrieveMessagePortion">retrieveMessagePortion</a></b> ( uint <i>bytes</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#sendMessage">sendMessage</a></b> ( QMailMessage & <i>message</i> )</td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="qmailviewerinterface.html#viewMessage">viewMessage</a></b> ( const QMailMessageId & <i>id</i>, QMailViewerFactory::PresentationType <i>type</i> )</td></tr> +</table> +<ul> +<li><div bar="2" class="fn"></div>1 signal inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#signals">QObject</a></li> +</ul> +<h3>Additional Inherited Members</h3> +<ul> +<li><div class="fn"></div>1 property inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#properties">QObject</a></li> +<li><div class="fn"></div>1 public type inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#public-variables">QObject</a></li> +<li><div class="fn"></div>4 static public members inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#static-public-members">QObject</a></li> +<li><div class="fn"></div>7 protected functions inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-functions">QObject</a></li> +<li><div class="fn"></div>2 protected variables inherited from <a href="http://doc.trolltech.com/4.5/qobject.html#protected-variables">QObject</a></li> +</ul> +<a name="details"></a> +<hr /> +<h2>Detailed Description</h2> +<p>The QMailViewerInterface class defines the interface to objects that can display a mail message.</p> +<p>Qt Extended uses the QMailViewerInterface interface for displaying mail messages. A class may implement the QMailViewerInterface interface to display a mail message format.</p> +<p>The message to be displayed is provided to the viewer class using the <a href="qmailviewerinterface.html#setMessage">setMessage()</a> function. If the message refers to external resources, these should be provided using the <a href="qmailviewerinterface.html#setResource">setResource()</a> function. The <a href="qmailviewerinterface.html#clear">clear()</a> function clears any message or resources previously set.</p> +<p>The viewer object should emit the <a href="qmailviewerinterface.html#anchorClicked">anchorClicked()</a> signal if the user selects a link in the message. If the message supports a concept of completion, then the <a href="qmailviewerinterface.html#finished">finished()</a> signal should be emitted after the display has been completed.</p> +<p>Rather than creating objects that implement the QMailViewerInterface directly, clients should create an object of an appropriate type by using the <a href="qmailviewerfactory.html">QMailViewerFactory</a> class:</p> +<pre> QString key = QMailViewerFactory::defaultKey( QMailViewerFactory::SmilContent ); + QMailViewerInterface* smilViewer = QMailViewerFactory::create( key, this, "smilViewer" );</pre> +<p>See also <a href="qmailviewerfactory.html">QMailViewerFactory</a>.</p> +<hr /> +<h2>Member Function Documentation</h2> +<h3 class="fn"><a name="QMailViewerInterface"></a>QMailViewerInterface::QMailViewerInterface ( <a href="http://doc.trolltech.com/4.5/qwidget.html">QWidget</a> * <i>parent</i> = 0 )</h3> +<p>Constructs the <a href="qmailviewerinterface.html">QMailViewerInterface</a> object with the parent widget <i>parent</i>.</p> +<h3 class="fn"><a name="dtor.QMailViewerInterface"></a>QMailViewerInterface::~QMailViewerInterface () <tt> [virtual]</tt></h3> +<p>Destructs the <a href="qmailviewerinterface.html">QMailViewerInterface</a> object.</p> +<h3 class="fn"><a name="addActions"></a>void QMailViewerInterface::addActions ( const <a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="http://doc.trolltech.com/4.5/qaction.html">QAction</a> *> & <i>actions</i> ) <tt> [pure virtual]</tt></h3> +<p>Requests that the viewer add the content of <i>actions</i> to the set of available user actions.</p> +<h3 class="fn"><a name="anchorClicked"></a>void QMailViewerInterface::anchorClicked ( const <a href="http://doc.trolltech.com/4.5/qurl.html">QUrl</a> & <i>link</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted when the user presses the select key while the display has the anchor <i>link</i> selected.</p> +<h3 class="fn"><a name="clear"></a>void QMailViewerInterface::clear () <tt> [pure virtual slot]</tt></h3> +<p>Resets the display to have no content, and removes any resource associations.</p> +<h3 class="fn"><a name="contactDetails"></a>void QMailViewerInterface::contactDetails ( const QContact & <i>contact</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to request a display of <i>contact</i>'s details.</p> +<h3 class="fn"><a name="finished"></a>void QMailViewerInterface::finished () <tt> [signal]</tt></h3> +<p>This signal is emitted when the display of the current mail message is completed. This signal is emitted only for message types that define a concept of completion, such as SMIL slideshows.</p> +<h3 class="fn"><a name="handleIncomingMessages"></a>bool QMailViewerInterface::handleIncomingMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>list</i> ) const <tt> [virtual]</tt></h3> +<p>Allows the viewer object to handle the notification of the arrival of new messages, identified by <i>list</i>.</p> +<p>Return true to indicate that the event has been handled, or false to let the caller handle the new message event.</p> +<h3 class="fn"><a name="handleOutgoingMessages"></a>bool QMailViewerInterface::handleOutgoingMessages ( const <a href="qmailmessageid.html#QMailMessageIdList-typedef">QMailMessageIdList</a> & <i>list</i> ) const <tt> [virtual]</tt></h3> +<p>Allows the viewer object to handle the notification of the transmission of queued messages, identified by <i>list</i>.</p> +<p>Return true to indicate that the event has been handled, or false to let the caller handle the new message event.</p> +<h3 class="fn"><a name="isSupported"></a>bool QMailViewerInterface::isSupported ( <a href="qmailmessagemetadatafwd.html#ContentType-enum">QMailMessage::ContentType</a> <i>t</i>, <a href="qmailviewerfactory.html#PresentationType-enum">QMailViewerFactory::PresentationType</a> <i>pres</i> ) const</h3> +<p>Returns true if the viewer can present a message containing data of content type <i>t</i>, using the presentation type <i>pres</i>.</p> +<h3 class="fn"><a name="key"></a><a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> QMailViewerInterface::key () const <tt> [pure virtual]</tt></h3> +<p>Returns a value that uniquely identifies the viewer component.</p> +<h3 class="fn"><a name="messageChanged"></a>void QMailViewerInterface::messageChanged ( const <a href="qmailmessageid.html">QMailMessageId</a> & <i>id</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to report that it is now viewing a different message, identified by <i>id</i>.</p> +<h3 class="fn"><a name="presentation"></a><a href="qmailviewerfactory.html#PresentationType-enum">QMailViewerFactory::PresentationType</a> QMailViewerInterface::presentation () const <tt> [pure virtual]</tt></h3> +<p>Returns the type of message presentation that this viewer implements.</p> +<h3 class="fn"><a name="removeAction"></a>void QMailViewerInterface::removeAction ( <a href="http://doc.trolltech.com/4.5/qaction.html">QAction</a> * <i>action</i> ) <tt> [pure virtual]</tt></h3> +<p>Requests that the viewer remove <i>action</i> from the set of available user actions.</p> +<h3 class="fn"><a name="respondToMessage"></a>void QMailViewerInterface::respondToMessage ( <a href="qmailmessagemetadatafwd.html#ResponseType-enum">QMailMessage::ResponseType</a> <i>type</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to initiate a response action, of type <i>type</i>.</p> +<h3 class="fn"><a name="respondToMessagePart"></a>void QMailViewerInterface::respondToMessagePart ( const <a href="qmailmessagepart-location.html">QMailMessagePart::Location</a> & <i>partLocation</i>, <a href="qmailmessagemetadatafwd.html#ResponseType-enum">QMailMessage::ResponseType</a> <i>type</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to initiate a response to the message part indicated by <i>partLocation</i>, of type <i>type</i>.</p> +<h3 class="fn"><a name="retrieveMessage"></a>void QMailViewerInterface::retrieveMessage () <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to initiate a message completion action. This is only meaningful if the message has not yet been completely retrieved.</p> +<p>See also <a href="qmailmessagemetadata.html#status">QMailMessage::status</a>() and <a href="qmailretrievalaction.html#retrieveMessages">QMailRetrievalAction::retrieveMessages</a>().</p> +<h3 class="fn"><a name="retrieveMessagePart"></a>void QMailViewerInterface::retrieveMessagePart ( const <a href="qmailmessagepart.html">QMailMessagePart</a> & <i>part</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to initiate a message part retrieval action for <i>part</i>.</p> +<h3 class="fn"><a name="retrieveMessagePartPortion"></a>void QMailViewerInterface::retrieveMessagePartPortion ( const <a href="qmailmessagepart.html">QMailMessagePart</a> & <i>part</i>, <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>bytes</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to initiate a message part retrieval action for an additional <i>bytes</i> of the <i>part</i>.</p> +<h3 class="fn"><a name="retrieveMessagePortion"></a>void QMailViewerInterface::retrieveMessagePortion ( <a href="http://doc.trolltech.com/4.5/qtglobal.html#uint-typedef">uint</a> <i>bytes</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to retrieve an additional <i>bytes</i> from the message. This is only meaningful if the message has not yet been completely retrieved.</p> +<p>See also <a href="qmailmessagemetadata.html#status">QMailMessage::status</a>() and <a href="qmailretrievalaction.html#retrieveMessages">QMailRetrievalAction::retrieveMessages</a>().</p> +<h3 class="fn"><a name="scrollToAnchor"></a>void QMailViewerInterface::scrollToAnchor ( const <a href="http://doc.trolltech.com/4.5/qstring.html">QString</a> & <i>link</i> ) <tt> [virtual]</tt></h3> +<p>Scrolls the display to position the <i>link</i> within the viewable area.</p> +<h3 class="fn"><a name="sendMessage"></a>void QMailViewerInterface::sendMessage ( <a href="qmailmessage.html">QMailMessage</a> & <i>message</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to send a new message, whose contents are held by <i>message</i>.</p> +<h3 class="fn"><a name="setMessage"></a>bool QMailViewerInterface::setMessage ( const <a href="qmailmessage.html">QMailMessage</a> & <i>mail</i> ) <tt> [pure virtual slot]</tt></h3> +<p>Displays the contents of <i>mail</i>. Returns whether the message could be successfully displayed.</p> +<h3 class="fn"><a name="setResource"></a>void QMailViewerInterface::setResource ( const <a href="http://doc.trolltech.com/4.5/qurl.html">QUrl</a> & <i>name</i>, <a href="http://doc.trolltech.com/4.5/qvariant.html">QVariant</a> <i>value</i> ) <tt> [virtual slot]</tt></h3> +<p>Supplies the viewer object with a resource that may be referenced by a mail message. The resource identified as <i>name</i> will be displayed as the object <i>value</i>.</p> +<h3 class="fn"><a name="types"></a><a href="http://doc.trolltech.com/4.5/qlist.html">QList</a><<a href="qmailmessagemetadatafwd.html#ContentType-enum">QMailMessage::ContentType</a>> QMailViewerInterface::types () const <tt> [pure virtual]</tt></h3> +<p>Returns a list of the content types that can be presented by this viewer component.</p> +<h3 class="fn"><a name="viewMessage"></a>void QMailViewerInterface::viewMessage ( const <a href="qmailmessageid.html">QMailMessageId</a> & <i>id</i>, <a href="qmailviewerfactory.html#PresentationType-enum">QMailViewerFactory::PresentationType</a> <i>type</i> ) <tt> [signal]</tt></h3> +<p>This signal is emitted by the viewer to request a display of the message identified by <i>id</i>, using the presentation style <i>type</i>.</p> +<h3 class="fn"><a name="widget"></a><a href="http://doc.trolltech.com/4.5/qwidget.html">QWidget</a> * QMailViewerInterface::widget () const <tt> [pure virtual]</tt></h3> +<p>Returns the top-level widget that implements the viewer functionality.</p> +<p /><address><hr /><div align="center"> +<table width="100%" cellspacing="0" border="0"><tr class="address"> +<td align="left">Copyright © 2010 QtSoftware</td> +<td align="right"><div align="right">Messaging Framework</div></td> +</tr></table></div></address></body> +</html> |