kio Library API Documentation

KIO::SlaveInterface Class Reference

There are two classes that specifies the protocol between application (job) and kioslave. More...

#include <slaveinterface.h>

Inheritance diagram for KIO::SlaveInterface:

QObject List of all members.

Signals

void authorizationKey (const QCString &, const QCString &, bool)
 Emitted whenever login (username/password) information needs to be cached.

void delAuthorization (const QCString &grpkey)
 Emitted when an io-slave requests cached password to be deleted for the specified group.


Protected Methods

void openPassDlg (KIO::AuthInfo &info)
 Prompt the user for authrization info (login & password).

void openPassDlg (const QString &prompt, const QString &user, const QString &caption, const QString &comment, const QString &label, bool readOnly)
 Same as above except in the argument it accepts.

void openPassDlg (const QString &prompt, const QString &user, bool readOnly)
 Same as above except in the argument it accepts.


Detailed Description

There are two classes that specifies the protocol between application (job) and kioslave.

SlaveInterface is the class to use on the application end, SlaveBase is the one to use on the slave end.

A call to foo() results in a call to slotFoo() on the other end.

Definition at line 127 of file slaveinterface.h.


Member Function Documentation

void KIO::SlaveInterface::authorizationKey const QCString  ,
const QCString  ,
bool   
[signal]
 

Emitted whenever login (username/password) information needs to be cached.

NOTE: this signal is also emitted whenever a

Parameters:
key  token under which authorization is stored.
grpkey  group token under which authorization is stored.
keep  if true, user requested password to be cached for entire KDE session.

void KIO::SlaveInterface::delAuthorization const QCString   grpkey [signal]
 

Emitted when an io-slave requests cached password to be deleted for the specified group.

Parameters:
grpkey  group token under which authorization is stored.

void SlaveInterface::openPassDlg KIO::AuthInfo   info [protected]
 

Prompt the user for authrization info (login & password).

Use this function to request authorization info from the the end user. For example to open an empty password dialog using default values:

 KIO::AuthInfo authInfo;
 bool result = openPassDlg( authInfo );
 if ( result )
 {
    printf( "Username: s", result.username.latin1() );
    printf( "Username: s", result.username.latin1() );
 }
 

You can also pre-set some values like the username before hand if it is known as well as the comment and caption to be displayed:

 authInfo.comment= "Enter username and password to access acmeone";
 authInfo.caption= "Acme Password Dialog";
 authInfo.username= "Wily E. kaiody";
 bool result = openPassDlg( authInfo );
 if ( result )
 {
    printf( "Username: s", result.username.latin1() );
    printf( "Username: s", result.username.latin1() );
 }
 

NOTE: A call to this function can also fail and result in a return value of false, if the UIServer could not be started for whatever reason.

Parameters:
See  AuthInfo.
Returns:
TRUE if user clicks on "OK", FALSE otherwsie.

Definition at line 477 of file slaveinterface.cpp.

References Observer::openPassDlg(), KIO::AuthInfo::prompt, Observer::self(), KIO::Connection::sendnow(), and KIO::AuthInfo::username.

Referenced by openPassDlg().

void SlaveInterface::openPassDlg const QString   prompt,
const QString   user,
const QString   caption,
const QString   comment,
const QString   label,
bool    readOnly
[protected]
 

Same as above except in the argument it accepts.

Deprecated:
. Use openPassDlg( AuthInfo& ) instead.

Definition at line 463 of file slaveinterface.cpp.

References KIO::AuthInfo::caption, KIO::AuthInfo::comment, KIO::AuthInfo::commentLabel, KStdAccel::label(), openPassDlg(), KIO::AuthInfo::prompt, KIO::AuthInfo::readOnly, and KIO::AuthInfo::username.

void SlaveInterface::openPassDlg const QString   prompt,
const QString   user,
bool    readOnly
[protected]
 

Same as above except in the argument it accepts.

Deprecated:
. Use openPassDlg( AuthInfo& ) instead.

Definition at line 454 of file slaveinterface.cpp.

References openPassDlg(), KIO::AuthInfo::prompt, KIO::AuthInfo::readOnly, and KIO::AuthInfo::username.


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:39 2003 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2001