MessageComposer::ComposerViewBase

MessageComposer::ComposerViewBase Class Reference

#include <composerviewbase.h>

Inheritance diagram for MessageComposer::ComposerViewBase:

Public Types

enum  Confirmation { LetUserConfirm, NoConfirmationNeeded }
 
enum  FailedType { Sending, AutoSave }
 
enum  MissingAttachment { NoMissingAttachmentFound, FoundMissingAttachmentAndSending, FoundMissingAttachmentAndAddedAttachment, FoundMissingAttachmentAndCancel }
 

Signals

void disableHtml (MessageComposer::ComposerViewBase::Confirmation)
 
void enableHtml ()
 
void failed (const QString &errorMessage, MessageComposer::ComposerViewBase::FailedType type=Sending)
 
void modified (bool isModified)
 
void sentSuccessfully (Akonadi::Item::Id id)
 

Public Slots

void autoSaveMessage ()
 
void identityChanged (const KIdentityManagement::Identity &ident, const KIdentityManagement::Identity &oldIdent, bool msgCleared=false)
 

Public Member Functions

 ComposerViewBase (QObject *parent=nullptr, QWidget *widget=nullptr)
 
void addAttachment (const QUrl &url, const QString &comment, bool sync)
 
void addAttachment (const QString &name, const QString &filename, const QString &charset, const QByteArray &data, const QByteArray &mimeType)
 
void addAttachmentPart (KMime::Content *part)
 
MessageComposer::AttachmentControllerBaseattachmentController ()
 
MessageComposer::AttachmentModelattachmentModel ()
 
QString bcc () const
 
QString cc () const
 
ComposerViewBase::MissingAttachment checkForMissingAttachments (const QStringList &attachmentKeywords)
 
void cleanupAutoSave ()
 
void clearFollowUp ()
 
MessageComposer::ComposercreateSimpleComposer ()
 
Sonnet::DictionaryComboBoxdictionary () const
 
MessageComposer::RichTextComposerNgeditor () const
 
Akonadi::CollectionComboBoxfccCombo () const
 
Akonadi::Collection followUpCollection () const
 
QDate followUpDate () const
 
QString from () const
 
bool hasMissingAttachments (const QStringList &attachmentKeywords)
 
KIdentityManagement::IdentityComboidentityCombo ()
 
KIdentityManagement::IdentityManageridentityManager ()
 
bool isComposing () const
 
KMime::Message::Ptr msg () const
 
MessageComposer::RecipientsEditorrecipientsEditor ()
 
QString replyTo () const
 
bool requestDeleveryConfirmation () const
 
void saveMailSettings ()
 
void send (MessageComposer::MessageSender::SendMethod method, MessageComposer::MessageSender::SaveIn saveIn, bool checkMailDispatcher=true)
 
SendLaterInfosendLaterInfo () const
 
void setAttachmentController (MessageComposer::AttachmentControllerBase *controller)
 
void setAttachmentModel (MessageComposer::AttachmentModel *model)
 
void setAutoSaveFileName (const QString &fileName)
 
void setAutoSaveInterval (int interval)
 
void setCharsets (const QVector< QByteArray > &charsets)
 
void setCryptoOptions (bool sign, bool encrypt, Kleo::CryptoMessageFormat format, bool neverEncryptDrafts=false)
 
void setCustomHeader (const QMap< QByteArray, QString > &customHeader)
 
void setDictionary (Sonnet::DictionaryComboBox *dictionary)
 
void setEditor (MessageComposer::RichTextComposerNg *editor)
 
void setFcc (const Akonadi::Collection &id)
 
void setFccCombo (Akonadi::CollectionComboBox *fcc)
 
void setFollowUpCollection (const Akonadi::Collection &followUpCollection)
 
void setFollowUpDate (const QDate &followUpDate)
 
void setFrom (const QString &from)
 
void setIdentityCombo (KIdentityManagement::IdentityCombo *identCombo)
 
void setIdentityManager (KIdentityManagement::IdentityManager *identMan)
 
void setMDNRequested (bool mdnRequested)
 
void setMessage (const KMime::Message::Ptr &newMsg, bool allowDecryption)
 
void setParentWidgetForGui (QWidget *)
 
void setRecipientsEditor (MessageComposer::RecipientsEditor *recEditor)
 
void setRequestDeleveryConfirmation (bool requestDeleveryConfirmation)
 
void setSendLaterInfo (SendLaterInfo *info)
 
void setSignatureController (MessageComposer::SignatureController *sigController)
 
void setSubject (const QString &subject)
 
void setTransportCombo (MailTransport::TransportComboBox *transpCombo)
 
void setUrgent (bool urgent)
 
MessageComposer::SignatureControllersignatureController ()
 
QString subject () const
 
QString to () const
 
MailTransport::TransportComboBoxtransportComboBox () const
 
void updateAutoSave ()
 
void updateTemplate (const KMime::Message::Ptr &msg)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

The ComposerViewBase class.

Definition at line 76 of file composerviewbase.h.

Member Function Documentation

void ComposerViewBase::addAttachment ( const QUrl url,
const QString comment,
bool  sync 
)

Add the given attachment to the message.

Definition at line 1370 of file composerviewbase.cpp.

void ComposerViewBase::autoSaveMessage ( )
slot

Save the message.

Definition at line 1148 of file composerviewbase.cpp.

ComposerViewBase::MissingAttachment ComposerViewBase::checkForMissingAttachments ( const QStringList attachmentKeywords)

Check if the mail has references to attachments, but no attachments are added to it.

If missing attachments are found, a dialog to add new attachments is shown.

Parameters
attachmentKeywordsa list with the keywords that indicate an attachment should be present
Returns
NoMissingAttachmentFound, if there is attachment in email FoundMissingAttachmentAndCancelSending, if mail might miss attachment but sending FoundMissingAttachmentAndAddedAttachment, if mail might miss attachment and we added an attachment FoundMissingAttachmentAndCancel, if mail might miss attachment and cancel sending

Definition at line 1763 of file composerviewbase.cpp.

void ComposerViewBase::cleanupAutoSave ( )

Stop autosaving and delete the autosaved message.

Definition at line 1120 of file composerviewbase.cpp.

void MessageComposer::ComposerViewBase::disableHtml ( MessageComposer::ComposerViewBase::Confirmation  )
signal

Enabling or disabling HTML in the editor is affected by various client options, so when that would otherwise happen, hand it off to the client to enact it for real.

void MessageComposer::ComposerViewBase::failed ( const QString errorMessage,
MessageComposer::ComposerViewBase::FailedType  type = Sending 
)
signal

Message sending failed with given error message.

bool ComposerViewBase::isComposing ( ) const

Returns true if there is at least one composer job running.

Definition at line 112 of file composerviewbase.cpp.

void MessageComposer::ComposerViewBase::modified ( bool  isModified)
signal

The composer was modified.

This can happen behind the users' back when, for example, and autosaved message was recovered.

void ComposerViewBase::send ( MessageComposer::MessageSender::SendMethod  method,
MessageComposer::MessageSender::SaveIn  saveIn,
bool  checkMailDispatcher = true 
)

Send the message with the specified method, saving it in the specified folder.

Definition at line 301 of file composerviewbase.cpp.

void MessageComposer::ComposerViewBase::sentSuccessfully ( Akonadi::Item::Id  id)
signal

Message sending completed successfully.

void ComposerViewBase::setAttachmentModel ( MessageComposer::AttachmentModel model)

The following are for setting the various options and widgets in the composer.

Definition at line 1501 of file composerviewbase.cpp.

void ComposerViewBase::setAutoSaveFileName ( const QString fileName)

Sets the filename to use when autosaving something.

This is used when the client recovers the autosave files: It calls this method, so that the composer uses the same filename again. That way, the recovered autosave file is properly cleaned up in cleanupAutoSave():

Definition at line 1169 of file composerviewbase.cpp.

void ComposerViewBase::setCryptoOptions ( bool  sign,
bool  encrypt,
Kleo::CryptoMessageFormat  format,
bool  neverEncryptDrafts = false 
)

The following are various settings the user can modify when composing a message.

If they are not set, the default values will be used.

Definition at line 1681 of file composerviewbase.cpp.

void ComposerViewBase::setFrom ( const QString from)

Widgets for editing differ in client classes, so values are set before sending.

Definition at line 1662 of file composerviewbase.cpp.

void ComposerViewBase::setMessage ( const KMime::Message::Ptr newMsg,
bool  allowDecryption 
)

Set the message to be opened in the composer window, and set the internal data structures to keep track of it.

Definition at line 117 of file composerviewbase.cpp.

QString ComposerViewBase::to ( ) const

Header fields in recipients editor.

Definition at line 1442 of file composerviewbase.cpp.

void ComposerViewBase::updateAutoSave ( )

Enables/disables autosaving depending on the value of the autosave interval.

Definition at line 1100 of file composerviewbase.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun May 31 2020 22:44:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.