Home · All Classes · Grouped Classes · Annotated · Functions

QMailComposerPluginInterface Class Reference

The QMailComposerPluginInterface class defines the interface to plug-ins that provide mail message composers. More...

    #include <QMailComposerPluginInterface>

Inherited by QMailComposerPlugin.

• List of all members, including inherited members

Public Functions

• virtual QMailComposerInterface * create ( QWidget * parent ) = 0
• virtual QIcon displayIcon () const = 0
• virtual QString displayName () const = 0
• virtual bool isSupported ( QMailMessage::MessageType type ) const = 0
• virtual QString key () const = 0
• virtual QMailMessage::MessageType messageType () const = 0
• virtual QString name () const = 0

Detailed Description

The QMailComposerPluginInterface class defines the interface to plug-ins that provide mail message composers.

The QMailComposerPluginInterface class defines the interface to mail message composer plug-ins. Plug-ins will typically inherit from QMailComposerPlugin rather than this class.

See also QMailComposerPlugin, QMailComposerInterface, and QMailComposerFactory.

Member Function Documentation

QMailComposerInterface * QMailComposerPluginInterface::create ( QWidget * parent )   [pure virtual]

Creates an instance of the message composer provided by this plug-in, setting the returned object to have the parent widget parent.

QIcon QMailComposerPluginInterface::displayIcon () const   [pure virtual]

Returns the icon representing the message type created by the composer provided by this plug-in.

QString QMailComposerPluginInterface::displayName () const   [pure virtual]

Returns the translated name of the message type created by the composer provided by this plug-in, in a form suitable for display on a button or menu.

bool QMailComposerPluginInterface::isSupported ( QMailMessage::MessageType type ) const   [pure virtual]

Returns true if the composer provided by this plug-in can create a mail message with type content; otherwise returns false.

QString QMailComposerPluginInterface::key () const   [pure virtual]

Returns a string identifying this plug-in.

QMailMessage::MessageType QMailComposerPluginInterface::messageType () const   [pure virtual]

Returns the type of message created by the composer provided by this plug-in.

QString QMailComposerPluginInterface::name () const   [pure virtual]

Returns the translated name of the message type created by the composer provided by this plug-in.