TDEIO::StatJob Class Reference

#include <jobclasses.h>

Inheritance diagram for TDEIO::StatJob:

Signals
void	redirection (TDEIO::Job *job, const KURL &url)
void	permanentRedirection (TDEIO::Job *job, const KURL &fromUrl, const KURL &toUrl)
Signals inherited from TDEIO::Job
void	result (TDEIO::Job *job)
void	canceled (TDEIO::Job *job)
void	infoMessage (TDEIO::Job *job, const TQString &msg)
void	warning (TDEIO::Job *job, const TQString &msg)
void	connected (TDEIO::Job *job)
void	percent (TDEIO::Job *job, unsigned long percent)
void	totalSize (TDEIO::Job *job, TDEIO::filesize_t size)
void	processedSize (TDEIO::Job *job, TDEIO::filesize_t size)
void	speed (TDEIO::Job *job, unsigned long speed)

Public Member Functions
	StatJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo)
void	setSide (bool source)
void	setDetails (short int details)
const UDSEntry &	statResult () const
virtual void	start (Slave *slave)
Public Member Functions inherited from TDEIO::SimpleJob
	SimpleJob (const KURL &url, int command, const TQByteArray &packedArgs, bool showProgressInfo)
const KURL &	url () const
virtual void	kill (bool quietly=true)
virtual void	putOnHold ()
void	slaveDone ()
Slave *	slave () const
int	command () const
Public Member Functions inherited from TDEIO::Job
int	error () const
int	progressId () const
const TQString &	errorText () const
TQString	errorString () const
TQStringList	detailedErrorStrings (const KURL *reqUrl=0L, int method=-1) const
void	showErrorDialog (TQWidget *parent=0L)
void	setAutoErrorHandlingEnabled (bool enable, TQWidget *parentWidget=0)
bool	isAutoErrorHandlingEnabled () const
void	setAutoWarningHandlingEnabled (bool enable)
bool	isAutoWarningHandlingEnabled () const
void	setInteractive (bool enable)
bool	isInteractive () const
void	setWindow (TQWidget *window)
TQWidget *	window () const
void	updateUserTimestamp (unsigned long time)
void	setParentJob (Job *parentJob)
Job *	parentJob () const
void	setMetaData (const TDEIO::MetaData &metaData)
void	addMetaData (const TQString &key, const TQString &value)
void	addMetaData (const TQMap< TQString, TQString > &values)
void	mergeMetaData (const TQMap< TQString, TQString > &values)
MetaData	outgoingMetaData () const
MetaData	metaData () const
TQString	queryMetaData (const TQString &key)
TDEIO::filesize_t	getProcessedSize ()

Protected Slots
void	slotStatEntry (const TDEIO::UDSEntry &entry)
void	slotRedirection (const KURL &url)
virtual void	slotFinished ()
virtual void	slotMetaData (const TDEIO::MetaData &_metaData)
Protected Slots inherited from TDEIO::SimpleJob
virtual void	slotFinished ()
void	slotWarning (const TQString &)
void	slotInfoMessage (const TQString &s)
void	slotConnected ()
void	slotProcessedSize (TDEIO::filesize_t data_size)
void	slotSpeed (unsigned long speed)
virtual void	slotMetaData (const TDEIO::MetaData &_metaData)
void	slotNeedProgressId ()
Protected Slots inherited from TDEIO::Job
virtual void	slotResult (TDEIO::Job *job)
void	slotSpeed (TDEIO::Job *job, unsigned long speed)
void	slotInfoMessage (TDEIO::Job *job, const TQString &msg)
void	slotSpeedTimeout ()

Protected Member Functions
virtual void	virtual_hook (int id, void *data)
Protected Member Functions inherited from TDEIO::SimpleJob
void	storeSSLSessionFromJob (const KURL &m_redirectionURL)
Protected Member Functions inherited from TDEIO::Job
	Job (bool showProgressInfo)
virtual void	addSubjob (Job *job, bool inheritMetaData=true)
virtual void	removeSubjob (Job *job)
void	removeSubjob (Job *job, bool mergeMetaData, bool emitResultIfLast)
void	emitPercent (TDEIO::filesize_t processedSize, TDEIO::filesize_t totalSize)
void	emitSpeed (unsigned long speed)
void	emitResult ()
void	setProcessedSize (TDEIO::filesize_t size)
unsigned long	userTimestamp () const
int &	extraFlags ()

Protected Attributes
UDSEntry	m_statResult
KURL	m_redirectionURL
bool	m_bSource
short int	m_details
Protected Attributes inherited from TDEIO::SimpleJob
Slave *	m_slave
TQByteArray	m_packedArgs
KURL	m_url
KURL	m_subUrl
int	m_command
TDEIO::filesize_t	m_totalSize
Protected Attributes inherited from TDEIO::Job
TQPtrList< Job >	subjobs
int	m_error
TQString	m_errorText
unsigned long	m_percent
int	m_progressId
TQTimer *	m_speedTimer
TQGuardedPtr< TQWidget >	m_window
MetaData	m_outgoingMetaData
MetaData	m_incomingMetaData

Additional Inherited Members
Public Slots inherited from TDEIO::SimpleJob
void	slotTotalSize (TDEIO::filesize_t data_size)
virtual void	slotError (int, const TQString &)
Static Public Member Functions inherited from TDEIO::SimpleJob
static void	removeOnHold ()
Protected Types inherited from TDEIO::Job
enum	{ EF_TransferJobAsync = (1 << 0) , EF_TransferJobNeedData = (1 << 1) , EF_TransferJobDataSent = (1 << 2) , EF_ListJobUnrestricted = (1 << 3) }

Detailed Description

A TDEIO job that retrieves information about a file or directory.

See also

TDEIO::stat()

Definition at line 687 of file jobclasses.h.

Constructor & Destructor Documentation

StatJob()

StatJob::StatJob	(	const KURL &	url,
		int	command,
		const TQByteArray &	packedArgs,
		bool	showProgressInfo )

Do not use this constructor to create a StatJob, use TDEIO::stat() instead.

Parameters

url	the url of the file or directory to check
command	the command to issue
packedArgs	the arguments
showProgressInfo	true to show progress information to the user

Definition at line 879 of file job.cpp.

Member Function Documentation

permanentRedirection

void TDEIO::StatJob::permanentRedirection ( TDEIO::Job * job, const KURL & fromUrl, const KURL & toUrl )

signal

Signals a permanent redirection.
The redirection itself is handled internally.

Parameters

job	the job that is redirected
fromUrl	the original URL
toUrl	the new URL

Since

3.1

redirection

void TDEIO::StatJob::redirection ( TDEIO::Job * job, const KURL & url )

signal

Signals a redirection.
Use to update the URL shown to the user.
The redirection itself is handled internally.

Parameters

job	the job that is redirected
url	the new url

setDetails()

void TDEIO::StatJob::setDetails ( short int details )

inline

Selects the level of @p details we want.
By default this is 2 (all details wanted, including modification time, size, etc.),
setDetails(1) is used when deleting: we don't need all the information if it takes
too much time, no need to follow symlinks etc.
setDetails(0) is used for very simple probing: we'll only get the answer
"it's a file or a directory, or it doesn't exist". This is used by KRun.

Parameters

details

2 for all details, 1 for simple, 0 for very simple

Definition at line 719 of file jobclasses.h.

setSide()

void TDEIO::StatJob::setSide ( bool source )

inline

A stat() can have two meanings.

Either we want to read from this URL, or to check if we can write to it. First case is "source", second is "dest". It is necessary to know what the StatJob is for, to tune the tdeioslave's behavior (e.g. with FTP).

Parameters

source

true for "source" mode, false for "dest" mode

Definition at line 708 of file jobclasses.h.

slotFinished

void StatJob::slotFinished ( )

protectedvirtualslot

Definition at line 923 of file job.cpp.

slotMetaData

void StatJob::slotMetaData ( const TDEIO::MetaData & _metaData )

protectedvirtualslot

Definition at line 945 of file job.cpp.

slotRedirection

void StatJob::slotRedirection ( const KURL & url )

protectedslot

Definition at line 906 of file job.cpp.

slotStatEntry

void StatJob::slotStatEntry ( const TDEIO::UDSEntry & entry )

protectedslot

Definition at line 899 of file job.cpp.

start()

void StatJob::start ( Slave * slave )

virtual

Reimplemented from TDEIO::SimpleJob.

Definition at line 886 of file job.cpp.

statResult()

const UDSEntry & TDEIO::StatJob::statResult ( ) const

inline

Call this in the slot connected to result,
and only after making sure no error happened.

Returns

the result of the stat

Definition at line 726 of file jobclasses.h.

virtual_hook()

void StatJob::virtual_hook ( int id, void * data )

protectedvirtual

Reimplemented from TDEIO::SimpleJob.

Definition at line 4816 of file job.cpp.

Member Data Documentation

m_bSource

bool TDEIO::StatJob::m_bSource

protected

Definition at line 765 of file jobclasses.h.

m_details

short int TDEIO::StatJob::m_details

protected

Definition at line 766 of file jobclasses.h.

m_redirectionURL

KURL TDEIO::StatJob::m_redirectionURL

protected

Definition at line 764 of file jobclasses.h.

m_statResult

UDSEntry TDEIO::StatJob::m_statResult

protected

Definition at line 763 of file jobclasses.h.

---

The documentation for this class was generated from the following files:

• jobclasses.h
• job.cpp