summaryrefslogtreecommitdiff
path: root/interface/PluginInterface_Listener.h
blob: 7d6508b6f120c736e0fb15b23ee0d7600f1916de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/** \file PluginInterface_Listener.h
\brief Define the interface of the plugin of type: listener
\author alpha_one_x86
\version 0.3
\date 2010 */ 

#ifndef PLUGININTERFACE_LISTENER_H
#define PLUGININTERFACE_LISTENER_H

#include <QObject>
#include <QString>
#include <QStringList>

#include "OptionInterface.h"

#include "../StructEnumDefinition.h"

/** \brief To define the interface between Ultracopier and the listener
 * */
class PluginInterface_Listener : public QObject
{
	Q_OBJECT
	public:
		/// \brief put this plugin in listen mode
		virtual void listen() = 0;
		/// \brief put close the listen
		virtual void close() = 0;
		/// \brief to get the error string
		virtual const QString errorString() = 0;
		/// \brief set the resources for the plugin
		virtual void setResources(OptionInterface * options,QString writePath,QString pluginPath,bool portableVersion) = 0;
	public slots:
		/// \brief send when copy is finished
		virtual void transferFinished(quint32 orderId,bool withError) = 0;
		/// \brief send when copy is canceled
		virtual void transferCanceled(quint32 orderId) = 0;
	/* signal to implement
	signals:
		void newState(ListeningState state);
		void newCopy(quint32 orderId,QStringList sources);
		void newCopy(quint32 orderId,QStringList sources,QString destination);
		void newMove(quint32 orderId,QStringList sources);
		void newMove(quint32 orderId,QStringList sources,QString destination);*/
};

Q_DECLARE_INTERFACE(PluginInterface_Listener,"first-world.info.ultracopier.PluginInterface.Listener/0.3.0.5");

#endif // PLUGININTERFACE_LISTENER_H