Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 128 insertions, 0 deletions

diff --git a/kabc/agent.h b/kabc/agent.h
new file mode 100644
index 000000000..a235e0247
--- /dev/null
+++ b/kabc/agent.h
@@ -0,0 +1,128 @@
+/*
+    This file is part of libkabc.
+    Copyright (c) 2002 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 KABC_AGENT_H
+#define KABC_AGENT_H
+
+class QDataStream;
+
+#include <qstring.h>
+
+#include <kdelibs_export.h>
+
+namespace KABC {
+
+class Addressee;
+
+/**
+ * Important!!!
+ *
+ * At the moment the vcard format does not support saving and loading
+ * this entity.
+ */
+class KABC_EXPORT Agent
+{
+  friend KABC_EXPORT QDataStream &operator<<( QDataStream &, const Agent & );
+  friend KABC_EXPORT QDataStream &operator>>( QDataStream &, Agent & );
+
+public:
+
+  /**
+   * Consturctor. Creates an empty object.
+   */
+  Agent();
+
+  /**
+   * Consturctor.
+   *
+   * @param url  A URL that describes the position of the agent file.
+   */
+  Agent( const QString &url );
+
+  /**
+   * Consturctor.
+   *
+   * @param addressee  The addressee object of the agent.
+   */
+  Agent( Addressee *addressee );
+
+  /**
+   * Destructor.
+   */
+  ~Agent();
+
+
+  bool operator==( const Agent & ) const;
+  bool operator!=( const Agent & ) const;
+  Agent &operator=(  const Agent & );
+  
+  /**
+   * Sets a URL for the location of the agent file. When using this
+   * function, isIntern() will return 'false' until you use
+   * setAddressee().
+   *
+   * @param url  The location URL of the agent file.
+   */
+  void setUrl( const QString &url );
+
+  /**
+   * Sets the addressee of the agent. When using this function,
+   * isIntern() will return 'true' until you use setUrl().
+   *
+   * @param addressee  The addressee object of the agent.
+   */
+  void setAddressee( Addressee *addressee );
+
+  /**
+   * Returns whether the agent is described by a URL (extern) or
+   * by a addressee (intern).
+   * When this method returns 'true' you can use addressee() to
+   * get a Addressee object. Otherwise you can request the URL
+   * of this agent by url() and load the data from that location.
+   */
+  bool isIntern() const;
+
+  /**
+   * Returns the location URL of this agent.
+   */
+  QString url() const;
+
+  /**
+   * Returns the addressee object of this agent.
+   */
+  Addressee* addressee() const;
+
+  /**
+   * Returns string representation of the agent.
+   */
+  QString asString() const;
+
+private:
+  Addressee *mAddressee;
+  QString mUrl;
+
+  int mIntern;
+};
+
+KABC_EXPORT QDataStream &operator<<( QDataStream &, const Agent & );
+KABC_EXPORT QDataStream &operator>>( QDataStream &, Agent & );
+
+}
+#endif