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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
/*
This file is part of libqopensync.
Copyright (c) 2005 Tobias Koenig <tokoe@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef QSYNC_GROUP_H
#define QSYNC_GROUP_H
#include <qdatetime.h>
#include <qstringlist.h>
#include <libqopensync/filter.h>
#include <libqopensync/member.h>
class OSyncGroup;
namespace QSync {
/**
@internal
*/
class GroupConfig
{
friend class Group;
public:
GroupConfig();
QStringList activeObjectTypes() const;
void setActiveObjectTypes( const QStringList &objectTypes );
private:
OSyncGroup *mGroup;
};
class Group
{
friend class Engine;
friend class Environment;
public:
enum LockType
{
LockOk,
Locked,
LockStale
};
Group();
~Group();
/**
Returns whether the object is a valid group.
*/
bool isValid() const;
class Iterator
{
friend class Group;
public:
Iterator( Group *group )
: mGroup( group ), mPos( -1 )
{
}
Iterator( const Iterator &it )
{
mGroup = it.mGroup;
mPos = it.mPos;
}
Member operator*()
{
return mGroup->memberAt( mPos );
}
Iterator &operator++() { mPos++; return *this; }
Iterator &operator++( int ) { mPos++; return *this; }
Iterator &operator--() { mPos--; return *this; }
Iterator &operator--( int ) { mPos--; return *this; }
bool operator==( const Iterator &it ) { return mGroup == it.mGroup && mPos == it.mPos; }
bool operator!=( const Iterator &it ) { return mGroup == it.mGroup && mPos != it.mPos; }
private:
Group *mGroup;
int mPos;
};
/**
Returns an iterator pointing to the first item in the member list.
This iterator equals end() if the member list is empty.
*/
Iterator begin();
/**
Returns an iterator pointing past the last item in the member list.
This iterator equals begin() if the member list is empty.
*/
Iterator end();
/**
Sets the name of the group.
*/
void setName( const QString &name );
/**
Returns the name of the group.
*/
QString name() const;
/**
Sets the time of the last successfull synchronization.
*/
void setLastSynchronization( const QDateTime &dateTime );
/**
Returns the time of the last successfull synchronization.
*/
QDateTime lastSynchronization() const;
/**
Locks the group.
@returns The the result of the locking request.
*/
LockType lock();
/**
Unlocks the group.
@param removeFile Whether the lock file shall be removed.
*/
void unlock( bool removeFile = true );
/**
Adds a new member to the group.
@returns the new member.
*/
Member addMember();
/**
Removes a member from the group.
*/
void removeMember( const Member &member );
/**
Returns the number of members.
*/
int memberCount() const;
/**
Returns the member at position @param pos.
*/
Member memberAt( int pos ) const;
/**
Returns the number of filters.
*/
int filterCount() const;
/**
Returns the filter at position @param pos.
*/
Filter filterAt( int pos );
/**
Set, if the object type with given name is enabled for synchronisation for
this group.
*/
void setObjectTypeEnabled( const QString &objectType, bool enabled );
/**
Returns whether the object type with given name is enabled for synchronisation for
this group.
*/
bool isObjectTypeEnabled( const QString &objectType ) const;
/**
Saves the configuration to hard disc.
*/
Result save();
/**
Returns the config object of this group.
Note: This method is only available for OpenSync 0.19 and 0.20.
*/
GroupConfig config() const;
bool operator==( const Group &group ) const { return mGroup == group.mGroup; }
private:
OSyncGroup *mGroup;
};
}
#endif
|
