NotificationManager::Job

Search for usage in LXR

Properties | Signals | Public Member Functions | List of all members
NotificationManager::Job Class Reference

#include <job.h>

Inheritance diagram for NotificationManager::Job:
Inheritance graph
[legend]

Properties

QString applicationIconName
 
QString applicationName
 
QString descriptionLabel1
 
QString descriptionLabel2
 
QUrl descriptionUrl
 
QString descriptionValue1
 
QString descriptionValue2
 
QString desktopEntry
 
QUrl destUrl
 
QUrl effectiveDestUrl
 
int error
 
bool hasDetails
 
bool killable
 
int percentage
 
qulonglong processedBytes
 
qulonglong processedDirectories
 
qulonglong processedFiles
 
qulonglong processedItems
 
qulonglong speed
 
Notifications::JobState state
 
QML_ELEMENTQString summary
 
bool suspendable
 
QString text
 
qulonglong totalBytes
 
qulonglong totalDirectories
 
qulonglong totalFiles
 
qulonglong totalItems
 
- Properties inherited from QObject
 objectName
 

Signals

void descriptionLabel1Changed ()
 
void descriptionLabel2Changed ()
 
void descriptionUrlChanged ()
 
void descriptionValue1Changed ()
 
void descriptionValue2Changed ()
 
void destUrlChanged ()
 
void dismissedChanged ()
 
void effectiveDestUrlChanged ()
 
void errorChanged (int error)
 
void errorTextChanged (const QString &errorText)
 
void expiredChanged ()
 
void hasDetailsChanged ()
 
void percentageChanged (int percentage)
 
void processedAmountChanged ()
 
void processedBytesChanged ()
 
void processedDirectoriesChanged ()
 
void processedFilesChanged ()
 
void processedItemsChanged ()
 
void speedChanged ()
 
void stateChanged (Notifications::JobState jobState)
 
void summaryChanged ()
 
void textChanged ()
 
void totalAmountChanged ()
 
void totalBytesChanged ()
 
void totalDirectoriesChanged ()
 
void totalFilesChanged ()
 
void totalItemsChanged ()
 
void updatedChanged ()
 

Public Member Functions

 Job (uint id, QObject *parent=nullptr)
 
QString applicationIconName () const
 
QString applicationName () const
 
QDateTime created () const
 
QString descriptionLabel1 () const
 
QString descriptionLabel2 () const
 
QUrl descriptionUrl () const
 
QString descriptionValue1 () const
 
QString descriptionValue2 () const
 
QString desktopEntry () const
 
QUrl destUrl () const
 
bool dismissed () const
 
QUrl effectiveDestUrl () const
 
int error () const
 
QString errorText () const
 
bool expired () const
 
bool hasDetails () const
 
uint id () const
 
Q_INVOKABLE void kill ()
 
bool killable () const
 
int percentage () const
 
qulonglong processedBytes () const
 
qulonglong processedDirectories () const
 
qulonglong processedFiles () const
 
qulonglong processedItems () const
 
void resetUpdated ()
 
Q_INVOKABLE void resume ()
 
void setApplicationIconName (const QString &applicationIconName)
 
void setApplicationName (const QString &applicationName)
 
void setDesktopEntry (const QString &desktopEntry)
 
void setDismissed (bool dismissed)
 
void setError (int error)
 
void setErrorText (const QString &errorText)
 
void setExpired (bool expired)
 
void setKillable (bool killable)
 
void setState (Notifications::JobState jobState)
 
void setSuspendable (bool suspendable)
 
void setTransient (bool transient)
 
qulonglong speed () const
 
Notifications::JobState state () const
 
QString summary () const
 
Q_INVOKABLE void suspend ()
 
bool suspendable () const
 
QString text () const
 
qulonglong totalBytes () const
 
qulonglong totalDirectories () const
 
qulonglong totalFiles () const
 
qulonglong totalItems () const
 
bool transient () const
 
QDateTime updated () 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
 

Additional Inherited Members

- Public Types inherited from QObject
typedef  QObjectList
 
- 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)
 
- 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)
 

Detailed Description

Represents a single job.

A Job represents a special notification that has some progress information and in some cases can be suspended or killed.

Author
Kai Uwe Broulik kde@p.nosp@m.riva.nosp@m.t.bro.nosp@m.ulik.nosp@m..de

Definition at line 31 of file job.h.

Property Documentation

◆ applicationIconName

QString NotificationManager::Job::applicationIconName
read

The icon name of the application owning the job, e.g.

"system-file-manager".

Definition at line 59 of file job.h.

◆ applicationName

QString NotificationManager::Job::applicationName
read

The user-visible name of the application owning the job, e.g.

"Dolphin".

Definition at line 55 of file job.h.

◆ descriptionLabel1

QString NotificationManager::Job::descriptionLabel1
read

Definition at line 106 of file job.h.

◆ descriptionLabel2

QString NotificationManager::Job::descriptionLabel2
read

Definition at line 109 of file job.h.

◆ descriptionUrl

QUrl NotificationManager::Job::descriptionUrl
read

This tries to generate a valid URL for a file that's being processed by converting descriptionValue2 (which is assumed to be the Destination) and if that isn't valid, descriptionValue1 to a URL.

Definition at line 127 of file job.h.

◆ descriptionValue1

QString NotificationManager::Job::descriptionValue1
read

Definition at line 107 of file job.h.

◆ descriptionValue2

QString NotificationManager::Job::descriptionValue2
read

Definition at line 110 of file job.h.

◆ desktopEntry

QString NotificationManager::Job::desktopEntry
read

The desktop entry of the application owning the job, e.g.

"org.kde.dolphin".

Definition at line 51 of file job.h.

◆ destUrl

QUrl NotificationManager::Job::destUrl
read

The destination URL of a job.

Definition at line 89 of file job.h.

◆ effectiveDestUrl

QUrl NotificationManager::Job::effectiveDestUrl
read

The final destination url: it's the final copied file if is single, the destination folder url if more than one, it will be empty if the job is still running or if the destination is within trash:/.

Definition at line 133 of file job.h.

◆ error

int NotificationManager::Job::error
read

The error code of the job failure.

Definition at line 71 of file job.h.

◆ hasDetails

bool NotificationManager::Job::hasDetails
read

Whether there are any details available for this job.

This is true as soon as any of the following are available:

  • processed amount (of any unit)
  • total amount (of any unit)
  • description label or value (of any row)
  • speed

Definition at line 121 of file job.h.

◆ killable

bool NotificationManager::Job::killable
read

Whether the job can be aborted.

See also
Notifications::killJob

Definition at line 84 of file job.h.

◆ percentage

int NotificationManager::Job::percentage
read

The total percentage (0-100) of job completion.

Definition at line 67 of file job.h.

◆ processedBytes

qulonglong NotificationManager::Job::processedBytes
read

Definition at line 96 of file job.h.

◆ processedDirectories

qulonglong NotificationManager::Job::processedDirectories
read

Definition at line 98 of file job.h.

◆ processedFiles

qulonglong NotificationManager::Job::processedFiles
read

Definition at line 97 of file job.h.

◆ processedItems

qulonglong NotificationManager::Job::processedItems
read

Definition at line 99 of file job.h.

◆ speed

qulonglong NotificationManager::Job::speed
read

Current transfer rate in Byte/s.

Definition at line 94 of file job.h.

◆ state

Notifications::JobState NotificationManager::Job::state
read

The state the job is currently in.

Definition at line 63 of file job.h.

◆ summary

QML_ELEMENTQString NotificationManager::Job::summary
read

The job infoMessage, e.g.

"Copying".

Definition at line 40 of file job.h.

◆ suspendable

bool NotificationManager::Job::suspendable
read

Whether the job can be suspended.

See also
Notifications::suspendJob
Notifications::resumeJob

Definition at line 78 of file job.h.

◆ text

QString NotificationManager::Job::text
read

User-friendly compact description text of the job, for example "42 of 1337 files to "~/some/folder", or "SomeFile.txt to Downloads".

Definition at line 46 of file job.h.

◆ totalBytes

qulonglong NotificationManager::Job::totalBytes
read

Definition at line 101 of file job.h.

◆ totalDirectories

qulonglong NotificationManager::Job::totalDirectories
read

Definition at line 103 of file job.h.

◆ totalFiles

qulonglong NotificationManager::Job::totalFiles
read

Definition at line 102 of file job.h.

◆ totalItems

qulonglong NotificationManager::Job::totalItems
read

Definition at line 104 of file job.h.

Constructor & Destructor Documentation

◆ Job()

Job::Job ( uint id,
QObject * parent = nullptr )
explicit

Definition at line 14 of file job.cpp.

Member Function Documentation

◆ applicationIconName()

QString Job::applicationIconName ( ) const

Definition at line 90 of file job.cpp.

◆ applicationName()

QString Job::applicationName ( ) const

Definition at line 79 of file job.cpp.

◆ created()

QDateTime Job::created ( ) const

Definition at line 42 of file job.cpp.

◆ descriptionLabel1()

QString Job::descriptionLabel1 ( ) const

Definition at line 250 of file job.cpp.

◆ descriptionLabel2()

QString Job::descriptionLabel2 ( ) const

Definition at line 260 of file job.cpp.

◆ descriptionUrl()

QUrl Job::descriptionUrl ( ) const

Definition at line 275 of file job.cpp.

◆ descriptionValue1()

QString Job::descriptionValue1 ( ) const

Definition at line 255 of file job.cpp.

◆ descriptionValue2()

QString Job::descriptionValue2 ( ) const

Definition at line 265 of file job.cpp.

◆ desktopEntry()

QString Job::desktopEntry ( ) const

Definition at line 68 of file job.cpp.

◆ destUrl()

QUrl Job::destUrl ( ) const

Definition at line 177 of file job.cpp.

◆ dismissed()

bool Job::dismissed ( ) const

Definition at line 293 of file job.cpp.

◆ effectiveDestUrl()

QUrl Job::effectiveDestUrl ( ) const

Definition at line 182 of file job.cpp.

◆ error()

int Job::error ( ) const

Definition at line 119 of file job.cpp.

◆ errorText()

QString Job::errorText ( ) const

Definition at line 132 of file job.cpp.

◆ expired()

bool Job::expired ( ) const

Definition at line 280 of file job.cpp.

◆ hasDetails()

bool Job::hasDetails ( ) const

Definition at line 270 of file job.cpp.

◆ id()

uint Job::id ( ) const

Definition at line 37 of file job.cpp.

◆ kill()

void Job::kill ( )

Definition at line 316 of file job.cpp.

◆ killable()

bool Job::killable ( ) const

Definition at line 156 of file job.cpp.

◆ percentage()

int Job::percentage ( ) const

Definition at line 114 of file job.cpp.

◆ processedBytes()

qulonglong Job::processedBytes ( ) const

Definition at line 210 of file job.cpp.

◆ processedDirectories()

qulonglong Job::processedDirectories ( ) const

Definition at line 220 of file job.cpp.

◆ processedFiles()

qulonglong Job::processedFiles ( ) const

Definition at line 215 of file job.cpp.

◆ processedItems()

qulonglong Job::processedItems ( ) const

Definition at line 225 of file job.cpp.

◆ resetUpdated()

void Job::resetUpdated ( )

Definition at line 52 of file job.cpp.

◆ resume()

void Job::resume ( )

Definition at line 311 of file job.cpp.

◆ setApplicationIconName()

void Job::setApplicationIconName ( const QString & applicationIconName)

Definition at line 95 of file job.cpp.

◆ setApplicationName()

void Job::setApplicationName ( const QString & applicationName)

Definition at line 84 of file job.cpp.

◆ setDesktopEntry()

void Job::setDesktopEntry ( const QString & desktopEntry)

Definition at line 73 of file job.cpp.

◆ setDismissed()

void Job::setDismissed ( bool dismissed)

Definition at line 298 of file job.cpp.

◆ setError()

void Job::setError ( int error)

Definition at line 124 of file job.cpp.

◆ setErrorText()

void Job::setErrorText ( const QString & errorText)

Definition at line 137 of file job.cpp.

◆ setExpired()

void Job::setExpired ( bool expired)

Definition at line 285 of file job.cpp.

◆ setKillable()

void Job::setKillable ( bool killable)

Definition at line 161 of file job.cpp.

◆ setState()

void Job::setState ( Notifications::JobState jobState)

Definition at line 106 of file job.cpp.

◆ setSuspendable()

void Job::setSuspendable ( bool suspendable)

Definition at line 150 of file job.cpp.

◆ setTransient()

void Job::setTransient ( bool transient)

Definition at line 172 of file job.cpp.

◆ speed()

qulonglong Job::speed ( ) const

Definition at line 205 of file job.cpp.

◆ state()

Notifications::JobState Job::state ( ) const

Definition at line 101 of file job.cpp.

◆ summary()

QString Job::summary ( ) const

Definition at line 58 of file job.cpp.

◆ suspend()

void Job::suspend ( )

Definition at line 306 of file job.cpp.

◆ suspendable()

bool Job::suspendable ( ) const

Definition at line 145 of file job.cpp.

◆ text()

QString Job::text ( ) const

Definition at line 63 of file job.cpp.

◆ totalBytes()

qulonglong Job::totalBytes ( ) const

Definition at line 230 of file job.cpp.

◆ totalDirectories()

qulonglong Job::totalDirectories ( ) const

Definition at line 240 of file job.cpp.

◆ totalFiles()

qulonglong Job::totalFiles ( ) const

Definition at line 235 of file job.cpp.

◆ totalItems()

qulonglong Job::totalItems ( ) const

Definition at line 245 of file job.cpp.

◆ transient()

bool Job::transient ( ) const

Definition at line 167 of file job.cpp.

◆ updated()

QDateTime Job::updated ( ) const

Definition at line 47 of file job.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 20 2024 12:00:00 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.