Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KIO::SlaveInterface Class Reference

#include <slaveinterface.h>

Inheritance diagram for KIO::SlaveInterface:

List of all members.

Signals

void authorizationKey (const QCString &, const QCString &, bool)
void delAuthorization (const QCString &grpkey)

Protected Methods

void openPassDlg (KIO::AuthInfo &info)
void openPassDlg (const QString &prompt, const QString &user, const QString &caption, const QString &comment, const QString &label, bool readOnly)
void openPassDlg (const QString &prompt, const QString &user, bool readOnly)

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 KIO::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.

void KIO::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.

void KIO::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.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:33 2003 for kdelibs by doxygen1.2.18