class ProgressBase

# class ProgressBase | Base class for IO progress dialogs. More...
Full name | `KIO::ProgressBase`
Definition | `#include <progressbase.h>`
Inherits | QWidget (qt) [public ]
Inherited by | DefaultProgress, StatusbarProgress
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

- ProgressBase ( QWidget *parent )
- ~ProgressBase ()
- void setJob ( KIO::Job *job )
- void setJob ( KIO::CopyJob *job )
- void setJob ( KIO::DeleteJob *job )
- void setStopOnClose ( bool stopOnClose )
- bool stopOnClose () const
- void setOnlyClean ( bool onlyClean )
- bool onlyClean () const
- void finished ()

#### Public Slots

- void slotStop ()
- virtual void slotClean ()
- virtual void slotTotalSize ( KIO::Job*, KIO::filesize_t )
- virtual void slotTotalFiles ( KIO::Job*, unsigned long )
- virtual void slotTotalDirs ( KIO::Job*, unsigned long )
- virtual void slotProcessedSize ( KIO::Job*, KIO::filesize_t )
- virtual void slotProcessedFiles ( KIO::Job*, unsigned long )
- virtual void slotProcessedDirs ( KIO::Job*, unsigned long )
- virtual void slotSpeed ( KIO::Job*, unsigned long )
- virtual void slotPercent ( KIO::Job*, unsigned long )
- virtual void slotCopying ( KIO::Job*, const KURL&, const KURL& )
- virtual void slotMoving ( KIO::Job*, const KURL&, const KURL& )
- virtual void slotDeleting ( KIO::Job*, const KURL& )
- virtual void slotCreatingDir ( KIO::Job*, const KURL& )
- virtual void slotCanResume ( KIO::Job*, KIO::filesize_t )

#### Signals

- void stopped ()

#### Protected Methods

- virtual void closeEvent ( QCloseEvent * )
- virtual void virtual_hook ( int id, void* data )

#### Protected Slots

- void slotFinished ( KIO::Job* )

#### Protected Members

- KIO::Job* m_pJob

## Detailed Description

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

~ProgressBase () | ### ~ProgressBase

void setJob ( KIO::Job *job ) | ### setJob

void setJob ( KIO::CopyJob *job ) | ### setJob

void setJob ( KIO::DeleteJob *job ) | ### setJob

void setStopOnClose ( bool stopOnClose ) | ### setStopOnClose

bool stopOnClose () | ### stopOnClose

[const]

void setOnlyClean ( bool onlyClean ) | ### setOnlyClean

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

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

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

bool onlyClean () | ### onlyClean

[const]

void finished () | ### finished

void slotStop () | ### slotStop

[slot]

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

void slotClean () | ### slotClean

[virtual slot]

This method is called when the widget should be cleaned (after job is finished). redefine this for custom behavior.

void slotTotalSize ( KIO::Job*, KIO::filesize_t ) | ### slotTotalSize

[virtual slot]

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

[virtual slot]

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

[virtual slot]

void slotProcessedSize ( KIO::Job*, KIO::filesize_t ) | ### slotProcessedSize

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

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

[virtual slot]

void slotCanResume ( KIO::Job*, KIO::filesize_t ) | ### slotCanResume

[virtual slot]

void stopped () | ### stopped

[signal]

void slotFinished ( KIO::Job* ) | ### slotFinished

[protected slots slot]

void closeEvent ( QCloseEvent * ) | ### closeEvent

[protected virtual]

Reimplemented from QWidget.

KIO::Job* m_pJob | ### m_pJob

[protected]

void virtual_hook ( int id, void* data ) | ### virtual_hook

[protected virtual]

- Author: Matej Koss
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:57 2003, using kdoc 2.0a54.