.TH "Observer" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Observer \- Observer for \fBKIO::Job\fP progress information This class, of which there is always only one instance, 'observes' what jobs do and forwards this information to the progress-info server. Observer for \fBKIO::Job\fP progress information.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <observer.h>\fP
.PP
Inherits \fBQObject\fP, and \fBDCOPObject\fP.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotTotalSize\fP (\fBKIO::Job\fP *, KIO::filesize_t size)"
.br
.ti -1c
.RI "void \fBslotTotalFiles\fP (\fBKIO::Job\fP *, unsigned long files)"
.br
.ti -1c
.RI "void \fBslotTotalDirs\fP (\fBKIO::Job\fP *, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBslotProcessedSize\fP (\fBKIO::Job\fP *, KIO::filesize_t size)"
.br
.ti -1c
.RI "void \fBslotProcessedFiles\fP (\fBKIO::Job\fP *, unsigned long files)"
.br
.ti -1c
.RI "void \fBslotProcessedDirs\fP (\fBKIO::Job\fP *, unsigned long dirs)"
.br
.ti -1c
.RI "void \fBslotSpeed\fP (\fBKIO::Job\fP *, unsigned long bytes_per_second)"
.br
.ti -1c
.RI "void \fBslotPercent\fP (\fBKIO::Job\fP *, unsigned long percent)"
.br
.ti -1c
.RI "void \fBslotInfoMessage\fP (\fBKIO::Job\fP *, const  \fBQString\fP &msg)"
.br
.ti -1c
.RI "void \fBslotCopying\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &from, const  \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBslotMoving\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &from, const  \fBKURL\fP &to)"
.br
.ti -1c
.RI "void \fBslotDeleting\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBslotTransferring\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &url)"
.br
.RI "\fI\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fP"
.ti -1c
.RI "void \fBslotCreatingDir\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &dir)"
.br
.ti -1c
.RI "void \fBslotCanResume\fP (\fBKIO::Job\fP *, KIO::filesize_t offset)"
.br
.in -1c
.SS "DCOP Member Functions"

.in +1c
.ti -1c
.RI "void \fBkillJob\fP (int progressId)"
.br
.RI "\fICalled by the UI Server (using DCOP) if the user presses cancel. \fP"
.ti -1c
.RI "KIO::MetaData \fBmetadata\fP (int progressId)"
.br
.RI "\fICalled by the UI Server (using DCOP) to get all the metadata of the job. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "int \fBnewJob\fP (\fBKIO::Job\fP *job, bool showProgress)"
.br
.RI "\fICalled by the job constructor, to signal its presence to the UI Server. \fP"
.ti -1c
.RI "void \fBjobFinished\fP (int progressId)"
.br
.RI "\fICalled by the job destructor, to tell the UI Server that the job ended. \fP"
.ti -1c
.RI "bool \fBopenPassDlg\fP (const  \fBQString\fP &prompt, \fBQString\fP &user, \fBQString\fP &pass, bool readOnly)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP. \fP"
.ti -1c
.RI "bool \fBopenPassDlg\fP (\fBKIO::AuthInfo\fP &info)"
.br
.ti -1c
.RI "KIO::RenameDlg_Result \fBopen_RenameDlg\fP (\fBKIO::Job\fP *job, const  \fBQString\fP &caption, const  \fBQString\fP &src, const  \fBQString\fP &dest, KIO::RenameDlg_Mode mode, \fBQString\fP &newDest, KIO::filesize_t sizeSrc=(KIO::filesize_t)-1, KIO::filesize_t sizeDest=(KIO::filesize_t)-1, time_t ctimeSrc=(time_t)-1, time_t ctimeDest=(time_t)-1, time_t mtimeSrc=(time_t)-1, time_t mtimeDest=(time_t)-1)"
.br
.RI "\fISee \fBrenamedlg.h\fP. \fP"
.ti -1c
.RI "KIO::SkipDlg_Result \fBopen_SkipDlg\fP (\fBKIO::Job\fP *job, bool multi, const  \fBQString\fP &error_text)"
.br
.RI "\fISee \fBskipdlg.h\fP. \fP"
.ti -1c
.RI "void \fBstating\fP (\fBKIO::Job\fP *, const  \fBKURL\fP &url)"
.br
.ti -1c
.RI "void \fBmounting\fP (\fBKIO::Job\fP *, const  \fBQString\fP &dev, const  \fBQString\fP &point)"
.br
.ti -1c
.RI "void \fBunmounting\fP (\fBKIO::Job\fP *, const  \fBQString\fP &point)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBObserver\fP * \fBself\fP ()"
.br
.ti -1c
.RI "int \fBmessageBox\fP (int progressId, int type, const  \fBQString\fP &text, const  \fBQString\fP &caption, const  \fBQString\fP &buttonYes, const  \fBQString\fP &buttonNo)"
.br
.RI "\fIPopup a message box. \fP"
.in -1c
.SS "Protected Member Functions"

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

.in +1c
.ti -1c
.RI "UIServer_stub * \fBm_uiserver\fP"
.br
.ti -1c
.RI "\fBQIntDict\fP< \fBKIO::Job\fP > \fBm_dctJobs\fP"
.br
.in -1c
.SS "Static Protected Attributes"

.in +1c
.ti -1c
.RI "\fBObserver\fP * \fBs_pObserver\fP = 0L"
.br
.in -1c
.SH "Detailed Description"
.PP 
Observer for \fBKIO::Job\fP progress information This class, of which there is always only one instance, 'observes' what jobs do and forwards this information to the progress-info server. Observer for \fBKIO::Job\fP progress information. 

It is a DCOP object so that the UI server can call the kill method when the user presses Cancel.
.PP
\fBAuthor:\fP
.RS 4
David Faure <faure@kde.org> 
.RE
.PP

.PP
Definition at line 52 of file observer.h.
.SH "Member Function Documentation"
.PP 
.SS "\fBObserver\fP* Observer::self ()\fC [inline, static]\fP"
.PP
\fBReturns:\fP
.RS 4
the unique observer object 
.RE
.PP
Definition at line 62 of file observer.h.
.PP
Referenced by KIO::mimetype(), KIO::mount(), KIO::SlaveInterface::openPassDlg(), KIO::stat(), and KIO::unmount().
.SS "int Observer::newJob (\fBKIO::Job\fP * job, bool showProgress)"
.PP
Called by the job constructor, to signal its presence to the UI Server. \fBReturns:\fP
.RS 4
the progress ID assigned by the UI Server to the Job. 
.RE
.PP
Definition at line 81 of file observer.cpp.
.SS "void Observer::jobFinished (int progressId)"
.PP
Called by the job destructor, to tell the UI Server that the job ended. Definition at line 93 of file observer.cpp.
.SS "bool Observer::openPassDlg (const \fBQString\fP & prompt, \fBQString\fP & user, \fBQString\fP & pass, bool readOnly)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP. Definition at line 227 of file observer.cpp.
.PP
References KIO::AuthInfo::password, KIO::AuthInfo::prompt, KIO::AuthInfo::readOnly, and KIO::AuthInfo::username.
.PP
Referenced by KIO::SlaveInterface::openPassDlg().
.SS "int Observer::messageBox (int progressId, int type, const \fBQString\fP & text, const \fBQString\fP & caption, const \fBQString\fP & buttonYes, const \fBQString\fP & buttonNo)\fC [static]\fP"
.PP
Popup a message box. See \fBKIO::SlaveBase\fP. This doesn't use DCOP anymore, it shows the dialog in the application's process. Otherwise, other apps would block when trying to communicate with \fBUIServer\fP. Definition at line 260 of file observer.cpp.
.PP
References QPtrList::append(), QPtrList::count(), KMessageBox::information(), KMessageBox::questionYesNo(), QPtrList::setAutoDelete(), QStringList::split(), QString::utf8(), KMessageBox::warningContinueCancel(), KMessageBox::warningYesNo(), and KMessageBox::warningYesNoCancel().
.SS "RenameDlg_Result Observer::open_RenameDlg (\fBKIO::Job\fP * job, const \fBQString\fP & caption, const \fBQString\fP & src, const \fBQString\fP & dest, KIO::RenameDlg_Mode mode, \fBQString\fP & newDest, KIO::filesize_t sizeSrc = (KIO::filesize_t)-1, KIO::filesize_t sizeDest = (KIO::filesize_t)-1, time_t ctimeSrc = (time_t)-1, time_t ctimeDest = (time_t)-1, time_t mtimeSrc = (time_t)-1, time_t mtimeDest = (time_t)-1)"
.PP
See \fBrenamedlg.h\fP. Definition at line 365 of file observer.cpp.
.PP
References KIO::Job::progressId().
.SS "SkipDlg_Result Observer::open_SkipDlg (\fBKIO::Job\fP * job, bool multi, const \fBQString\fP & error_text)"
.PP
See \fBskipdlg.h\fP. Definition at line 393 of file observer.cpp.
.PP
References KIO::Job::progressId().
.SS "void Observer::killJob (int progressId)"
.PP
Called by the UI Server (using DCOP) if the user presses cancel. Definition at line 99 of file observer.cpp.
.SS "MetaData Observer::metadata (int progressId)"
.PP
Called by the UI Server (using DCOP) to get all the metadata of the job. Definition at line 110 of file observer.cpp.
.SS "void Observer::slotTransferring (\fBKIO::Job\fP *, const \fBKURL\fP & url)\fC [slot]\fP"
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
Definition at line 194 of file observer.cpp.
.PP
References KIO::Job::progressId().

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