move files common to client/server into "base"

1 files changed, 140 insertions, 0 deletions

diff --git a/src/base/QXmppDataForm.h b/src/base/QXmppDataForm.h
new file mode 100644
index 00000000..4f38a932
--- /dev/null
+++ b/src/base/QXmppDataForm.h
@@ -0,0 +1,140 @@
+/*
+ * Copyright (C) 2008-2011 The QXmpp developers
+ *
+ * Author:
+ *  Jeremy Lainé
+ *
+ * Source:
+ *  http://code.google.com/p/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 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
+ * Lesser General Public License for more details.
+ *
+ */
+
+#ifndef QXMPPDATAFORM_H
+#define QXMPPDATAFORM_H
+
+#include <QPair>
+#include <QString>
+#include <QVariant>
+#include <QXmlStreamWriter>
+
+class QDomElement;
+
+/// \brief The QXmppDataForm class represents a data form as defined by
+/// XEP-0004: Data Forms.
+///
+
+class QXmppDataForm
+{
+public:
+    /// \brief The QXmppDataForm::Field class represents a data form field
+    /// as defined by XEP-0004: Data Forms.
+    ///
+
+    class Field
+    {
+    public:
+        /// This enum is used to describe a field's type.
+        enum Type
+        {
+            BooleanField,
+            FixedField,
+            HiddenField,
+            JidMultiField,
+            JidSingleField,
+            ListMultiField,
+            ListSingleField,
+            TextMultiField,
+            TextPrivateField,
+            TextSingleField,
+        };
+
+        Field(QXmppDataForm::Field::Type type = QXmppDataForm::Field::TextSingleField);
+
+        QString description() const;
+        void setDescription(const QString &description);
+
+        QString key() const;
+        void setKey(const QString &key);
+
+        QString label() const;
+        void setLabel(const QString &label);
+
+        QList<QPair<QString, QString> > options() const;
+        void setOptions(const QList<QPair<QString, QString> > &options);
+
+        bool isRequired() const;
+        void setRequired(bool required);
+
+        QXmppDataForm::Field::Type type() const;
+        void setType(QXmppDataForm::Field::Type type);
+
+        QVariant value() const;
+        void setValue(const QVariant &value);
+
+    private:
+        QString m_description;
+        QString m_key;
+        QString m_label;
+        QList<QPair<QString, QString> > m_options;
+        bool m_required;
+        QXmppDataForm::Field::Type m_type;
+        QVariant m_value;
+    };
+
+    /// This enum is used to describe a form's type.
+    enum Type
+    {
+        None,   ///< Unknown form type
+        Form,   ///< The form-processing entity is asking the form-submitting
+                ///< entity to complete a form.
+        Submit, ///< The form-submitting entity is submitting data to the
+                ///< form-processing entity.
+        Cancel, ///< The form-submitting entity has cancelled submission
+                ///< of data to the form-processing entity.
+        Result, ///< The form-processing entity is returning data
+                ///< (e.g., search results) to the form-submitting entity,
+                ///< or the data is a generic data set.
+    };
+
+    QXmppDataForm(QXmppDataForm::Type type = QXmppDataForm::None);
+
+    QString instructions() const;
+    void setInstructions(const QString &instructions);
+
+    QList<Field> fields() const;
+    QList<Field> &fields();
+    void setFields(const QList<QXmppDataForm::Field> &fields);
+
+    QString title() const;
+    void setTitle(const QString &title);
+
+    QXmppDataForm::Type type() const;
+    void setType(QXmppDataForm::Type type);
+
+    bool isNull() const;
+
+    /// \cond
+    void parse(const QDomElement &element);
+    void toXml(QXmlStreamWriter *writer) const;
+    /// \endcond
+
+private:
+    QString m_instructions;
+    QList<Field> m_fields;
+    QString m_title;
+    QXmppDataForm::Type m_type;
+};
+
+#endif