.TH "UIServer" kde3 "11 Jun 2005" "Version Version 3.4.1" "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 "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotConfigure\fP ()"
.br
.ti -1c
.RI "void \fBslotRemoveSystemTrayIcon\fP ()"
.br
.in -1c
.SS "DCOP Member Functions"

.in +1c
.ti -1c
.RI "int \fBnewJob\fP (\fBQCString\fP appId, bool showProgress)"
.br
.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, \fBKIO::filesize_t\fP 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, \fBKIO::filesize_t\fP 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, \fBKIO::filesize_t\fP offset)"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBopenPassDlg\fP (const \fBKIO::AuthInfo\fP &info)"
.br
.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
.ti -1c
.RI "\fBQByteArray\fP \fBopen_RenameDlg64\fP (int id, const \fBQString\fP &caption, const \fBQString\fP &src, const \fBQString\fP &dest, intmode, \fBKIO::filesize_t\fP sizeSrc, \fBKIO::filesize_t\fP sizeDest, unsigned longctimeSrc, unsigned longctimeDest, unsigned longmtimeSrc, unsigned longmtimeDest)"
.br
.ti -1c
.RI "\fBQByteArray\fP \fBopen_RenameDlg\fP (int id, const \fBQString\fP &caption, const \fBQString\fP &src, const \fBQString\fP &dest, intmode, unsigned long sizeSrc, unsigned long sizeDest, unsigned longctimeSrc, unsigned longctimeDest, unsigned longmtimeSrc, unsigned longmtimeDest)"
.br
.ti -1c
.RI "int \fBopen_SkipDlg\fP (int id, intmulti, const \fBQString\fP &error_text)"
.br
.ti -1c
.RI "void \fBsetListMode\fP (bool list)"
.br
.ti -1c
.RI "void \fBsetJobVisible\fP (int id, bool visible)"
.br
.ti -1c
.RI "void \fBshowSSLInfoDialog\fP (const \fBQString\fP &url, const \fBKIO::MetaData\fP &data, int mainwindow)"
.br
.ti -1c
.RI "void \fBshowSSLInfoDialog\fP (const \fBQString\fP &url, const \fBKIO::MetaData\fP &data)"
.br
.ti -1c
.RI "KSSLCertDlgRet \fBshowSSLCertDialog\fP (const \fBQString\fP &host, const \fBQStringList\fP &certList, int mainwindow)"
.br
.ti -1c
.RI "KSSLCertDlgRet \fBshowSSLCertDialog\fP (const \fBQString\fP &host, const \fBQStringList\fP &certList)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBUIServer\fP * \fBcreateInstance\fP ()"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotUpdate\fP ()"
.br
.ti -1c
.RI "void \fBslotQuit\fP ()"
.br
.ti -1c
.RI "void \fBslotCancelCurrent\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
.ti -1c
.RI "void \fBslotApplyConfig\fP ()"
.br
.ti -1c
.RI "void \fBslotShowContextMenu\fP (\fBKListView\fP *, \fBQListViewItem\fP *item, const \fBQPoint\fP &pos)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "\fBProgressItem\fP * \fBfindItem\fP (int id)"
.br
.ti -1c
.RI "virtual void \fBresizeEvent\fP (\fBQResizeEvent\fP *e)"
.br
.ti -1c
.RI "virtual bool \fBqueryClose\fP ()"
.br
.ti -1c
.RI "void \fBsetItemVisible\fP (\fBProgressItem\fP *item, bool visible)"
.br
.ti -1c
.RI "void \fBapplySettings\fP ()"
.br
.ti -1c
.RI "void \fBreadSettings\fP ()"
.br
.ti -1c
.RI "void \fBwriteSettings\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
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBno_bogus_warning_from_gcc\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 ( DefaultProgress ).
.PP
\fBAuthor:\fP
.RS 4
David Faure <faure@kde.org> 
.PP
Matej Koss <koss@miesto.sk> 
.RE
.PP

.PP
Definition at line 217 of file uiserver.h.
.SH "Member Function Documentation"
.PP 
.SS "int UIServer::newJob (\fBQCString\fP appId, bool showProgress)"
.PP
Signal a new job. 
.PP
\fBParameters:\fP
.RS 4
\fIappId\fP the 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

.PP
Definition at line 746 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::openPassDlg (const \fBKIO::AuthInfo\fP & info)"
.PP
\fBDeprecated\fP
.RS 4
(it blocks other apps). Use \fBKIO::PasswordDialog::getNameAndPassword\fP instead. To be removed in \fBKDE\fP 4.0. 
.RE
.PP

.PP
Definition at line 1148 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. 
.PP
\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

.PP
Definition at line 1167 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::open_RenameDlg64 (int id, const \fBQString\fP & caption, const \fBQString\fP & src, const \fBQString\fP & dest, intmode, \fBKIO::filesize_t\fP sizeSrc, \fBKIO::filesize_t\fP sizeDest, unsigned longctimeSrc, unsigned longctimeDest, unsigned longmtimeSrc, unsigned longmtimeDest)"
.PP
\fBDeprecated\fP
.RS 4
(it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in \fBKDE\fP 4.0. 
.RE
.PP

.PP
Definition at line 1267 of file uiserver.cpp.
.SS "\fBQByteArray\fP UIServer::open_RenameDlg (int id, const \fBQString\fP & caption, const \fBQString\fP & src, const \fBQString\fP & dest, intmode, unsigned long sizeSrc, unsigned long sizeDest, unsigned longctimeSrc, unsigned longctimeDest, unsigned longmtimeSrc, unsigned longmtimeDest)"
.PP
\fBDeprecated\fP
.RS 4
(it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in \fBKDE\fP 4.0. 
.RE
.PP

.PP
Definition at line 1252 of file uiserver.cpp.
.SS "int UIServer::open_SkipDlg (int id, intmulti, const \fBQString\fP & error_text)"
.PP
\fBDeprecated\fP
.RS 4
(it blocks other apps). Use KIO::open_SkipDlg instead. To be removed in \fBKDE\fP 4.0. 
.RE
.PP

.PP
Definition at line 1299 of file uiserver.cpp.
.SS "void UIServer::setListMode (bool list)"
.PP
Switch to or from list mode - called by the kcontrol module. 
.PP
Definition at line 1107 of file uiserver.cpp.
.SS "void UIServer::setJobVisible (int id, bool visible)"
.PP
Hide or show a job. 
.PP
Typically, we hide a job while a 'skip' or 'rename' dialog is being shown for this job. This prevents killing it from the uiserver. 
.PP
Definition at line 806 of file uiserver.cpp.
.SS "void UIServer::showSSLInfoDialog (const \fBQString\fP & url, const \fBKIO::MetaData\fP & data, int mainwindow)"
.PP
Show a SSL Information Dialog. 
.PP
Definition at line 1177 of file uiserver.cpp.
.SS "void UIServer::showSSLInfoDialog (const \fBQString\fP & url, const \fBKIO::MetaData\fP & data)"
.PP
\fBDeprecated\fP
.RS 4
.RE
.PP

.PP
Definition at line 1172 of file uiserver.cpp.

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