Content Hub  1.1.0
A session-wide content-exchange service
transfer.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2013 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Thomas Voß <thomas.voss@canonical.com>
17  */
18 #ifndef COM_LOMIRI_CONTENT_TRANSFER_H_
19 #define COM_LOMIRI_CONTENT_TRANSFER_H_
20 
25 
26 #include <QObject>
27 #include <QSharedPointer>
28 #include <QVector>
29 #include <QString>
30 
31 namespace com
32 {
33 namespace lomiri
34 {
35 namespace content
36 {
37 namespace detail
38 {
39 class Handler;
40 }
41 }
42 }
43 }
44 
45 namespace com
46 {
47 namespace lomiri
48 {
49 namespace content
50 {
51 class Item;
52 
53 class Transfer : public QObject
54 {
55  Q_OBJECT
56  Q_ENUMS(State)
57  Q_ENUMS(SelectionType)
58  Q_ENUMS(Direction)
59  Q_PROPERTY(int id READ id)
60  Q_PROPERTY(State state READ state NOTIFY stateChanged)
61  Q_PROPERTY(QVector<Item> items READ collect WRITE charge)
62  Q_PROPERTY(Store store READ store NOTIFY storeChanged)
64  Q_PROPERTY(Direction direction READ direction)
65  Q_PROPERTY(QString downloadId READ downloadId WRITE setDownloadId NOTIFY downloadIdChanged)
66  Q_PROPERTY(QString contentType READ contentType)
67  Q_PROPERTY(QString source READ source)
68  Q_PROPERTY(QString destination READ destination)
69 
70  public:
71  enum State
72  {
82  };
83 
85  {
88  };
89 
90  enum Direction
91  {
95  };
96 
97  Transfer(const Transfer&) = delete;
98  virtual ~Transfer();
99 
100  Transfer& operator=(const Transfer&) = delete;
101 
102  Q_INVOKABLE virtual int id() const;
103  Q_INVOKABLE virtual State state() const;
104  Q_INVOKABLE virtual SelectionType selectionType() const;
105  Q_INVOKABLE virtual Direction direction() const;
106  Q_INVOKABLE virtual bool start();
107  Q_INVOKABLE virtual bool abort();
108  Q_INVOKABLE virtual bool finalize();
109  Q_INVOKABLE virtual bool charge(const QVector<Item>& items);
110  Q_INVOKABLE virtual QVector<Item> collect();
111  Q_INVOKABLE virtual Store store() const;
112  Q_DECL_DEPRECATED_X("Set store by scope and content type instead")
113  Q_INVOKABLE virtual bool setStore(const Store*);
114  Q_INVOKABLE virtual QString setStore(Scope, const QString&);
115  Q_INVOKABLE virtual bool setSelectionType(const SelectionType&);
116  Q_INVOKABLE virtual QString downloadId() const;
117  Q_INVOKABLE virtual bool setDownloadId(const QString);
118  Q_INVOKABLE virtual bool download();
119  Q_INVOKABLE virtual QString contentType() const;
120  Q_INVOKABLE virtual QString source() const;
121  Q_INVOKABLE virtual QString destination() const;
122 
123  Q_SIGNAL void stateChanged();
124  Q_SIGNAL void storeChanged();
125  Q_SIGNAL void selectionTypeChanged();
126  Q_SIGNAL void downloadIdChanged();
127 
128  private:
129  struct Private;
130  friend struct Private;
131  friend class Hub;
132  friend class com::lomiri::content::detail::Handler;
133  QSharedPointer<Private> d;
134 
135  Transfer(const QSharedPointer<Private>&, QObject* parent = nullptr);
136 };
137 }
138 }
139 }
140 
141 #endif // COM_LOMIRI_CONTENT_TRANSFER_H_
QObject
com::lomiri::content::Transfer::downloaded
@ downloaded
Definition: transfer.h:81
com::lomiri::content::Transfer::Export
@ Export
Definition: transfer.h:93
com::lomiri::content::Item
Definition: item.h:33
com::lomiri::content::Hub
Definition: hub.h:41
com::lomiri::content::Transfer::downloadId
QString downloadId
Definition: transfer.h:65
com::lomiri::content::Transfer::items
QVector< Item > items
Definition: transfer.h:61
com::lomiri::content::Transfer::storeChanged
Q_SIGNAL void storeChanged()
com::lomiri::content::Transfer::charge
virtual Q_INVOKABLE bool charge(const QVector< Item > &items)
com::lomiri::content::Transfer::id
int id
Definition: transfer.h:59
com::lomiri::content::Transfer::Private
friend struct Private
Definition: transfer.h:129
com::lomiri::content::Transfer::destination
QString destination
Definition: transfer.h:68
com::lomiri::content::Transfer::multiple
@ multiple
Definition: transfer.h:87
com::lomiri::content::Transfer::setStore
virtual Q_INVOKABLE bool setStore(const Store *)
com::lomiri::content::Transfer::downloading
@ downloading
Definition: transfer.h:80
com::lomiri::content::Transfer::operator=
Transfer & operator=(const Transfer &)=delete
com::lomiri::content::Transfer::setSelectionType
virtual Q_INVOKABLE bool setSelectionType(const SelectionType &)
com::lomiri::content::Transfer::Import
@ Import
Definition: transfer.h:92
com::lomiri::content::Transfer::SelectionType
SelectionType
Definition: transfer.h:84
com::lomiri::content::Transfer::aborted
@ aborted
Definition: transfer.h:78
com::lomiri::content::Transfer::source
QString source
Definition: transfer.h:67
com::lomiri::content::Transfer::Direction
Direction
Definition: transfer.h:90
com::lomiri::content::Transfer::State
State
Definition: transfer.h:71
type.h
com::lomiri::content::Scope
Scope
Definition: scope.h:29
com::lomiri::content::Transfer::contentType
QString contentType
Definition: transfer.h:66
com::lomiri::content::Transfer::collect
virtual Q_INVOKABLE QVector< Item > collect()
com::lomiri::content::Transfer::download
virtual Q_INVOKABLE bool download()
store.h
com::lomiri::content::Store
Definition: store.h:33
com::lomiri::content::Transfer::charged
@ charged
Definition: transfer.h:76
com::lomiri::content::Transfer::setDownloadId
virtual Q_INVOKABLE bool setDownloadId(const QString)
com::lomiri::content::Transfer::finalized
@ finalized
Definition: transfer.h:79
com::lomiri::content::Transfer::start
virtual Q_INVOKABLE bool start()
com::lomiri::content::Transfer::in_progress
@ in_progress
Definition: transfer.h:75
com::lomiri::content::Transfer::downloadIdChanged
Q_SIGNAL void downloadIdChanged()
scope.h
com::lomiri::content::Transfer::finalize
virtual Q_INVOKABLE bool finalize()
com::lomiri::content::Transfer::store
Store store
Definition: transfer.h:62
com::lomiri::content::Transfer::~Transfer
virtual ~Transfer()
com::lomiri::content::Transfer::created
@ created
Definition: transfer.h:73
com
Definition: hub.h:31
com::lomiri::content::Transfer::state
State state
Definition: transfer.h:60
com::lomiri::content::Transfer
Definition: transfer.h:53
com::lomiri::content::Transfer::Share
@ Share
Definition: transfer.h:94
com::lomiri::content::Transfer::single
@ single
Definition: transfer.h:86
com::lomiri::content::Transfer::Transfer
Transfer(const Transfer &)=delete
com::lomiri::content::Transfer::selectionType
SelectionType selectionType
Definition: transfer.h:63
com::lomiri::content::Transfer::collected
@ collected
Definition: transfer.h:77
com::lomiri::content::Transfer::initiated
@ initiated
Definition: transfer.h:74
com::lomiri::content::Transfer::abort
virtual Q_INVOKABLE bool abort()
com::lomiri::content::Transfer::direction
Direction direction
Definition: transfer.h:64
com::lomiri::content::Transfer::selectionTypeChanged
Q_SIGNAL void selectionTypeChanged()
com::lomiri::content::Transfer::stateChanged
Q_SIGNAL void stateChanged()
item.h