Swiften/Elements/Form.h

/*
 * Copyright (c) 2010 Kevin Smith
 * Licensed under the GNU General Public License v3.
 * See Documentation/Licenses/GPLv3.txt 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 {
  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) {}

      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 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 addItem(const FormItem& item);
      const std::vector<FormItem>& getItems() const;
    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_;
  };
}