MessageComposer::Composer Class Reference

#include <composer.h>

Inheritance diagram for MessageComposer::Composer:

Public Slots
void	start () override
Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)
bool	resume ()
bool	suspend ()

Public Member Functions
	Composer (QObject *parent=nullptr)
void	addAttachmentPart (MessageCore::AttachmentPart::Ptr part, bool autoresizeImage=false)
void	addAttachmentParts (const MessageCore::AttachmentPart::List &parts, bool autoresizeImage=false)
MessageCore::AttachmentPart::List	attachmentParts () const
bool	autoSave () const
void	clearItipPart ()
void	clearTextPart ()
bool	finished () const
GlobalPart *	globalPart () const
QString	gnupgHome () const
InfoPart *	infoPart () const
ItipPart *	itipPart () const
void	removeAttachmentPart (MessageCore::AttachmentPart::Ptr part)
QList< KMime::Message::Ptr >	resultMessages () const
void	setAutocryptEnabled (bool autocryptEnabled)
void	setAutoSave (bool isAutoSave)
void	setEncryptionKeys (const QList< QPair< QStringList, std::vector< GpgME::Key > > > &data)
void	setGnupgHome (const QString &path)
void	setMessageCryptoFormat (Kleo::CryptoMessageFormat format)
void	setNoCrypto (bool noCrypto)
void	setSenderEncryptionKey (const GpgME::Key &senderKey)
void	setSignAndEncrypt (const bool doSign, const bool doEncrypt)
void	setSigningKeys (const std::vector< GpgME::Key > &signers)
TextPart *	textPart () const
Public Member Functions inherited from MessageComposer::JobBase
	JobBase (QObject *parent=nullptr)
GlobalPart *	globalPart ()
Public Member Functions inherited from KCompositeJob
	KCompositeJob (QObject *parent=nullptr)
Public Member Functions inherited from KJob
	KJob (QObject *parent=nullptr)
Capabilities	capabilities () const
int	error () const
virtual QString	errorString () const
QString	errorText () const
bool	exec ()
bool	isAutoDelete () const
bool	isFinishedNotificationHidden () const
bool	isStartedWithExec () const
bool	isSuspended () const
unsigned long	percent () const
Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const
void	setAutoDelete (bool autodelete)
void	setFinishedNotificationHidden (bool hide=true)
void	setUiDelegate (KJobUiDelegate *delegate)
virtual Q_SCRIPTABLE void	start ()=0
Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const
KJobUiDelegate *	uiDelegate () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () 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 () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, 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
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	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
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Slots
void	slotResult (KJob *job) override
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)

Additional Inherited Members
Public Types inherited from MessageComposer::JobBase
enum	Error { BugError = UserDefinedError + 1 , IncompleteError , UserCancelledError , UserError = UserDefinedError + 42 }
using	List = QList<JobBase *>
Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities
enum	Capability
enum	Unit
Properties inherited from QObject
	objectName
Signals inherited from KJob
void	description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
void	finished (KJob *job)
void	infoMessage (KJob *job, const QString &message)
void	percentChanged (KJob *job, unsigned long percent)
void	processedAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	processedSize (KJob *job, qulonglong size)
void	result (KJob *job)
void	resumed (KJob *job)
void	speed (KJob *job, unsigned long speed)
void	suspended (KJob *job)
void	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)
void	totalSize (KJob *job, qulonglong size)
void	warning (KJob *job, const QString &message)
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)
Public Attributes inherited from KJob
	Bytes
	Directories
	Files
	Items
	Killable
	NoCapabilities
	Suspendable
	UnitsCount
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from MessageComposer::JobBase
	JobBase (JobBasePrivate &dd, QObject *parent)
Protected Member Functions inherited from KCompositeJob
virtual bool	addSubjob (KJob *job)
void	clearSubjobs ()
bool	hasSubjobs () const
virtual bool	removeSubjob (KJob *job)
const QList< KJob * > &	subjobs () const
Protected Member Functions inherited from KJob
virtual bool	doKill ()
virtual bool	doResume ()
virtual bool	doSuspend ()
void	emitPercent (qulonglong processedAmount, qulonglong totalAmount)
void	emitResult ()
void	emitSpeed (unsigned long speed)
bool	isFinished () const
void	setCapabilities (Capabilities capabilities)
void	setError (int errorCode)
void	setErrorText (const QString &errorText)
void	setPercent (unsigned long percentage)
void	setProcessedAmount (Unit unit, qulonglong amount)
void	setProgressUnit (Unit unit)
void	setTotalAmount (Unit unit, qulonglong amount)
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
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)
Protected Attributes inherited from MessageComposer::JobBase
JobBasePrivate *const	d_ptr

Detailed Description

The Composer class.

Definition at line 34 of file composer.h.

Constructor & Destructor Documentation

Composer()

Composer::Composer ( QObject * parent = nullptr )

explicit

Definition at line 484 of file composer.cpp.

Member Function Documentation

addAttachmentPart()

void Composer::addAttachmentPart	(	MessageCore::AttachmentPart::Ptr	part,
		bool	autoresizeImage = false )

Definition at line 553 of file composer.cpp.

addAttachmentParts()

void Composer::addAttachmentParts	(	const MessageCore::AttachmentPart::List &	parts,
		bool	autoresizeImage = false )

Definition at line 577 of file composer.cpp.

attachmentParts()

AttachmentPart::List Composer::attachmentParts

(

)

const

Definition at line 547 of file composer.cpp.

autoSave()

bool Composer::autoSave

(

)

const

Definition at line 666 of file composer.cpp.

clearItipPart()

void Composer::clearItipPart

(

)

Definition at line 540 of file composer.cpp.

clearTextPart()

void Composer::clearTextPart

(

)

Definition at line 523 of file composer.cpp.

finished()

bool Composer::finished

(

)

const

Definition at line 659 of file composer.cpp.

globalPart()

GlobalPart * Composer::globalPart

(

)

const

Definition at line 501 of file composer.cpp.

gnupgHome()

QString Composer::gnupgHome

(

)

const

Definition at line 652 of file composer.cpp.

infoPart()

InfoPart * Composer::infoPart

(

)

const

Definition at line 507 of file composer.cpp.

itipPart()

ItipPart * Composer::itipPart

(

)

const

Definition at line 530 of file composer.cpp.

removeAttachmentPart()

void Composer::removeAttachmentPart

(

MessageCore::AttachmentPart::Ptr

part

)

Definition at line 584 of file composer.cpp.

resultMessages()

QList< KMime::Message::Ptr > Composer::resultMessages

(

)

const

Definition at line 493 of file composer.cpp.

setAutocryptEnabled()

void Composer::setAutocryptEnabled

(

bool

autocryptEnabled

)

Definition at line 631 of file composer.cpp.

setAutoSave()

void Composer::setAutoSave

(

bool

isAutoSave

)

Sets if this message being composed is an auto-saved message if so, might need different handling, such as no crypto attachments.

Definition at line 673 of file composer.cpp.

setEncryptionKeys()

void Composer::setEncryptionKeys

(

const QList< QPair< QStringList, std::vector< GpgME::Key > > > &

data

)

Definition at line 617 of file composer.cpp.

setGnupgHome()

void Composer::setGnupgHome

(

const QString &

path

)

Definition at line 645 of file composer.cpp.

setMessageCryptoFormat()

void Composer::setMessageCryptoFormat

(

Kleo::CryptoMessageFormat

format

)

Definition at line 603 of file composer.cpp.

setNoCrypto()

void Composer::setNoCrypto

(

bool

noCrypto

)

Definition at line 624 of file composer.cpp.

setSenderEncryptionKey()

void Composer::setSenderEncryptionKey

(

const GpgME::Key &

senderKey

)

Definition at line 638 of file composer.cpp.

setSignAndEncrypt()

void Composer::setSignAndEncrypt	(	const bool	doSign,
		const bool	doEncrypt )

Definition at line 596 of file composer.cpp.

setSigningKeys()

void Composer::setSigningKeys

(

const std::vector< GpgME::Key > &

signers

)

Definition at line 610 of file composer.cpp.

slotResult

void Composer::slotResult ( KJob * job )

overrideprotectedslot

Definition at line 686 of file composer.cpp.

start

void Composer::start ( )

overrideslot

Definition at line 680 of file composer.cpp.

textPart()

TextPart * Composer::textPart

(

)

const

Definition at line 513 of file composer.cpp.

---

The documentation for this class was generated from the following files:

• composer.h
• composer.cpp