kio Library API Documentation

UIServer Class Reference

It's purpose is to show progress of IO operations. Graphical server for progress information with an optional all-in-one progress window. More...

#include <uiserver.h>

Inheritance diagram for UIServer:

KMainWindow DCOPObject QMainWindow KXMLGUIBuilder KXMLGUIClient List of all members.

DCOP Methods

int newJob (QCString appId, bool showProgress)
 Signal a new job.

QByteArray openPassDlg (const KIO::AuthInfo &info)
int messageBox (int id, int type, const QString &text, const QString &caption, const QString &buttonYes, const QString &buttonNo)
 Popup a message box.

QByteArray open_RenameDlg64 (int id, const QString &caption, const QString &src, const QString &dest, int mode, KIO::filesize_t sizeSrc, KIO::filesize_t sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)
QByteArray open_RenameDlg (int id, const QString &caption, const QString &src, const QString &dest, int mode, unsigned long sizeSrc, unsigned long sizeDest, unsigned long ctimeSrc, unsigned long ctimeDest, unsigned long mtimeSrc, unsigned long mtimeDest)
int open_SkipDlg (int id, int multi, const QString &error_text)
void setListMode (bool list)
 Switch to or from list mode - called by the kcontrol module.

void setJobVisible (int id, bool visible)
 Hide or show a job.

void showSSLInfoDialog (const QString &url, const KIO::MetaData &data)
 Show a SSL Information Dialog.


Protected Methods

void closeEvent (QCloseEvent *)

Detailed Description

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.

All IO operations ( jobs ) are displayed in this window, one line per operation. User can cancel operations with Cancel button on toolbar.

Double clicking an item in the list opens a small download window ( DefaultProgress ).

Author:
David Faure <faure@kde.org> , Matej Koss <koss@miesto.sk>

Definition at line 186 of file uiserver.h.


Member Function Documentation

int UIServer::newJob QCString    appId,
bool    showProgress
 

Signal a new job.

Parameters:
the  DCOP application id of the job's parent application
See also:
KIO::Observer::newJob
Parameters:
showProgress  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.
Returns:
the job id

Definition at line 444 of file uiserver.cpp.

QByteArray UIServer::openPassDlg const KIO::AuthInfo   info
 

Deprecated:
(it blocks other apps). Use KIO::PasswordDialog::getNameAndPassword instead. To be removed in KDE 4.0.

Definition at line 844 of file uiserver.cpp.

int UIServer::messageBox int    id,
int    type,
const QString   text,
const QString   caption,
const QString   buttonYes,
const QString   buttonNo
 

Popup a message box.

Parameters:
type  type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel... This enum is defined in slavebase.h, it currently is: QuestionYesNo = 1, WarningYesNo = 2, WarningContinueCancel = 3, WarningYesNoCancel = 4, Information = 5, SSLMessageBox = 6
text  Message string. May contain newlines.
caption  Message box title.
buttonYes  The text for the first button. The default is i18n("&Yes").
buttonNo  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.
Returns:
a button code, as defined in KMessageBox, or 0 on communication error.

Definition at line 863 of file uiserver.cpp.

QByteArray UIServer::open_RenameDlg64 int    id,
const QString   caption,
const QString   src,
const QString   dest,
int    mode,
KIO::filesize_t    sizeSrc,
KIO::filesize_t    sizeDest,
unsigned long    ctimeSrc,
unsigned long    ctimeDest,
unsigned long    mtimeSrc,
unsigned long    mtimeDest
 

Deprecated:
(it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in KDE 4.0.

Definition at line 943 of file uiserver.cpp.

QByteArray UIServer::open_RenameDlg int    id,
const QString   caption,
const QString   src,
const QString   dest,
int    mode,
unsigned long    sizeSrc,
unsigned long    sizeDest,
unsigned long    ctimeSrc,
unsigned long    ctimeDest,
unsigned long    mtimeSrc,
unsigned long    mtimeDest
 

Deprecated:
(it blocks other apps). Use KIO::open_RenameDlg instead. To be removed in KDE 4.0.

Definition at line 928 of file uiserver.cpp.

int UIServer::open_SkipDlg int    id,
int    multi,
const QString   error_text
 

Deprecated:
(it blocks other apps). Use KIO::open_SkipDlg instead. To be removed in KDE 4.0.

Definition at line 975 of file uiserver.cpp.

void UIServer::setListMode bool    list
 

Switch to or from list mode - called by the kcontrol module.

Definition at line 803 of file uiserver.cpp.

void UIServer::setJobVisible int    id,
bool    visible
 

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 504 of file uiserver.cpp.

void UIServer::showSSLInfoDialog const QString   url,
const KIO::MetaData &    data
 

Show a SSL Information Dialog.

Definition at line 868 of file uiserver.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.0.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Oct 8 12:21:37 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001