TransferGroupHandler Class Reference

#include <transfergrouphandler.h>

Inheritance diagram for TransferGroupHandler:

Public Types
typedef TransferGroup::ChangesFlags	ChangesFlags

Public Slots
void	start ()
void	stop ()

Signals
void	groupChangedEvent (TransferGroupHandler *transfer, TransferGroupHandler::ChangesFlags flags)

Public Member Functions
	TransferGroupHandler (Scheduler *scheduler, TransferGroup *parent)
	~TransferGroupHandler ()
const QList< QAction * > &	actions ()
void	calculateDownloadLimit ()
void	calculateSpeedLimits ()
void	calculateUploadLimit ()
ChangesFlags	changesFlags ()
int	columnCount () const
QVariant	data (int column)
QString	defaultFolder ()
int	downloadedSize () const
int	downloadLimit (Transfer::SpeedLimit limit)
int	downloadSpeed () const
QString	iconName () const
int	indexOf (TransferHandler *transfer)
void	move (QList< TransferHandler * > transfers, TransferHandler *after)
const QString &	name ()
TransferHandler *	operator[] (int i)
int	percent () const
QPixmap	pixmap ()
QRegExp	regExp ()
void	setDefaultFolder (QString folder)
void	setDownloadLimit (int dlLimit, Transfer::SpeedLimit limit)
void	setIconName (const QString &name)
void	setMaxSimultaneousJobs (int n)
void	setName (const QString &name)
void	setRegExp (const QRegExp &regexp)
void	setUploadLimit (int ulLimit, Transfer::SpeedLimit limit)
int	size ()
JobQueue::Status	status () const
int	totalSize () const
const QList< TransferHandler * >	transfers ()
int	uploadedSize () const
int	uploadLimit (Transfer::SpeedLimit limit)
int	uploadSpeed () const
Public Member Functions inherited from Handler
	Handler (Scheduler *scheduler, QObject *parent)
virtual	~Handler ()
virtual void	start ()=0
virtual void	stop ()=0

Additional Inherited Members
Protected Attributes inherited from Handler
Scheduler *	m_scheduler

Detailed Description

Definition at line 30 of file transfergrouphandler.h.

Member Typedef Documentation

typedef TransferGroup::ChangesFlags TransferGroupHandler::ChangesFlags

Definition at line 39 of file transfergrouphandler.h.

Constructor & Destructor Documentation

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

Definition at line 27 of file transfergrouphandler.cpp.

TransferGroupHandler::~TransferGroupHandler

(

)

Definition at line 34 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 148 of file transfergrouphandler.cpp.

void TransferGroupHandler::calculateDownloadLimit ( )

inline

Calculates the DownloadLimits.

Definition at line 237 of file transfergrouphandler.h.

void TransferGroupHandler::calculateSpeedLimits ( )

inline

Calculates the whole SpeedLimits.

Definition at line 232 of file transfergrouphandler.h.

void TransferGroupHandler::calculateUploadLimit ( )

inline

Calculates the DownloadLimits.

Definition at line 242 of file transfergrouphandler.h.

TransferGroup::ChangesFlags TransferGroupHandler::changesFlags

(

)

Returns

the changes flags which are currently set on the transfer

Definition at line 119 of file transfergrouphandler.cpp.

int TransferGroupHandler::columnCount ( ) const

inline

Returns

the number of columns associated to the group's data

Definition at line 209 of file transfergrouphandler.h.

QVariant TransferGroupHandler::data ( int  column )

virtual

Returns

the data associated to this TransferGroup item. This is necessary to make the interview model/view work

Implements Handler.

Definition at line 83 of file transfergrouphandler.cpp.

QString TransferGroupHandler::defaultFolder ( )

inline

Returns

the groups default folder

Definition at line 134 of file transfergrouphandler.h.

int TransferGroupHandler::downloadedSize ( ) const

inline

Returns

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

Definition at line 95 of file transfergrouphandler.h.

int TransferGroupHandler::downloadLimit ( Transfer::SpeedLimit  limit )

inline

Returns

the group's Download-Limit

Definition at line 170 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 112 of file transfergrouphandler.h.

void TransferGroupHandler::groupChangedEvent ( TransferGroupHandler *  transfer, TransferGroupHandler::ChangesFlags  flags  )

signal

QString TransferGroupHandler::iconName ( ) const

inline

Returns

the group's icon's name

Definition at line 193 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 129 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 50 of file transfergrouphandler.cpp.

const QString& TransferGroupHandler::name ( )

inline

Returns

the group name

Definition at line 83 of file transfergrouphandler.h.

TransferHandler * TransferGroupHandler::operator[]

(

int

i

)

Returns

the Job in the queue at the given index i

Definition at line 71 of file transfergrouphandler.cpp.

int TransferGroupHandler::percent ( ) const

inline

Returns

the progress percentage

Definition at line 106 of file transfergrouphandler.h.

QPixmap TransferGroupHandler::pixmap ( )

inline

Returns

the group's icon

Definition at line 198 of file transfergrouphandler.h.

QRegExp TransferGroupHandler::regExp ( )

inline

Returns

the regular expression of the group

Definition at line 145 of file transfergrouphandler.h.

void TransferGroupHandler::setDefaultFolder ( QString  folder )

inline

Set a default Folder for the group.

Parameters

folder

the new default folder

Definition at line 129 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 165 of file transfergrouphandler.h.

void TransferGroupHandler::setIconName ( const QString &  name )

inline

Set the group's icon.

Parameters

name	the icon's name

Definition at line 188 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

n	The maximum number of jobs

void TransferGroupHandler::setName

(

const QString &

name

)

Set the group name.

Parameters

name	group name

Definition at line 78 of file transfergrouphandler.cpp.

void TransferGroupHandler::setRegExp ( const QRegExp &  regexp )

inline

Sets the regular expression of the group.

Parameters

regexp

the regular expression

Definition at line 140 of file transfergrouphandler.h.

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 177 of file transfergrouphandler.h.

int TransferGroupHandler::size ( )

inline

Returns

the number of Transfers owned by this object

Definition at line 73 of file transfergrouphandler.h.

void TransferGroupHandler::start ( )

slot

These are all JobQueue-related functions.

Definition at line 38 of file transfergrouphandler.cpp.

JobQueue::Status TransferGroupHandler::status ( ) const

inline

Definition at line 45 of file transfergrouphandler.h.

void TransferGroupHandler::stop ( )

slot

Definition at line 44 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 89 of file transfergrouphandler.h.

const QList< TransferHandler * > TransferGroupHandler::transfers

(

)

Returns

a list containing all the transfers belonging to this group.

Definition at line 134 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 101 of file transfergrouphandler.h.

int TransferGroupHandler::uploadLimit ( Transfer::SpeedLimit  limit )

inline

Returns

the group's Upload-Limit

Definition at line 182 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 118 of file transfergrouphandler.h.

---

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

• transfergrouphandler.h
• transfergrouphandler.cpp