.TH "KIO::ProgressBase" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KIO::ProgressBase \- This class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <progressbase.h>\fP
.PP
Inherits \fBQWidget\fP.
.PP
Inherited by KIO::DefaultProgress, and \fBKIO::StatusbarProgress\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotStop\fP ()"
.br
.RI "\fIThis method should be called for correct cancelation of IO operation Connect this to the progress widgets buttons etc. \fP"
.ti -1c
.RI "virtual void \fBslotClean\fP ()"
.br
.RI "\fIThis method is called when the widget should be cleaned (after job is finished). \fP"
.ti -1c
.RI "virtual void \fBslotTotalSize\fP (\fBKIO::Job\fP *, KIO::filesize_t)"
.br
.ti -1c
.RI "virtual void \fBslotTotalFiles\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotTotalDirs\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotProcessedSize\fP (\fBKIO::Job\fP *, KIO::filesize_t)"
.br
.ti -1c
.RI "virtual void \fBslotProcessedFiles\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotProcessedDirs\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotSpeed\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotPercent\fP (\fBKIO::Job\fP *, unsigned long)"
.br
.ti -1c
.RI "virtual void \fBslotCopying\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &, const  \fBKURL\fP &)"
.br
.ti -1c
.RI "virtual void \fBslotMoving\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &, const  \fBKURL\fP &)"
.br
.ti -1c
.RI "virtual void \fBslotDeleting\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &)"
.br
.ti -1c
.RI "virtual void \fBslotCreatingDir\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &)"
.br
.ti -1c
.RI "virtual void \fBslotCanResume\fP (\fBKIO::Job\fP *, KIO::filesize_t)"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBstopped\fP ()"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBProgressBase\fP (\fBQWidget\fP *parent)"
.br
.ti -1c
.RI "void \fBsetJob\fP (\fBKIO::Job\fP *job)"
.br
.ti -1c
.RI "void \fBsetJob\fP (KIO::CopyJob *job)"
.br
.ti -1c
.RI "void \fBsetJob\fP (\fBKIO::DeleteJob\fP *job)"
.br
.ti -1c
.RI "void \fBsetStopOnClose\fP (bool stopOnClose)"
.br
.ti -1c
.RI "bool \fBstopOnClose\fP () const "
.br
.ti -1c
.RI "void \fBsetOnlyClean\fP (bool onlyClean)"
.br
.RI "\fIThis controls whether the dialog should be deleted or only cleaned when the \fBKIO::Job\fP is finished (or canceled). \fP"
.ti -1c
.RI "bool \fBonlyClean\fP () const "
.br
.ti -1c
.RI "void \fBfinished\fP ()"
.br
.RI "\fI\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotFinished\fP (\fBKIO::Job\fP *)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBcloseEvent\fP (\fBQCloseEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBKIO::Job\fP * \fBm_pJob\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
This class does all initialization stuff for progress, like connecting signals to slots. Base class for IO progress dialogs. 

All slots are implemented as pure virtual methods.
.PP
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.
.PP
E.g. \fBStatusbarProgress\fP only implements \fBslotTotalSize\fP(), \fBslotPercent\fP() and \fBslotSpeed\fP().
.PP
Custom progress dialog will be used like this : 
.PP
.nf

 // create job
 CopyJob* job = \fBKIO::copy\fP(...);
 // create a dialog
 MyCustomProgress *customProgress;
 customProgress = new MyCustomProgress();
 // connect progress with job
 customProgress->setJob( job );
 ...
 
.PP
.PP
There is a special method \fBsetStopOnClose\fP() that controls the behavior of the dialog. 
.PP
\fBAuthor:\fP
.RS 4
Matej Koss <koss@miesto.sk> 
.RE
.PP

.PP
Definition at line 70 of file progressbase.h.
.SH "Member Function Documentation"
.PP 
.SS "void KIO::ProgressBase::setOnlyClean (bool onlyClean)\fC [inline]\fP"
.PP
This controls whether the dialog should be deleted or only cleaned when the \fBKIO::Job\fP 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.
.PP
If true - Dialog will only call method \fBslotClean\fP. If false - Dialog will be deleted. Definition at line 99 of file progressbase.h.
.SS "void KIO::ProgressBase::finished ()"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 144 of file progressbase.cpp.
.PP
References slotClean().
.SS "void KIO::ProgressBase::slotStop ()\fC [slot]\fP"
.PP
This method should be called for correct cancelation of IO operation Connect this to the progress widgets buttons etc. Definition at line 158 of file progressbase.cpp.
.PP
References KIO::Job::kill().
.SS "void KIO::ProgressBase::slotClean ()\fC [virtual, slot]\fP"
.PP
This method is called when the widget should be cleaned (after job is finished). redefine this for custom behavior. Reimplemented in \fBKIO::StatusbarProgress\fP.
.PP
Definition at line 170 of file progressbase.cpp.
.PP
References QWidget::hide().
.PP
Referenced by finished().

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
