You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdenetwork/kopete/libkopete/kopetetransfermanager.h

214 lines
6.1 KiB

/*
kopetetransfermanager.h
Copyright (c) 2002-2003 by Nick Betcher <nbetcher@kde.org>
Copyright (c) 2002-2003 by Richard Smith <kopete@metafoo.co.uk>
Kopete (c) 2002-2004 by the Kopete developers <kopete-devel@kde.org>
*************************************************************************
* *
* This library is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2 of the License, or (at your option) any later version. *
* *
*************************************************************************
*/
#ifndef KOPETEFILETRANSFER_H
#define KOPETEFILETRANSFER_H
#include <tqobject.h>
#include <tqstring.h>
#include <tqmap.h>
#include "kopete_export.h"
#include <tdeio/job.h>
namespace Kopete
{
class Transfer;
class Contact;
/**
* @author Nick Betcher. <nbetcher@kde.org>
*/
class KOPETE_EXPORT FileTransferInfo
{
public:
enum KopeteTransferDirection { Incoming, Outgoing };
FileTransferInfo( Contact *, const TQString&, const unsigned long size, const TQString &, KopeteTransferDirection di, const unsigned int id, TQString internalId=TQString());
~FileTransferInfo() {}
unsigned int transferId() const { return mId; }
const Contact* contact() const { return mContact; }
TQString file() const { return mFile; }
TQString recipient() const { return mRecipient; }
unsigned long size() const { return mSize; }
TQString internalId() const { return m_intId; }
KopeteTransferDirection direction() const { return mDirection; }
private:
unsigned long mSize;
TQString mRecipient;
unsigned int mId;
Contact *mContact;
TQString mFile;
TQString m_intId;
KopeteTransferDirection mDirection;
};
/**
* Creates and manages kopete file transfers
*/
class KOPETE_EXPORT TransferManager : public TQObject
{
TQ_OBJECT
public:
/**
* Retrieve the transfer manager instance
*/
static TransferManager* transferManager();
virtual ~TransferManager() {};
/**
* @brief Adds a file transfer to the Kopete::TransferManager
*/
Transfer *addTransfer( Contact *contact, const TQString& file, const unsigned long size, const TQString &recipient , FileTransferInfo::KopeteTransferDirection di);
int askIncomingTransfer( Contact *contact, const TQString& file, const unsigned long size, const TQString& description=TQString(), TQString internalId=TQString());
void removeTransfer( unsigned int id );
/**
* @brief Ask the user which file to send when they click Send File.
*
* Possibly ask the user which file to send when they click Send File. Sends a signal indicating KURL to
* send when the local user accepts the transfer.
* @param file If valid, the user will not be prompted for a URL, and this one will be used instead.
* If it refers to a remote file and mustBeLocal is true, the file will be transferred to the local
* filesystem.
* @param localFile file name to display if file is a valid URL
* @param fileSize file size to send if file is a valid URL
* @param mustBeLocal If the protocol can only send files on the local filesystem, this flag
* allows you to ensure the filename will be local.
* @param sendTo The object to send the signal to
* @param slot The slot to send the signal to. Signature: sendFile(const KURL &file)
*/
void sendFile( const KURL &file, const TQString &localFile, unsigned long fileSize,
bool mustBeLocal, TQObject *sendTo, const char *slot );
signals:
/** @brief Signals the transfer is done. */
void done( Kopete::Transfer* );
/** @brief Signals the transfer has been canceled. */
void canceled( Kopete::Transfer* );
/** @brief Signals the transfer has been accepted */
void accepted(Kopete::Transfer*, const TQString &fileName);
/** @brief Signals the transfer has been rejected */
void refused(const Kopete::FileTransferInfo& );
/** @brief Send a file */
void sendFile(const KURL &file, const TQString &localFile, unsigned int fileSize);
private slots:
void slotAccepted(const Kopete::FileTransferInfo&, const TQString&);
void slotComplete(TDEIO::Job*);
private:
TransferManager( TQObject *parent );
static TransferManager *s_transferManager;
int nextID;
TQMap<unsigned int, Transfer *> mTransfersMap;
};
/**
* A TDEIO job for a kopete file transfer.
* @author Richard Smith <kopete@metafoo.co.uk>
*/
class KOPETE_EXPORT Transfer : public TDEIO::Job
{
TQ_OBJECT
public:
/**
* Constructor
*/
Transfer( const FileTransferInfo &, const TQString &localFile, bool showProgressInfo = true);
/**
* Constructor
*/
Transfer( const FileTransferInfo &, const Contact *toUser, bool showProgressInfo = true);
/**
* Destructor
*/
~Transfer();
/** @brief Get the info for this file transfer */
const FileTransferInfo &info() const { return mInfo; }
/**
* Retrieve a URL indicating where the file is being copied from.
* For display purposes only! There's no guarantee that this URL
* refers to a real file being transferred.
*/
KURL sourceURL();
/**
* Retrieve a URL indicating where the file is being copied to.
* See @ref sourceURL
*/
KURL destinationURL();
public slots:
/**
* @brief Set the file size processed so far
*/
void slotProcessed(unsigned int);
/**
* @brief Indicate that the transfer is complete
*/
void slotComplete();
/**
* @brief Inform the job that an error has occurred while transferring the file.
*
* @param error A member of the TDEIO::Error enumeration indicating what error occurred.
* @param errorText A string to aid understanding of the error, often the offending URL.
*/
void slotError( int error, const TQString &errorText );
signals:
/**
* @deprecated Use result() and check error() for ERR_USER_CANCELED
*/
void transferCanceled();
private:
void init( const KURL &, bool );
static KURL displayURL( const Contact *contact, const TQString &file );
FileTransferInfo mInfo;
KURL mTarget;
int mPercent;
private slots:
void slotResultEmitted();
};
}
#endif