class ProgressBase

Base class for IO progress dialogs. More...

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

Public Methods

Public Slots

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 behaviour of the dialog.

void  setStopOnClose ( bool stop )

Use this to set whether progress dialog should also kill the KIO::Job when closed.

Parameters:
stopif true - KIO::Job will be killed. if false - Dialog will be closed without killing the job ( IO will continue ).

bool m_bOnlyClean

[protected]

This variable controls wether 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 clean. If false - Dialog will be deleted.