kget

TransferGroupHandler Class Reference

#include <transfergrouphandler.h>

Inheritance diagram for TransferGroupHandler:

Detailed Description

Definition at line 31 of file transfergrouphandler.h.


Public Types
typedef TransferGroup::ChangesFlags	ChangesFlags
Public Member Functions
const QList< QAction * > &	actions ()
void	addObserver (TransferGroupObserver *observer)
void	calculateDownloadLimit ()
void	calculateSpeedLimits ()
void	calculateUploadLimit ()
ChangesFlags	changesFlags (TransferGroupObserver *observer)
int	columnCount () const
QVariant	data (int column)
QString	defaultFolder ()
void	delObserver (TransferGroupObserver *observer)
int	downloadedSize () const
int	downloadLimit (Transfer::SpeedLimit limit)
int	downloadSpeed () const
int	indexOf (TransferHandler *transfer)
void	move (QList< TransferHandler * > transfers, TransferHandler *after)
const QString &	name ()
TransferHandler *	operator[] (int i)
int	percent () const
QPixmap	pixmap ()
QObjectInterface *	qObject ()
void	resetChangesFlags (TransferGroupObserver *observer)
void	setDefaultFolder (QString folder)
void	setDownloadLimit (int dlLimit, Transfer::SpeedLimit limit)
void	setIconName (QString name)
void	setMaxSimultaneousJobs (int n)
void	setName (const QString &name)
void	setUploadLimit (int ulLimit, Transfer::SpeedLimit limit)
int	size ()
void	start ()
JobQueue::Status	status () const
void	stop ()
int	totalSize () const
	TransferGroupHandler (TransferGroup group, Scheduler scheduler)
const QList< TransferHandler * >	transfers ()
int	uploadedSize () const
int	uploadLimit (Transfer::SpeedLimit limit)
int	uploadSpeed () const
	~TransferGroupHandler ()

Member Typedef Documentation

typedef TransferGroup::ChangesFlags TransferGroupHandler::ChangesFlags

Definition at line 39 of file transfergrouphandler.h.

Constructor & Destructor Documentation

TransferGroupHandler::TransferGroupHandler	(	TransferGroup *	group,
		Scheduler *	scheduler
	)

Definition at line 28 of file transfergrouphandler.cpp.

TransferGroupHandler::~TransferGroupHandler ( )

Definition at line 36 of file transfergrouphandler.cpp.

Member Function Documentation

const QList< QAction * > & TransferGroupHandler::actions ( )

Returns:: a pointer to a QObjectInterface object which is a QObject by means of which you can connect signals and slots for this transfer group.

Definition at line 175 of file transfergrouphandler.cpp.

void TransferGroupHandler::addObserver ( TransferGroupObserver * observer )

Adds an observer to this TransferGroup Note that the observer with pointer == 0 is added by default, and it's used by the TransferTreeModel class.

Parameters:

observer

The new observer that should be added

Definition at line 40 of file transfergrouphandler.cpp.

void TransferGroupHandler::calculateDownloadLimit ( ) [inline]

Calculates the DownloadLimits.

Definition at line 245 of file transfergrouphandler.h.

void TransferGroupHandler::calculateSpeedLimits ( ) [inline]

Calculates the whole SpeedLimits.

Definition at line 240 of file transfergrouphandler.h.

void TransferGroupHandler::calculateUploadLimit ( ) [inline]

Calculates the DownloadLimits.

Definition at line 250 of file transfergrouphandler.h.

TransferGroup::ChangesFlags TransferGroupHandler::changesFlags ( TransferGroupObserver * observer )

Returns the changes flags.

Parameters:

observer

The observer that makes this request

Definition at line 136 of file transfergrouphandler.cpp.

int TransferGroupHandler::columnCount ( ) const [inline]

Returns:: the number of columns associated to the group's data

Definition at line 196 of file transfergrouphandler.h.

QVariant TransferGroupHandler::data ( int column )

Returns:: the data associated to this TransferGroup item.

This is necessary to make the interview model/view work

Definition at line 100 of file transfergrouphandler.cpp.

QString TransferGroupHandler::defaultFolder ( ) [inline]

Returns:: the groups default folder

Definition at line 150 of file transfergrouphandler.h.

void TransferGroupHandler::delObserver ( TransferGroupObserver * observer )

Removes an observer from this TransferGroup.

Parameters:

observer

The observer that should be removed

Definition at line 48 of file transfergrouphandler.cpp.

int TransferGroupHandler::downloadedSize ( ) const [inline]

Returns:: the sum of the downloaded sizes of the transfers belonging to this group

Definition at line 116 of file transfergrouphandler.h.

int TransferGroupHandler::downloadLimit ( Transfer::SpeedLimit limit ) [inline]

Returns:: the group's Download-Limit

Definition at line 162 of file transfergrouphandler.h.

int TransferGroupHandler::downloadSpeed ( ) const [inline]

Returns:: the sum of the download speeds of the running transfers belonging this group

Definition at line 133 of file transfergrouphandler.h.

int TransferGroupHandler::indexOf ( TransferHandler * transfer )

Returns:: the index for the given transfer.

If the transfer can't be found, it returns -1

Definition at line 156 of file transfergrouphandler.cpp.

void TransferGroupHandler::move	(	QList< TransferHandler * >	transfers,
		TransferHandler *	after
	)

Moves a list of transfers belonging to this group to a new position, after the transfer named "after".

All the transfers must belong to this group

Parameters:

	transfers	The transfers to be be moved
	after	The transfer after which the given transfers should be moved

Definition at line 66 of file transfergrouphandler.cpp.

const QString& TransferGroupHandler::name ( ) [inline]

Returns:: the group name

Definition at line 104 of file transfergrouphandler.h.

TransferHandler * TransferGroupHandler::operator[] ( int i )

Returns:: the Job in the queue at the given index i

Definition at line 87 of file transfergrouphandler.cpp.

int TransferGroupHandler::percent ( ) const [inline]

Returns:: the progress percentage

Definition at line 127 of file transfergrouphandler.h.

QPixmap TransferGroupHandler::pixmap ( ) [inline]

Returns:: the group's icon

Definition at line 185 of file transfergrouphandler.h.

QObjectInterface * TransferGroupHandler::qObject ( )

Returns:: a pointer to a QObjectInterface object which is a QObject by means of which you can connect signals and slots for this transfer group.

Definition at line 182 of file transfergrouphandler.cpp.

void TransferGroupHandler::resetChangesFlags ( TransferGroupObserver * observer )

Resets the changes flags for a given TransferObserver.

Parameters:

observer

The observer that makes this request

Definition at line 148 of file transfergrouphandler.cpp.

void TransferGroupHandler::setDefaultFolder ( QString folder ) [inline]

Set a default Folder for the group.

Parameters:

folder

the new default folder

Definition at line 145 of file transfergrouphandler.h.

void TransferGroupHandler::setDownloadLimit	(	int	dlLimit,
		Transfer::SpeedLimit	limit
	)			`[inline]`

Set a Download-Limit for the group.

Parameters:

limit

the new download-limit

Note:: if limit is 0, no download-limit is set

Definition at line 157 of file transfergrouphandler.h.

void TransferGroupHandler::setIconName ( QString name ) [inline]

Set the group's icon.

Parameters:

name

the icon's name

Definition at line 180 of file transfergrouphandler.h.

void TransferGroupHandler::setMaxSimultaneousJobs ( int n )

Sets the maximum number of jobs belonging to this queue that should executed simultaneously by the scheduler.

Parameters:

The maximum number of jobs

void TransferGroupHandler::setName ( const QString & name )

Set the group name.

Parameters:

name

group name

Definition at line 94 of file transfergrouphandler.cpp.

void TransferGroupHandler::setUploadLimit	(	int	ulLimit,
		Transfer::SpeedLimit	limit
	)			`[inline]`

Set a Upload-Limit for the group.

Parameters:

limit

the new upload-limit

Note:: this will not be displayed in the GUI

Definition at line 169 of file transfergrouphandler.h.

int TransferGroupHandler::size ( ) [inline]

Returns:: the number of Transfers owned by this object

Definition at line 94 of file transfergrouphandler.h.

void TransferGroupHandler::start ( ) [virtual]

These are all JobQueue-related functions.

Implements Handler.

Definition at line 54 of file transfergrouphandler.cpp.

JobQueue::Status TransferGroupHandler::status ( ) const [inline]

Definition at line 66 of file transfergrouphandler.h.

void TransferGroupHandler::stop ( ) [virtual]

Implements Handler.

Definition at line 60 of file transfergrouphandler.cpp.

int TransferGroupHandler::totalSize ( ) const [inline]

Returns:: the sum of the sizes of the transfers belonging to this group

Definition at line 110 of file transfergrouphandler.h.

const QList< TransferHandler * > TransferGroupHandler::transfers ( )

Returns:: a list containing all the transfers belonging to this group.

Definition at line 161 of file transfergrouphandler.cpp.

int TransferGroupHandler::uploadedSize ( ) const [inline]

Returns:: the sum of the uploaded sizes of the transfers belonging to this group

Definition at line 122 of file transfergrouphandler.h.

int TransferGroupHandler::uploadLimit ( Transfer::SpeedLimit limit ) [inline]

Returns:: the group's Upload-Limit

Definition at line 174 of file transfergrouphandler.h.

int TransferGroupHandler::uploadSpeed ( ) const [inline]

Returns:: the sum of the upload speeds of the running transfers belonging this group

Definition at line 139 of file transfergrouphandler.h.

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

kget

TransferGroupHandler Class Reference

Detailed Description

Public Types

Public Member Functions

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

kget

kdenetwork