Search for usage in LXR

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 }


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)
void tooManyRecipient (bool)

Public Slots

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

Public Member Functions

 ComposerViewBase (QObject *parent=nullptr, QWidget *widget=nullptr)
void addAttachment (const QString &name, const QString &filename, const QString &charset, const QByteArray &data, const QByteArray &mimeType)
void addAttachment (const QUrl &url, const QString &comment, bool sync)
void addAttachmentPart (KMime::Content *part)
MessageComposer::AttachmentControllerBaseattachmentController ()
MessageComposer::AttachmentModelattachmentModel ()
bool autocryptEnabled () const
QString bcc () const
QString cc () const
ComposerViewBase::MissingAttachment checkForMissingAttachments (const QStringList &attachmentKeywords)
void cleanupAutoSave ()
void clearFollowUp ()
const KIdentityManagementCore::IdentitycurrentIdentity () const
Sonnet::DictionaryComboBoxdictionary () const
MessageComposer::RichTextComposerNgeditor () const
std::shared_ptr< Kleo::ExpiryChecker > expiryChecker ()
Akonadi::CollectionComboBoxfccCombo () const
void fillComposer (MessageComposer::Composer *composer)
Akonadi::Collection followUpCollection () const
QDate followUpDate () const
QString from () const
bool hasMissingAttachments (const QStringList &attachmentKeywords)
KIdentityManagementWidgets::IdentityComboidentityCombo ()
KIdentityManagementCore::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 QList< 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 (KIdentityManagementWidgets::IdentityCombo *identCombo)
void setIdentityManager (KIdentityManagementCore::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 QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, 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_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
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 (const QObject *object)
qobject_cast (QObject *object)
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
- 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 *context, Functor functor, 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)
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, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction 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 72 of file composerviewbase.h.

Member Function Documentation

◆ addAttachment()

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

Add the given attachment to the message.

Definition at line 1497 of file composerviewbase.cpp.

◆ autoSaveMessage

void ComposerViewBase::autoSaveMessage ( )

Save the message.

Definition at line 1270 of file composerviewbase.cpp.

◆ checkForMissingAttachments()

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.

attachmentKeywordsa list with the keywords that indicate an attachment should be present
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 1890 of file composerviewbase.cpp.

◆ cleanupAutoSave()

void ComposerViewBase::cleanupAutoSave ( )

Stop autosaving and delete the autosaved message.

Definition at line 1243 of file composerviewbase.cpp.

◆ disableHtml

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

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.

◆ failed

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

Message sending failed with given error message.

◆ isComposing()

bool ComposerViewBase::isComposing ( ) const

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

Definition at line 98 of file composerviewbase.cpp.

◆ modified

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

The composer was modified.

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

◆ send()

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 312 of file composerviewbase.cpp.

◆ sentSuccessfully

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

Message sending completed successfully.

◆ setAttachmentModel()

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

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

Definition at line 1640 of file composerviewbase.cpp.

◆ setAutoSaveFileName()

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 1293 of file composerviewbase.cpp.

◆ setCryptoOptions()

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 1818 of file composerviewbase.cpp.

◆ setFrom()

void ComposerViewBase::setFrom ( const QString from)

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

Definition at line 1799 of file composerviewbase.cpp.

◆ setMessage()

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 103 of file composerviewbase.cpp.

◆ to()

QString ComposerViewBase::to ( ) const

Header fields in recipients editor.

Definition at line 1571 of file composerviewbase.cpp.

◆ updateAutoSave()

void ComposerViewBase::updateAutoSave ( )

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

Definition at line 1225 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-2023 The KDE developers.
Generated on Tue Dec 5 2023 04:03:20 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.