summaryrefslogtreecommitdiffstats
path: root/kitchensync/libqopensync/member.h
diff options
context:
space:
mode:
Diffstat (limited to 'kitchensync/libqopensync/member.h')
-rw-r--r--kitchensync/libqopensync/member.h129
1 files changed, 129 insertions, 0 deletions
diff --git a/kitchensync/libqopensync/member.h b/kitchensync/libqopensync/member.h
new file mode 100644
index 000000000..d0d883db3
--- /dev/null
+++ b/kitchensync/libqopensync/member.h
@@ -0,0 +1,129 @@
+/*
+ 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_MEMBER_H
+#define QSYNC_MEMBER_H
+
+#include <libqopensync/plugin.h>
+#include <libqopensync/result.h>
+#include <libqopensync/plugin.h>
+
+class OSyncMember;
+
+namespace QSync {
+
+class Member
+{
+ friend class Group;
+ friend class SyncChange;
+ friend class SyncMemberUpdate;
+
+ public:
+ Member();
+ ~Member();
+
+ /**
+ Returns whether the member object is valid.
+ */
+ bool isValid() const;
+
+ /**
+ Returns the configuration directory.
+ */
+ QString configurationDirectory() const;
+
+ /**
+ Returns the name of the plugin, the member belongs to.
+ */
+ QString pluginName() const;
+
+ /**
+ Returns the plugin, the member belongs to.
+ */
+ Plugin plugin() const;
+
+ /**
+ Returns the id of the plugin.
+ */
+ int id() const;
+
+ /**
+ Sets the name of this member.
+ */
+ void setName( const QString &name );
+
+ /**
+ Returns the name of this member.
+ */
+ QString name() const;
+
+ /**
+ Sets the configuration data as byte array. The developer has to decide the
+ type of the data ( e.g. xml, plain text, binary ).
+ */
+ void setConfiguration( const QByteArray &configurationData );
+
+ /**
+ Gets the configuration data as byte array. The developer has to decide the
+ type of the data ( e.g. xml, plain text, binary ).
+
+ @param useDefault If set to true, return default config, if no config
+ exists. If set to false, return error when no config
+ exists.
+
+ @returns The result of this operation.
+ */
+ Result configuration( QByteArray &configurationData,
+ bool useDefault = true );
+
+ /**
+ Saves the changes to the configuration to hard disc.
+ */
+ Result save();
+
+ /**
+ Make this member an instance of the given plugin.
+ */
+ Result instance( const Plugin & );
+
+ bool operator==( const Member& ) const;
+
+ /**
+ This method can be used to query the plugin for scanning devices.
+ The @param query is a plugin specific xml document as well as
+ the return value.
+ */
+ QString scanDevices( const QString &query );
+
+ /**
+ This method can be used to test whether the plugin can connect
+ to the device with the given configuration.
+ */
+ bool testConnection( const QString &configuration );
+
+ private:
+ OSyncMember *mMember;
+};
+
+}
+
+#endif
+