class NetAccess

Provides a synchronous interface to io jobs. More...

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

Public Static Methods


Detailed Description

Net Transparency, formerly provided by kfmlib, but now done with KIO::Job.

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. Whereas a KIO::Job 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)

download

[static]

Downloads a file from an arbitrary URL (src) 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 is 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 Reference to 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)

removeTempFile

[static]

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

Note: This means that if you created your temporary with KTempFile, use KTempFile::unlink() or KTempFile::setAutoDelete() to have it removed.

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

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

upload

[static]

Uploads file src to URL target.

Both must be specified, unlike download. Note that this is assumed to be used for saving a file over the network, so overwriting is set to true. This is not the case with copy.

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

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

copy

[static]

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::file_copy (not KIO::copy!).

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

dircopy

[static]

Alternative method for copying over the network. Overwrite is false, so this will fail if target exists.

This one takes two URLs and is a direct equivalent of KIO::copy!.

bool  exists (const KURL& url)

exists

[static]

Tests 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  stat (const KURL& url, KIO::UDSEntry & entry)

stat

[static]

Tests whether a URL exists and return information on it.

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.
entryThe result of the stat. Iterate over the list of atoms to get hold of name, type, size, etc., or use KFileItem.

bool  del ( const KURL & url )

del

[static]

Deletes 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:
urlThe file or directory to delete.

Returns: true on success, false on failure.

bool  mkdir ( const KURL & url, int permissions = -1 )

mkdir

[static]

Creates a directory in a synchronous way.

This is a convenience function for KIO::mkdir (it saves creating a slot and testing for the job result).

Parameters:
urlThe directory to create.

Returns: true on success, false on failure.

QString  mimetype ( const KURL & url )

mimetype

[static]

Determines the mimetype of a given URL.

This is a convenience function for KIO::mimetype. You should call this only when really necessary. KMimeType::findByURL can determine extension a lot faster, but less reliably for remote files. Only when findByURL() returns unknown (application/octet-stream) then this one should be used.

Parameters:
urlThe URL whose mimetype we are interested in.

Returns: The mimetype name.

QString  lastErrorString ()

lastErrorString

[static]

Returns the error string for the last job, in case it failed.


Generated by: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53.