.TH "UIServer" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
UIServer \- It's purpose is to show progress of IO operations. Graphical server for progress information with an optional all-in-one progress window.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <uiserver.h>\fP
.PP
Inherits \fBKMainWindow\fP, and \fBDCOPObject\fP.
.PP
.SS "DCOP Member Functions"

.in +1c
.ti -1c
.RI "int \fBnewJob\fP (\fBQCString\fP appId, bool showProgress)"
.br
.RI "\fISignal a new job. \fP"
.ti -1c
.RI "ASYNC \fBjobFinished\fP (int id)"
.br
.ti -1c
.RI "ASYNC \fBtotalSize\fP (int id, unsigned long size)"
.br
.ti -1c
.RI "ASYNC \fBtotalSize64\fP (int id, KIO::filesize_t size)"
.br
.ti -1c
.RI "ASYNC \fBtotalFiles\fP (int id, unsigned long files)"
.br
.ti -1c
.RI "ASYNC \fBtotalDirs\fP (int id, unsigned long dirs)"
.br
.ti -1c
.RI "ASYNC \fBprocessedSize\fP (int id, unsigned long bytes)"
.br
.ti -1c
.RI "ASYNC \fBprocessedSize64\fP (int id, KIO::filesize_t bytes)"
.br
.ti -1c
.RI "ASYNC \fBprocessedFiles\fP (int id, unsigned long files)"
.br
.ti -1c
.RI "ASYNC \fBprocessedDirs\fP (int id, unsigned long dirs)"
.br
.ti -1c
.RI "ASYNC \fBpercent\fP (int id, unsigned long ipercent)"
.br
.ti -1c
.RI "ASYNC \fBspeed\fP (int id, unsigned long bytes_per_second)"
.br
.ti -1c
.RI "ASYNC \fBinfoMessage\fP (int id, const  \fBQString\fP &msg)"
.br
.ti -1c
.RI "ASYNC \fBcopying\fP (int id, \fBKURL\fP from, \fBKURL\fP to)"
.br
.ti -1c
.RI "ASYNC \fBmoving\fP (int id, \fBKURL\fP from, \fBKURL\fP to)"
.br
.ti -1c
.RI "ASYNC \fBdeleting\fP (int id, \fBKURL\fP url)"
.br
.ti -1c
.RI "ASYNC \fBtransferring\fP (int id, \fBKURL\fP url)"
.br
.ti -1c
.RI "ASYNC \fBcreatingDir\fP (int id, \fBKURL\fP dir)"
.br
.ti -1c
.RI "ASYNC \fBstating\fP (int id, \fBKURL\fP url)"
.br
.ti -1c
.RI "ASYNC \fBmounting\fP (int id, \fBQString\fP dev, \fBQString\fP point)"
.br
.ti -1c
.RI "ASYNC \fBunmounting\fP (int id, \fBQString\fP point)"
.br
.ti -1c
.RI "ASYNC \fBcanResume\fP (int id, unsigned long offset)"
.br
.ti -1c
.RI "ASYNC \fBcanResume64\fP (int id, KIO::filesize_t offset)"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBopenPassDlg\fP (const  \fBKIO::AuthInfo\fP &info)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). \fP"
.ti -1c
.RI "int \fBmessageBox\fP (int id, 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"
.ti -1c
.RI "\fBQByteArray\fP \fBopen_RenameDlg64\fP (int id, const  \fBQString\fP &caption, const  \fBQString\fP &src, const  \fBQString\fP &dest, int mode, KIO::filesize_t sizeSrc, KIO::filesize_t sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). \fP"
.ti -1c
.RI "\fBQByteArray\fP \fBopen_RenameDlg\fP (int id, const  \fBQString\fP &caption, const  \fBQString\fP &src, const  \fBQString\fP &dest, int mode, unsigned long sizeSrc, unsigned long sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). \fP"
.ti -1c
.RI "int \fBopen_SkipDlg\fP (int id, int multi, const  \fBQString\fP &error_text)"
.br
.RI "\fI\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). \fP"
.ti -1c
.RI "void \fBsetListMode\fP (bool list)"
.br
.RI "\fISwitch to or from list mode - called by the kcontrol module. \fP"
.ti -1c
.RI "void \fBsetJobVisible\fP (int id, bool visible)"
.br
.RI "\fIHide or show a job. \fP"
.ti -1c
.RI "void \fBshowSSLInfoDialog\fP (const  \fBQString\fP &url, const  KIO::MetaData &data)"
.br
.RI "\fIShow a SSL Information Dialog. \fP"
.ti -1c
.RI "KSSLCertDlgRet \fBshowSSLCertDialog\fP (const  \fBQString\fP &host, const  \fBQStringList\fP &certList)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotUpdate\fP ()"
.br
.ti -1c
.RI "void \fBcancelCurrent\fP ()"
.br
.ti -1c
.RI "void \fBslotToggleDefaultProgress\fP (\fBQListViewItem\fP *)"
.br
.ti -1c
.RI "void \fBslotSelection\fP ()"
.br
.ti -1c
.RI "void \fBslotJobCanceled\fP (\fBProgressItem\fP *)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBProgressItem\fP * \fBfindItem\fP (int id)"
.br
.ti -1c
.RI "void \fBcloseEvent\fP (\fBQCloseEvent\fP *)"
.br
.ti -1c
.RI "void \fBsetItemVisible\fP (\fBProgressItem\fP *item, bool visible)"
.br
.ti -1c
.RI "void \fBreadSettings\fP ()"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBQTimer\fP * \fBupdateTimer\fP"
.br
.ti -1c
.RI "\fBListProgress\fP * \fBlistProgress\fP"
.br
.ti -1c
.RI "\fBKToolBar::BarPosition\fP \fBtoolbarPos\fP"
.br
.ti -1c
.RI "\fBQString\fP \fBproperties\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
It's purpose is to show progress of IO operations. Graphical server for progress information with an optional all-in-one progress window. 

There is only one instance of this window for all jobs.
.PP
All IO operations ( jobs ) are displayed in this window, one line per operation. User can cancel operations with Cancel button on toolbar.
.PP
Double clicking an item in the list opens a small download window ( \fBDefaultProgress\fP ).
.PP
\fBAuthor:\fP
.RS 4
David Faure <faure@kde.org> 
.PP
Matej Koss <koss@miesto.sk> 
.RE
.PP

.PP
Definition at line 186 of file uiserver.h.
.SH "Member Function Documentation"
.PP 
.SS "int UIServer::newJob (\fBQCString\fP appId, bool showProgress)"
.PP
Signal a new job. \fBParameters:\fP
.RS 4
\fIthe\fP DCOP application id of the job's parent application 
.RE
.PP
\fBSee also:\fP
.RS 4
KIO::Observer::newJob 
.RE
.PP
\fBParameters:\fP
.RS 4
\fIshowProgress\fP whether to popup the progress for the job. Usually true, but may be false when we use kio_uiserver for other things, like SSL dialogs. 
.RE
.PP
\fBReturns:\fP
.RS 4
the job id 
.RE
.PP
Definition at line 441 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::openPassDlg (const \fBKIO::AuthInfo\fP & info)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). Use \fBKIO::PasswordDialog::getNameAndPassword\fP instead. To be removed in \fBKDE\fP 4.0. Definition at line 841 of file uiserver.cpp.
.SS "int UIServer::messageBox (int id, int type, const \fBQString\fP & text, const \fBQString\fP & caption, const \fBQString\fP & buttonYes, const \fBQString\fP & buttonNo)"
.PP
Popup a message box. \fBParameters:\fP
.RS 4
\fItype\fP type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel... This enum is defined in \fBslavebase.h\fP, it currently is: QuestionYesNo = 1, WarningYesNo = 2, WarningContinueCancel = 3, WarningYesNoCancel = 4, Information = 5, SSLMessageBox = 6 
.br
\fItext\fP Message string. May contain newlines. 
.br
\fIcaption\fP Message box title. 
.br
\fIbuttonYes\fP The text for the first button. The default is i18n('&Yes'). 
.br
\fIbuttonNo\fP The text for the second button. The default is i18n('&No'). Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused. and for Information, none is used. 
.RE
.PP
\fBReturns:\fP
.RS 4
a button code, as defined in \fBKMessageBox\fP, or 0 on communication error. 
.RE
.PP
Definition at line 860 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::open_RenameDlg64 (int id, const \fBQString\fP & caption, const \fBQString\fP & src, const \fBQString\fP & dest, int mode, KIO::filesize_t sizeSrc, KIO::filesize_t sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in \fBKDE\fP 4.0. Definition at line 940 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::open_RenameDlg (int id, const \fBQString\fP & caption, const \fBQString\fP & src, const \fBQString\fP & dest, int mode, unsigned long sizeSrc, unsigned long sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in \fBKDE\fP 4.0. Definition at line 925 of file uiserver.cpp.
.SS "int UIServer::open_SkipDlg (int id, int multi, const \fBQString\fP & error_text)"
.PP
\fBThis class or method is obsolete, it is provided for compatibility only.\fP (it blocks other apps). Use KIO::open_SkipDlg instead. To be removed in \fBKDE\fP 4.0. Definition at line 972 of file uiserver.cpp.
.SS "void UIServer::setListMode (bool list)"
.PP
Switch to or from list mode - called by the kcontrol module. Definition at line 800 of file uiserver.cpp.
.SS "void UIServer::setJobVisible (int id, bool visible)"
.PP
Hide or show a job. Typically, we hide a job while a 'skip' or 'rename' dialog is being shown for this job. This prevents killing it from the uiserver. Definition at line 501 of file uiserver.cpp.
.SS "void UIServer::showSSLInfoDialog (const \fBQString\fP & url, const KIO::MetaData & data)"
.PP
Show a SSL Information Dialog. Definition at line 865 of file uiserver.cpp.

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