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

KDEUI

KAbstractWidgetJobTracker Class Reference

The base class for widget based job trackers. More...

#include <kabstractwidgetjobtracker.h>

Inheritance diagram for KAbstractWidgetJobTracker:

Inheritance graph
[legend]

List of all members.


Public Slots

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

Signals

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

Public Member Functions

bool autoDelete (KJob *job) const
 KAbstractWidgetJobTracker (QWidget *parent=0)
void setAutoDelete (KJob *job, bool autoDelete)
void setStopOnClose (KJob *job, bool stopOnClose)
bool stopOnClose (KJob *job) const
virtual QWidget * widget (KJob *job)=0
virtual ~KAbstractWidgetJobTracker ()

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 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:
parent the 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:
job the 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  )  [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 73 of file kabstractwidgetjobtracker.cpp.

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

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:
job the job to register

Reimplemented in KStatusBarJobTracker, and KWidgetJobTracker.

Definition at line 43 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::resume ( KJob *  job  )  [signal]

Emitted when the user resumed the operation.

Parameters:
job The 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:
job the job's widget that is going to be auto-deleted
autoDelete If 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:
job the job's widget that will be stopped when closing
stopOnClose If 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  )  [protected, virtual, slot]

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

redefine this for custom behavior.

Parameters:
job The job that is being cleaned

Reimplemented in KStatusBarJobTracker, and KWidgetJobTracker.

Definition at line 96 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotResume ( KJob *  job  )  [protected, virtual, slot]

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

Parameters:
job The job that is being resumed

Definition at line 90 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotStop ( KJob *  job  )  [protected, virtual, slot]

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

Parameters:
job The job that is being stopped

Definition at line 78 of file kabstractwidgetjobtracker.cpp.

void KAbstractWidgetJobTracker::slotSuspend ( KJob *  job  )  [protected, virtual, slot]

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

Parameters:
job The job that is being suspended

Definition at line 84 of file kabstractwidgetjobtracker.cpp.

bool KAbstractWidgetJobTracker::stopOnClose ( KJob *  job  )  const

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

Parameters:
job the 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:
job The job that has been stopped

void KAbstractWidgetJobTracker::suspend ( KJob *  job  )  [signal]

Emitted when the user suspended the operation.

Parameters:
job The job that has been suspended

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

Unregister a job from this tracker.

Parameters:
job the job to unregister

Reimplemented in KStatusBarJobTracker, and KWidgetJobTracker.

Definition at line 48 of file kabstractwidgetjobtracker.cpp.

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

The widget associated to this tracker.

Parameters:
job the 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

KDEUI

Skip menu "KDEUI"
  • 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