class NetAccess

This class isn't meant to be used as a class but only as a simple namespace for static functions, though an instance of the class is built for internal purposes. More...

Full nameKIO::NetAccess
Definition#include <netaccess.h>
InheritsQObject (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Static Methods

Protected Methods

Protected Slots

Protected Members


Detailed Description

This class isn't meant to be used as a class but only as a simple namespace for static functions, though an instance of the class is built for internal purposes. KIO::NetAccess implements the Net Transparency, which was formerly provided by kfmlib, but now using KIO::Jobs. Whereas a kiojob is asynchronous, meaning that the developer has to connect slots for it, KIO::NetAccess provides synchronous downloads and uploads, as well as temporary file creation and removal.

Port to kio done by David Faure, faure@kde.org

bool  download (const KURL& src, QString & target)

[static]

This function downloads a file from an arbitrary URL (source) to a temporary file on the local filesystem (target). If the argument for target is an empty string, download will generate a unique temporary filename in /tmp. Since target is a reference to QString you can access this filename easily. Download will return true if the download was successful, otherwise false.

Special case: If the url is of kind "file:" then no downloading is processed but the full filename returned in target. That means: you _have_ to take care about the target argument. (This is very easy to do, please see the example below.)

Download is synchronous. That means you can use it like this, (assuming u is a string which represents a URL and your application has a loadFile function):


 QString tmpFile;
 if( KIO::NetAccess::download( u, tmpFile ) )
 {
   loadFile( tmpFile );
   KIO::NetAccess::removeTempFile( tmpFile );
   }

Of course, your user interface will still process exposure/repaint events during the download.

Parameters:
srcURL referencing the file to download
targetString containing the final local location of the file. If you insert an empty string, it will return a location in a temporary spot

void  removeTempFile (const QString& name)

[static]

Remove the specified file if and only if it was created by KIO::NetAccess as temporary file for a former download.

Parameters:
namePath to temporary file to remove. May not be empty.

bool  upload (const QString& src, const KURL& target)

[static]

Upload file src to url target. Both must be specified, unlike download.

Parameters:
srcURL referencing the file to upload
targetURL containing the final location of the file.

bool  copy ( const KURL& src, const KURL& target )

[static]

Alternative method for copying over the network This one takes two URLs and is a direct equivalent of KIO::file_copy (not KIO::copy!).

bool  exists (const KURL& url)

[static]

Test whether a url exists This is a convenience function for KIO::stat (it saves creating a slot and testing for the job result)

Parameters:
urlthe url we are testing

bool  del ( const KURL & url )

[static]

Delete a file or a directory in an synchronous way This is a convenience function for KIO::del (it saves creating a slot and testing for the job result)

Parameters:
srcthe file or directory to delete

Returns: true on success, false on failure

 NetAccess ()

[protected]

Private constructor

NetAccess ()

[protected]

Private destructor

bool  copyInternal (const KURL& src, const KURL& target)

[protected]

Internal methods

static QStringList* tmpfiles

[protected]

List of temporary files

bool bJobOK

[protected]

Whether the download succeeded or not


Generated by: root@porky.devel.redhat.com on Wed May 10 08:56:52 2000, using kdoc 2.0a35.