diff options
Diffstat (limited to 'kitchensync/libqopensync/group.h')
| -rw-r--r-- | kitchensync/libqopensync/group.h | 217 |
1 files changed, 0 insertions, 217 deletions
diff --git a/kitchensync/libqopensync/group.h b/kitchensync/libqopensync/group.h deleted file mode 100644 index fe9ceaeb..00000000 --- a/kitchensync/libqopensync/group.h +++ /dev/null @@ -1,217 +0,0 @@ -/* - 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 TQSYNC_GROUP_H -#define TQSYNC_GROUP_H - -#include <tqdatetime.h> -#include <tqstringlist.h> - -#include <libqopensync/filter.h> -#include <libqopensync/member.h> - -class OSyncGroup; - -namespace QSync { - -/** - @internal - */ -class GroupConfig -{ - friend class Group; - - public: - GroupConfig(); - - TQStringList activeObjectTypes() const; - void setActiveObjectTypes( const TQStringList &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 TQString &name ); - - /** - Returns the name of the group. - */ - TQString name() const; - - /** - Sets the time of the last successfull synchronization. - */ - void setLastSynchronization( const TQDateTime &dateTime ); - - /** - Returns the time of the last successfull synchronization. - */ - TQDateTime 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 TQString &objectType, bool enabled ); - - /** - Returns whether the object type with given name is enabled for synchronisation for - this group. - */ - bool isObjectTypeEnabled( const TQString &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 |