MessageComposer::ContentJobBase Class Reference

#include <contentjobbase.h>

Inheritance diagram for MessageComposer::ContentJobBase:

Public Member Functions
	ContentJobBase (QObject *parent=nullptr)
bool	appendSubjob (ContentJobBase *job)
KMime::Content *	content () const
KMime::Content *	extraContent () const
void	setExtraContent (KMime::Content *extra)
void	start () override
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
qint64	elapsedTime () 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)
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
virtual void	doStart ()
virtual void	process ()=0
void	slotResult (KJob *job) override
Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)
virtual void	slotResult (KJob *job)

Protected Member Functions
	ContentJobBase (ContentJobBasePrivate &dd, QObject *parent)
bool	addSubjob (KJob *job) override
Protected Member Functions inherited from MessageComposer::JobBase
	JobBase (JobBasePrivate &dd, QObject *parent)
Protected Member Functions inherited from KCompositeJob
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)
void	startElapsedTimer ()
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)

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
Public Types inherited from QObject
typedef	QObjectList
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)
Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::Quietly)
bool	resume ()
bool	suspend ()
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
Protected Attributes inherited from MessageComposer::JobBase
JobBasePrivate *const	d_ptr

Detailed Description

The ContentJobBase class.

Definition at line 25 of file contentjobbase.h.

Constructor & Destructor Documentation

ContentJobBase() [1/2]

ContentJobBase::ContentJobBase ( QObject * parent = nullptr )

explicit

Definition at line 38 of file contentjobbase.cpp.

ContentJobBase() [2/2]

ContentJobBase::ContentJobBase ( ContentJobBasePrivate & dd, QObject * parent )

protected

Definition at line 45 of file contentjobbase.cpp.

Member Function Documentation

addSubjob()

bool ContentJobBase::addSubjob ( KJob * job )

overrideprotectedvirtual

Use appendSubjob() instead.

Reimplemented from KCompositeJob.

Definition at line 87 of file contentjobbase.cpp.

appendSubjob()

bool ContentJobBase::appendSubjob

(

ContentJobBase *

job

)

This is meant to be used instead of KCompositeJob::addSubjob(), making it possible to add subjobs from the outside.

Transfers ownership of the job to this object.

Definition at line 67 of file contentjobbase.cpp.

content()

KMime::Content * ContentJobBase::content ( ) const

nodiscard

Get the resulting KMime::Content that the ContentJobBase has generated.

Jobs never delete their content.

Definition at line 59 of file contentjobbase.cpp.

doStart

void ContentJobBase::doStart ( )

protectedvirtualslot

Reimplement to do additional stuff before processing children, such as adding more subjobs.

Remember to call the base implementation.

Definition at line 95 of file contentjobbase.cpp.

extraContent()

KMime::Content * ContentJobBase::extraContent ( ) const

nodiscard

Get extra content that was previously added.

Definition at line 80 of file contentjobbase.cpp.

process

virtual void MessageComposer::ContentJobBase::process ( )

protectedpure virtualslot

This is called after all the children have been processed.

(You must use their resulting contents, or delete them.) Reimplement in subclasses to process concrete content. Call emitResult() when finished.

Implemented in MessageComposer::TransparentJob.

setExtraContent()

void ContentJobBase::setExtraContent

(

KMime::Content *

extra

)

Set some extra content to be saved with the job, and available later, for example, in slot handling result of job.

Job does not take care of deleting extra content.

Definition at line 73 of file contentjobbase.cpp.

slotResult

void ContentJobBase::slotResult ( KJob * job )

overrideprotectedslot

Definition at line 103 of file contentjobbase.cpp.

start()

void ContentJobBase::start ( )

overridevirtual

Starts processing this ContentJobBase asynchronously.

This processes all children in order first, then calls process(). Emits finished() after all processing is done, and the content is reachable through content().

Implements KJob.

Definition at line 54 of file contentjobbase.cpp.

---

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

• contentjobbase.h
• contentjobbase.cpp