LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
itransfermanager.h
Go to the documentation of this file.
1 /**********************************************************************
2  * LeechCraft - modular cross-platform feature rich internet client.
3  * Copyright (C) 2006-2013 Georg Rudoy
4  *
5  * Boost Software License - Version 1.0 - August 17th, 2003
6  *
7  * Permission is hereby granted, free of charge, to any person or organization
8  * obtaining a copy of the software and accompanying documentation covered by
9  * this license (the "Software") to use, reproduce, display, distribute,
10  * execute, and transmit the Software, and to prepare derivative works of the
11  * Software, and to permit third-parties to whom the Software is furnished to
12  * do so, all subject to the following:
13  *
14  * The copyright notices in the Software and this entire statement, including
15  * the above license grant, this restriction and the following disclaimer,
16  * must be included in all copies of the Software, in whole or in part, and
17  * all derivative works of the Software, unless such copies or derivative
18  * works are solely in the form of machine-executable object code generated by
19  * a source language processor.
20  *
21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23  * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
24  * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
25  * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27  * DEALINGS IN THE SOFTWARE.
28  **********************************************************************/
29 
30 #ifndef PLUGINS_AZOTH_INTERFACES_ITRANSFERMANAGER_H
31 #define PLUGINS_AZOTH_INTERFACES_ITRANSFERMANAGER_H
32 #include <QObject>
33 #include <QString>
34 
35 namespace LeechCraft
36 {
37 namespace Azoth
38 {
42  {
49  };
50 
54  {
59 
64 
68 
72  };
73 
77  {
81 
86 
92 
96 
100  };
101 
106  {
107  public:
108  virtual ~ITransferJob () {}
109 
118  virtual QString GetSourceID () const = 0;
119 
124  virtual QString GetName () const = 0;
125 
130  virtual qint64 GetSize () const = 0;
131 
136  virtual QString GetComment () const = 0;
137 
142  virtual TransferDirection GetDirection () const = 0;
143 
152  virtual void Accept (const QString& out) = 0;
153 
159  virtual void Abort () = 0;
160 
168  virtual void transferProgress (qint64 done, qint64 total) = 0;
169 
177  virtual void errorAppeared (TransferError error, const QString& msg) = 0;
178 
185  virtual void stateChanged (TransferState state) = 0;
186  };
187 
192  {
193  public:
194  virtual ~ITransferManager () {}
195 
218  virtual QObject* SendFile (const QString& id,
219  const QString& variant,
220  const QString& name,
221  const QString& comment) = 0;
222 
237  virtual void fileOffered (QObject *job) = 0;
238  };
239 }
240 }
241 
243  "org.Deviant.LeechCraft.Azoth.ITransferJob/1.0");
245  "org.Deviant.LeechCraft.Azoth.ITransferManager/1.0");
246 
247 #endif
virtual QObject * SendFile(const QString &id, const QString &variant, const QString &name, const QString &comment)=0
Requests a file transfer with the remote party.
virtual QString GetName() const =0
Returns the name of the file.
This interface must be implemented by transfer managers returned from IAccount::GetTransferManager()...
Q_DECLARE_INTERFACE(LeechCraft::Azoth::IAccount,"org.Deviant.LeechCraft.Azoth.IAccount/1.0")
virtual QString GetSourceID() const =0
Returns the ID of the other party.
This interface must be implemented by objects representing file transfer jobs.
virtual void stateChanged(TransferState state)=0
Notifies about state changes.
virtual void errorAppeared(TransferError error, const QString &msg)=0
Notifies about error.
virtual void Abort()=0
Rejects or aborts a transfer.
TransferError
Represents the error condition of the transfer.
virtual void Accept(const QString &out)=0
Accepts an incoming transfer.
virtual qint64 GetSize() const =0
Returns the size of the file.
virtual QString GetComment() const =0
Returns the human-readable comment.
TransferDirection
Represents the direction of the transfer.
TransferState
Represents the state of the file transfer job.
virtual void fileOffered(QObject *job)=0
Notifies about incoming transfer request.
virtual TransferDirection GetDirection() const =0
Returns the direction of the transfer.
virtual void transferProgress(qint64 done, qint64 total)=0
Notifies about transfer progress.