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

KDECore

KJobTrackerInterface Class Reference

The interface to implement to track the progresses of a job. More...

#include <kjobtrackerinterface.h>

Inheritance diagram for KJobTrackerInterface:

Inheritance graph
[legend]

List of all members.


Public Slots

virtual void registerJob (KJob *job)
virtual void unregisterJob (KJob *job)

Public Member Functions

 KJobTrackerInterface (QObject *parent=0)
virtual ~KJobTrackerInterface ()

Protected Slots

virtual void description (KJob *job, const QString &title, const QPair< QString, QString > &field1, const QPair< QString, QString > &field2)
virtual void finished (KJob *job)
virtual void infoMessage (KJob *job, const QString &plain, const QString &rich)
virtual void percent (KJob *job, unsigned long percent)
virtual void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
virtual void resumed (KJob *job)
virtual void speed (KJob *job, unsigned long value)
virtual void suspended (KJob *job)
virtual void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
virtual void warning (KJob *job, const QString &plain, const QString &rich)

Detailed Description

The interface to implement to track the progresses of a job.

Definition at line 32 of file kjobtrackerinterface.h.


Constructor & Destructor Documentation

KJobTrackerInterface::KJobTrackerInterface ( QObject *  parent = 0  ) 

Creates a new KJobTrackerInterface.

Parameters:
parent the parent object

Definition at line 35 of file kjobtrackerinterface.cpp.

KJobTrackerInterface::~KJobTrackerInterface (  )  [virtual]

Destroys a KJobTrackerInterface.

Definition at line 41 of file kjobtrackerinterface.cpp.


Member Function Documentation

void KJobTrackerInterface::description ( KJob *  job,
const QString &  title,
const QPair< QString, QString > &  field1,
const QPair< QString, QString > &  field2 
) [protected, virtual, slot]

Called to display general description of a job.

A description has a title and two optional fields which can be used to complete the description.

Examples of titles are "Copying", "Creating resource", etc. The fields of the description can be "Source" with an URL, and, "Destination" with an URL for a "Copying" description.

Parameters:
job the job that emitted this signal
title the general description of the job
field1 first field (localized name and value)
field2 second field (localized name and value)

Definition at line 127 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::finished ( KJob *  job  )  [protected, virtual, slot]

Called when a job is finished, in any case.

It is used to notify that the job is terminated and that progress UI (if any) can be hidden.

Parameters:
job the job that emitted this signal

Definition at line 112 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::infoMessage ( KJob *  job,
const QString &  plain,
const QString &  rich 
) [protected, virtual, slot]

Called to display state information about a job.

Examples of message are "Resolving host", "Connecting to host...", etc.

Parameters:
job the job that emitted this signal
plain the info message
rich the rich text version of the message, or QString() is none is available

Definition at line 138 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::percent ( KJob *  job,
unsigned long  percent 
) [protected, virtual, slot]

Called to show the overall progress of the job.

Note that this is not called for finished jobs.

Parameters:
job the job that emitted this signal
percent the percentage

Definition at line 166 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::processedAmount ( KJob *  job,
KJob::Unit  unit,
qulonglong  amount 
) [protected, virtual, slot]

Regularly called to show the progress of a job by giving the current amount.

The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

Parameters:
job the job that emitted this signal
unit the unit of the processed amount
amount the processed amount

Definition at line 159 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::registerJob ( KJob *  job  )  [virtual, slot]

Register a new job in this tracker.

Parameters:
job the job to register

Definition at line 46 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::resumed ( KJob *  job  )  [protected, virtual, slot]

Called when a job is resumed.

Parameters:
job the job that emitted this signal

Definition at line 122 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::speed ( KJob *  job,
unsigned long  value 
) [protected, virtual, slot]

Called to show the speed of the job.

Parameters:
job the job that emitted this signal
value the current speed of the job

Definition at line 172 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::suspended ( KJob *  job  )  [protected, virtual, slot]

Called when a job is suspended.

Parameters:
job the job that emitted this signal

Definition at line 117 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::totalAmount ( KJob *  job,
KJob::Unit  unit,
qulonglong  amount 
) [protected, virtual, slot]

Called when we know the amount a job will have to process.

The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

Parameters:
job the job that emitted this signal
unit the unit of the total amount
amount the total amount

Definition at line 152 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::unregisterJob ( KJob *  job  )  [virtual, slot]

Unregister a job from this tracker.

Parameters:
job the job to unregister

Definition at line 79 of file kjobtrackerinterface.cpp.

void KJobTrackerInterface::warning ( KJob *  job,
const QString &  plain,
const QString &  rich 
) [protected, virtual, slot]

Emitted to display a warning about a job.

Parameters:
job the job that emitted this signal
plain the warning message
rich the rich text version of the message, or QString() is none is available

Definition at line 145 of file kjobtrackerinterface.cpp.


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

KDECore

Skip menu "KDECore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs 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