Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QMailViewerInterface Class Reference
[QtMessagingModule, QtPimModule]

The QMailViewerInterface class defines the interface to objects that can display a mail message. More...

    #include <QMailViewerInterface>

Inherits QObject.

• List of all members, including inherited members

Public Functions

• QMailViewerInterface ( QWidget * parent = 0 )
• virtual ~QMailViewerInterface ()
• virtual void addActions ( QMenu * menu ) const
• virtual bool handleIncomingMessages ( const QMailMessageIdList & list ) const
• virtual bool handleOutgoingMessages ( const QMailMessageIdList & list ) const
• virtual void scrollToAnchor ( const QString & link )
• virtual QWidget * widget () const = 0

• 29 public functions inherited from QObject

Public Slots

• virtual void clear () = 0
• virtual bool setMessage ( const QMailMessage & mail ) = 0
• virtual void setResource ( const QUrl & name, QVariant value )

• 1 public slot inherited from QObject

Signals

• void anchorClicked ( const QUrl & link )
• void completeMessage ()
• void contactDetails ( const QContact & contact )
• void deleteMessage ()
• void finished ()
• void forwardMessage ()
• void messageChanged ( const QMailMessageId & id )
• void replyToAll ()
• void replyToSender ()
• void saveSender ()
• void sendMessage ( const QMailMessage & message )
• void viewMessage ( const QMailMessageId & id, QMailViewerFactory::PresentationType type )

• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QMailViewerInterface class defines the interface to objects that can display a mail message.

Qt Extended uses the QMailViewerInterface interface for displaying mail messages. A class may implement the QMailViewerInterface interface to display a mail message format.

The message to be displayed is provided to the viewer class using the setMessage() function. If the message refers to external resources, these should be provided using the setResource() function. The clear() function clears any message or resources previously set.

The viewer object should emit the anchorClicked() signal if the user selects a link in the message. If the message supports a concept of completion, then the finished() signal should be emitted after the display has been completed.

Rather than creating objects that implement the QMailViewerInterface directly, clients should create an object of an appropriate type by using the QMailViewerFactory class:

    QString key = QMailViewerFactory::defaultKey( QMailViewerFactory::SmilContent );
    QMailViewerInterface* smilViewer = QMailViewerFactory::create( key, this, "smilViewer" );

To allow a class to be created through the QMailViewerFactory interface, a plug-in class derived from QMailViewerPlugin should be implemented.

See also QMailViewerFactory and QMailViewerPlugin.

Member Function Documentation

QMailViewerInterface::QMailViewerInterface ( QWidget * parent = 0 )

Constructs the QMailViewerInterface object with the parent widget parent.

QMailViewerInterface::~QMailViewerInterface ()   [virtual]

Destructs the QMailViewerInterface object.

void QMailViewerInterface::addActions ( QMenu * menu ) const   [virtual]

Allows the viewer object to add any relevant actions to the application menu supplied.

void QMailViewerInterface::anchorClicked ( const QUrl & link )   [signal]

This signal is emitted when the user presses the select key while the display has the anchor link selected.

void QMailViewerInterface::clear ()   [pure virtual slot]

Resets the display to have no content, and removes any resource associations.

void QMailViewerInterface::completeMessage ()   [signal]

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.

See also QMailMessage::status() and QMailMessageServer::completeRetrieval().

void QMailViewerInterface::contactDetails ( const QContact & contact )   [signal]

This signal is emitted by the viewer to request a display of contact's details.

void QMailViewerInterface::deleteMessage ()   [signal]

This signal is emitted by the viewer to initiate a message deletion action.

void QMailViewerInterface::finished ()   [signal]

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.

void QMailViewerInterface::forwardMessage ()   [signal]

This signal is emitted by the viewer to initiate a message forwarding action.

bool QMailViewerInterface::handleIncomingMessages ( const QMailMessageIdList & list ) const   [virtual]

Allows the viewer object to handle the notification of the arrival of new messages, identified by list.

Return true to indicate that the event has been handled, or false to let the caller handle the new message event.

bool QMailViewerInterface::handleOutgoingMessages ( const QMailMessageIdList & list ) const   [virtual]

Allows the viewer object to handle the notification of the transmission of queued messages, identified by list.

Return true to indicate that the event has been handled, or false to let the caller handle the new message event.

void QMailViewerInterface::messageChanged ( const QMailMessageId & id )   [signal]

This signal is emitted by the viewer to report that it is now viewing a different message, identified by id.

void QMailViewerInterface::replyToAll ()   [signal]

This signal is emitted by the viewer to initiate a reply-to-all action.

void QMailViewerInterface::replyToSender ()   [signal]

This signal is emitted by the viewer to initiate a reply action.

void QMailViewerInterface::saveSender ()   [signal]

This signal is emitted by the viewer to request that the sender's address should be saved as a Contact.

void QMailViewerInterface::scrollToAnchor ( const QString & link )   [virtual]

Scrolls the display to position the link within the viewable area.

void QMailViewerInterface::sendMessage ( const QMailMessage & message )   [signal]

This signal is emitted by the viewer to send a new message, whose contents are held by message.

bool QMailViewerInterface::setMessage ( const QMailMessage & mail )   [pure virtual slot]

Displays the contents of mail. Returns whether the message could be successfully displayed.

void QMailViewerInterface::setResource ( const QUrl & name, QVariant value )   [virtual slot]

Supplies the viewer object with a resource that may be referenced by a mail message. The resource identified as name will be displayed as the object value.

void QMailViewerInterface::viewMessage ( const QMailMessageId & id, QMailViewerFactory::PresentationType type )   [signal]

This signal is emitted by the viewer to request a display of the message identified by id, using the presentation style type.

QWidget * QMailViewerInterface::widget () const   [pure virtual]

Returns the widget implementing the display interface.