• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.5 API Reference
  • KDE Home
  • Contact Us
 

KDEUI

Public Slots | Signals | Public Member Functions | Protected Slots | Protected Attributes
KAbstractWidgetJobTracker Class Reference

#include <kabstractwidgetjobtracker.h>

Inheritance diagram for KAbstractWidgetJobTracker:
KJobTrackerInterface QObject KStatusBarJobTracker KWidgetJobTracker

List of all members.

Public Slots

virtual void registerJob (KJob *job)
virtual void unregisterJob (KJob *job)
- Public Slots inherited from KJobTrackerInterface

Signals

void resume (KJob *job)
void stopped (KJob *job)
void suspend (KJob *job)

Public Member Functions

 KAbstractWidgetJobTracker (QWidget *parent=0)
virtual ~KAbstractWidgetJobTracker ()
bool autoDelete (KJob *job) const
void setAutoDelete (KJob *job, bool autoDelete)
void setStopOnClose (KJob *job, bool stopOnClose)
bool stopOnClose (KJob *job) const
virtual QWidget * widget (KJob *job)=0
- Public Member Functions inherited from KJobTrackerInterface
 KJobTrackerInterface (QObject *parent=0)
virtual ~KJobTrackerInterface ()

Protected Slots

virtual void finished (KJob *job)
virtual void slotClean (KJob *job)
virtual void slotResume (KJob *job)
virtual void slotStop (KJob *job)
virtual void slotSuspend (KJob *job)
- Protected Slots inherited from KJobTrackerInterface
virtual void description (KJob *job, const QString &title, const QPair< QString, QString > &field1, const QPair< QString, QString > &field2)
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)

Protected Attributes

Private *const d

Detailed Description

The base class for widget based job trackers.

Definition at line 34 of file kabstractwidgetjobtracker.h.


Constructor & Destructor Documentation

KAbstractWidgetJobTracker::KAbstractWidgetJobTracker ( QWidget *  parent = 0)

Creates a new KAbstractWidgetJobTracker.

Parameters:
parentthe parent of this object and of the widget displaying the job progresses

Definition at line 32 of file kabstractwidgetjobtracker.cpp.

KAbstractWidgetJobTracker::~KAbstractWidgetJobTracker ( )
virtual

Destroys a KAbstractWidgetJobTracker.

Definition at line 38 of file kabstractwidgetjobtracker.cpp.


Member Function Documentation

bool KAbstractWidgetJobTracker::autoDelete ( KJob *  job) const

Checks whether the dialog should be deleted or cleaned.

Parameters:
jobthe job's widget that will be auto-deleted
Returns:
false if the dialog only calls slotClean, true if it will be deleted
See also:
setAutoDelete()

Definition at line 68 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::finished ( KJob *  job)
protectedvirtualslot

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:
jobthe job that emitted this signal

Reimplemented from KJobTrackerInterface.

Definition at line 73 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::registerJob ( KJob *  job)
virtualslot

Register a new job in this tracker.

Note that job trackers inheriting from this class can have only one job registered at a time.

Parameters:
jobthe job to register

Reimplemented from KJobTrackerInterface.

Reimplemented in KWidgetJobTracker, and KStatusBarJobTracker.

Definition at line 43 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::resume ( KJob *  job)
signal

Emitted when the user resumed the operation.

Parameters:
jobThe job that has been resumed
void KAbstractWidgetJobTracker::setAutoDelete ( KJob *  job,
bool  autoDelete 
)

This controls whether the dialog should be deleted or only cleaned when the KJob is finished (or canceled).

If your dialog is an embedded widget and not a separate window, you should setAutoDelete(false) in the constructor of your custom dialog.

Parameters:
jobthe job's widget that is going to be auto-deleted
autoDeleteIf false the dialog will only call method slotClean. If true the dialog will be deleted.
See also:
autoDelete()

Definition at line 63 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::setStopOnClose ( KJob *  job,
bool  stopOnClose 
)

This controls whether the job should be canceled if the dialog is closed.

Parameters:
jobthe job's widget that will be stopped when closing
stopOnCloseIf true the job will be stopped if the dialog is closed, otherwise the job will continue even on close.
See also:
stopOnClose()

Definition at line 53 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotClean ( KJob *  job)
protectedvirtualslot

This method is called when the widget should be cleaned (after job is finished).

redefine this for custom behavior.

Parameters:
jobThe job that is being cleaned

Reimplemented in KStatusBarJobTracker, and KWidgetJobTracker.

Definition at line 102 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotResume ( KJob *  job)
protectedvirtualslot

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

Parameters:
jobThe job that is being resumed

Definition at line 94 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotStop ( KJob *  job)
protectedvirtualslot

This method should be called for correct cancellation of IO operation Connect this to the progress widgets buttons etc.

Parameters:
jobThe job that is being stopped

Definition at line 78 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotSuspend ( KJob *  job)
protectedvirtualslot

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

Parameters:
jobThe job that is being suspended

Definition at line 86 of file kabstractwidgetjobtracker.cpp.

bool KAbstractWidgetJobTracker::stopOnClose ( KJob *  job) const

Checks whether the job will be killed when the dialog is closed.

Parameters:
jobthe job's widget that will be stopped when closing
Returns:
true if the job is killed on close event, false otherwise.
See also:
setStopOnClose()

Definition at line 58 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::stopped ( KJob *  job)
signal

Emitted when the user aborted the operation.

Parameters:
jobThe job that has been stopped
void KAbstractWidgetJobTracker::suspend ( KJob *  job)
signal

Emitted when the user suspended the operation.

Parameters:
jobThe job that has been suspended
void KAbstractWidgetJobTracker::unregisterJob ( KJob *  job)
virtualslot

Unregister a job from this tracker.

Parameters:
jobthe job to unregister

Reimplemented from KJobTrackerInterface.

Reimplemented in KWidgetJobTracker, and KStatusBarJobTracker.

Definition at line 48 of file kabstractwidgetjobtracker.cpp.

virtual QWidget* KAbstractWidgetJobTracker::widget ( KJob *  job)
pure virtual

The widget associated to this tracker.

Parameters:
jobthe job that is assigned the widget we want to return
Returns:
the widget displaying the job progresses

Implemented in KStatusBarJobTracker, and KWidgetJobTracker.


Member Data Documentation

Private* const KAbstractWidgetJobTracker::d
protected

Definition at line 185 of file kabstractwidgetjobtracker.h.


The documentation for this class was generated from the following files:
  • kabstractwidgetjobtracker.h
  • kabstractwidgetjobtracker.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Jul 16 2013 17:49:44 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDEUI

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

kdelibs-4.10.5 API Reference

Skip menu "kdelibs-4.10.5 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal