summaryrefslogtreecommitdiffstats
blob: 42fe7ed1cb04185d46e974da70fb9203af8ea25a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
/*
 * Copyright (c) 2010-2014 Isode Limited.
 * All rights reserved.
 * See the COPYING file for more information.
 */

#pragma once

#include <vector>
#include <string>

#include <Swiften/Base/API.h>
#include <Swiften/Elements/Payload.h>
#include <Swiften/Elements/FormField.h>
#include <Swiften/JID/JID.h>

namespace Swift {
	/**
	 * XEP-0004 Data form.
	 * For the relevant Fields, the parsers and serialisers protect the API user against
	 * the strange multi-value instead of newline thing by transforming them.
	 */
	class SWIFTEN_API Form : public Payload {
		public:
			typedef boost::shared_ptr<Form> ref;
			typedef std::vector<FormField::ref> FormItem;

			enum Type { FormType, SubmitType, CancelType, ResultType };

		public:
			Form(Type type = FormType) : type_(type) {}

			/** Add a field to the form.
			 * @param field New field - must not be null.
			 */
			void addField(boost::shared_ptr<FormField> field) {assert(field);  fields_.push_back(field); }
			const std::vector<boost::shared_ptr<FormField> >& getFields() const { return fields_; }
			void clearFields() { fields_.clear(); }
			void setTitle(const std::string& title) { title_ = title; }
			const std::string& getTitle() const { return title_; }

			void setInstructions(const std::string& instructions) { instructions_ = instructions; }
			const std::string& getInstructions() const { return instructions_; }

			Type getType() const { return type_; }
			void setType(Type type) { type_ = type; }

			std::string getFormType() const;

			FormField::ref getField(const std::string& name) const;

			void addReportedField(FormField::ref field);
			const std::vector<FormField::ref>& getReportedFields() const;
			void clearReportedFields() { reportedFields_.clear(); }

			void addItem(const FormItem& item);
			const std::vector<FormItem>& getItems() const;
			void clearItems() { items_.clear(); }

			void clearEmptyTextFields();

		private:
			std::vector<boost::shared_ptr<FormField> > fields_;
			std::vector<boost::shared_ptr<FormField> > reportedFields_;
			std::vector<FormItem> items_;
			std::string title_;
			std::string instructions_;
			Type type_;
	};
}