• Skip to content
  • Skip to link menu
KDE 4.2 API Reference
  • KDE API Reference
  • API Reference
  • Sitemap
  • Contact Us
 

Applets

SystemTray::Job

SystemTray::Job Class Reference

#include <job.h>

Inheritance diagram for SystemTray::Job:

Inheritance graph
[legend]

List of all members.


Public Types

enum  State { Running = 0, Suspended = 1, Stopped = 2 }

Public Slots

virtual void resume ()
virtual void stop ()
virtual void suspend ()

Signals

void changed (SystemTray::Job *job)
void destroyed (SystemTray::Job *job)
void ready (SystemTray::Job *job)

Public Member Functions

QString applicationIconName () const
QString applicationName () const
void destroy ()
QString error () const
bool isKillable () const
bool isSuspendable () const
 Job (QObject *parent=0)
QList< QPair< QString, QString > > labels () const
QString message () const
uint percentage () const
QMap< QString, qlonglong > processedAmounts () const
QString speed () const
State state () const
QMap< QString, qlonglong > totalAmounts () const
virtual ~Job ()

Protected Member Functions

void setApplicationIconName (const QString &applicationIcon)
void setApplicationName (const QString &applicationName)
void setError (const QString &error)
void setKillable (bool killable)
void setLabels (QList< QPair< QString, QString > > labels)
void setMessage (const QString &message)
void setPercentage (uint percentage)
void setProcessedAmounts (QMap< QString, qlonglong > amount)
void setSpeed (const QString &speed)
void setState (State state)
void setSuspendable (bool suspendable)
void setTotalAmounts (QMap< QString, qlonglong > amount)
void timerEvent (QTimerEvent *)

Detailed Description

Definition at line 29 of file job.h.


Member Enumeration Documentation

enum SystemTray::Job::State

Enumerator:
Running 
Suspended 
Stopped 

Definition at line 34 of file job.h.


Constructor & Destructor Documentation

SystemTray::Job::Job ( QObject *  parent = 0  ) 

Definition at line 62 of file job.cpp.

SystemTray::Job::~Job (  )  [virtual]

Definition at line 70 of file job.cpp.


Member Function Documentation

QString SystemTray::Job::applicationIconName (  )  const

Returns:
the name of the icon to be used for this job.

Definition at line 94 of file job.cpp.

QString SystemTray::Job::applicationName (  )  const

Returns:
the name of the application which started this job.

Definition at line 81 of file job.cpp.

void SystemTray::Job::changed ( SystemTray::Job *  job  )  [signal]

Emitted when the job changes.

void SystemTray::Job::destroy (  ) 

Request and signal destruction of this object.

Definition at line 75 of file job.cpp.

void SystemTray::Job::destroyed ( SystemTray::Job *  job  )  [signal]

Emitted when the job is about to be destroyed.

QString SystemTray::Job::error (  )  const

Returns:
the errormessage if an error has occured.

Definition at line 120 of file job.cpp.

bool SystemTray::Job::isKillable (  )  const

Definition at line 220 of file job.cpp.

bool SystemTray::Job::isSuspendable (  )  const

Definition at line 207 of file job.cpp.

QList< QPair< QString, QString > > SystemTray::Job::labels (  )  const

Returns:
a list of pairs containing label names/values in the order they should be displayed.

Definition at line 183 of file job.cpp.

QString SystemTray::Job::message (  )  const

Returns:
the descripion of the activity that is performed.

Definition at line 107 of file job.cpp.

uint SystemTray::Job::percentage (  )  const

the percentage of the job that has been completed.

Definition at line 194 of file job.cpp.

QMap< QString, qlonglong > SystemTray::Job::processedAmounts (  )  const

Definition at line 159 of file job.cpp.

void SystemTray::Job::ready ( SystemTray::Job *  job  )  [signal]

Emitted when the job is ready to be shown.

void SystemTray::Job::resume (  )  [virtual, slot]

resume this job.

Reimplemented in SystemTray::DBusJob.

Definition at line 238 of file job.cpp.

void SystemTray::Job::setApplicationIconName ( const QString &  applicationIcon  )  [protected]

Definition at line 99 of file job.cpp.

void SystemTray::Job::setApplicationName ( const QString &  applicationName  )  [protected]

Definition at line 86 of file job.cpp.

void SystemTray::Job::setError ( const QString &  error  )  [protected]

Definition at line 125 of file job.cpp.

void SystemTray::Job::setKillable ( bool  killable  )  [protected]

Definition at line 225 of file job.cpp.

void SystemTray::Job::setLabels ( QList< QPair< QString, QString > >  labels  )  [protected]

Definition at line 188 of file job.cpp.

void SystemTray::Job::setMessage ( const QString &  message  )  [protected]

Definition at line 112 of file job.cpp.

void SystemTray::Job::setPercentage ( uint  percentage  )  [protected]

Definition at line 199 of file job.cpp.

void SystemTray::Job::setProcessedAmounts ( QMap< QString, qlonglong >  amount  )  [protected]

Definition at line 164 of file job.cpp.

void SystemTray::Job::setSpeed ( const QString &  speed  )  [protected]

Definition at line 138 of file job.cpp.

void SystemTray::Job::setState ( State  state  )  [protected]

Definition at line 175 of file job.cpp.

void SystemTray::Job::setSuspendable ( bool  suspendable  )  [protected]

Definition at line 212 of file job.cpp.

void SystemTray::Job::setTotalAmounts ( QMap< QString, qlonglong >  amount  )  [protected]

Definition at line 151 of file job.cpp.

QString SystemTray::Job::speed (  )  const

Returns:
the speed at which the jobs is progressing.

Definition at line 133 of file job.cpp.

Job::State SystemTray::Job::state (  )  const

Returns:
the state this job is in.

Definition at line 170 of file job.cpp.

void SystemTray::Job::stop (  )  [virtual, slot]

stop this job.

Reimplemented in SystemTray::DBusJob.

Definition at line 243 of file job.cpp.

void SystemTray::Job::suspend (  )  [virtual, slot]

suspend this job.

Reimplemented in SystemTray::DBusJob.

Definition at line 233 of file job.cpp.

void SystemTray::Job::timerEvent ( QTimerEvent *   )  [protected]

Reimplemented from QObject.

Definition at line 263 of file job.cpp.

QMap< QString, qlonglong > SystemTray::Job::totalAmounts (  )  const

Definition at line 146 of file job.cpp.


The documentation for this class was generated from the following files:
  • job.h
  • job.cpp

Applets

Skip menu "Applets"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

API Reference

Skip menu "API Reference"
  • KWin
  •   KWin Libraries
  • Libraries
  •   libkworkspace
  •   libsolidcontrol
  •   libtaskmanager
  • Plasma
  •   Animators
  •   Applets
  •   Engines
  • Solid Modules
Generated for API Reference by doxygen 1.5.7
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal