class ProgressBase

Base class for IO progress dialogs. More...

Full nameKIO::ProgressBase
Definition#include <progressbase.h>
InheritsQWidget (kdecore)
Inherited byStatusbarProgress
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Slots

Signals

Protected Methods

Protected Slots

Protected Members


Detailed Description

Base class for IO progress dialogs.

This class does all initialization stuff for progress, like connecting signals to slots. All slots are implemented as pure virtual methods.

All custom IO progress dialog should inherit this class. Add your GUI code to the constructor and implemement those virtual methods which you need in order to display progress.

E.g. StatusbarProgress only implements slotTotalSize(), slotPercent() and slotSpeed().

Custom progress dialog will be used like this :


 // create job
 CopyJob* job = KIO::copy(...);
 // create a dialog
 MyCustomProgress *customProgress;
 customProgress = new MyCustomProgress();
 // connect progress with job
 customProgress->setJob( job );
 ...

There is a special method setStopOnClose() that controls the behavior of the dialog.

 ProgressBase ( QWidget *parent )

ProgressBase ()

void  setJob ( KIO::Job *job )

void  setJob ( KIO::CopyJob *job )

void  setJob ( KIO::DeleteJob *job )

void  setStopOnClose ( bool stopOnClose )

void  setOnlyClean ( bool onlyClean )

void  slotStop ()

[slot]

void  slotClean ()

[virtual slot]

void  slotTotalSize ( KIO::Job*, unsigned long )

[virtual slot]

void  slotTotalFiles ( KIO::Job*, unsigned long )

[virtual slot]

void  slotTotalDirs ( KIO::Job*, unsigned long )

[virtual slot]

void  slotProcessedSize ( KIO::Job*, unsigned long )

[virtual slot]

void  slotProcessedFiles ( KIO::Job*, unsigned long )

[virtual slot]

void  slotProcessedDirs ( KIO::Job*, unsigned long )

[virtual slot]

void  slotSpeed ( KIO::Job*, unsigned long )

[virtual slot]

void  slotPercent ( KIO::Job*, unsigned long )

[virtual slot]

void  slotCopying ( KIO::Job*, const KURL&, const KURL& )

[virtual slot]

void  slotMoving ( KIO::Job*, const KURL&, const KURL& )

[virtual slot]

void  slotDeleting ( KIO::Job*, const KURL& )

[virtual slot]

void  slotCreatingDir ( KIO::Job*, const KURL& )

[virtual slot]

void  slotCanResume ( KIO::Job*, bool )

[virtual slot]

void  stopped ()

[signal]

void  slotFinished ( KIO::Job* )

[protected slot]

void  closeEvent ( QCloseEvent * )

[protected virtual]

KIO::Job* m_pJob

[protected]

bool m_bOnlyClean

[protected]

This variable controls whether the dialog should be deleted or only cleaned when the KIO::Job is finished ( or canceled ).

If your dialog is embedded widget and not a separate window, you should set this variable to true in the constructor of your custom dialog.

If true - Dialog will only call method slotClean. If false - Dialog will be deleted.

bool m_bStopOnClose

[protected]