aboutsummaryrefslogtreecommitdiff
path: root/src/QXmppDataForm.h
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2010-08-11 07:31:23 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2010-08-11 07:31:23 +0000
commit40c39853816cfab113d79682c34bc76a2c79c357 (patch)
treee4d6a184cf565cb87477339ce738299ff9787bc3 /src/QXmppDataForm.h
parent551c284e35280b7b91a939fe7352e496ffea402a (diff)
downloadqxmpp-40c39853816cfab113d79682c34bc76a2c79c357.tar.gz
rename "source" directory to "src"
Diffstat (limited to 'src/QXmppDataForm.h')
-rw-r--r--src/QXmppDataForm.h127
1 files changed, 127 insertions, 0 deletions
diff --git a/src/QXmppDataForm.h b/src/QXmppDataForm.h
new file mode 100644
index 00000000..813c35eb
--- /dev/null
+++ b/src/QXmppDataForm.h
@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2008-2010 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:
+ class Field
+ {
+ public:
+ 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;
+ };
+
+ enum Type
+ {
+ None,
+ Form,
+ Submit,
+ Cancel,
+ Result,
+ };
+
+ 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;
+
+ void parse(const QDomElement &element);
+ void toXml(QXmlStreamWriter *writer) const;
+
+private:
+ QString m_instructions;
+ QList<Field> m_fields;
+ QString m_title;
+ QXmppDataForm::Type m_type;
+};
+
+#endif