dataform.h

/*
  Copyright (c) 2005-2023 by Jakob Schröter <js@camaya.net>
  This file is part of the gloox library. http://camaya.net/gloox
 
  This software is distributed under a license. The full license
  agreement can be found in the file LICENSE in this distribution.
  This software may not be copied, modified, sold or distributed
  other than expressed in the named license agreement.
 
  This software is distributed without any warranty.
*/
 
 
#ifndef DATAFORM_H__
#define DATAFORM_H__
 
#include "dataformfieldcontainer.h"
#include "adhocplugin.h"
 
#include <string>
#include <list>
 
namespace gloox
{
 
  class Tag;
  class DataFormItem;
  class DataFormReported;

  enum FormType
  {
    TypeForm,                     
    TypeSubmit,                   
    TypeCancel,                   
    TypeResult,                   
    TypeInvalid                   
  };

  class GLOOX_API DataForm : public AdhocPlugin, public DataFormFieldContainer
  {
    public:
      typedef std::list<DataFormItem*> ItemList;

      DataForm( FormType type, const StringList& instructions, const std::string& title = EmptyString );

      DataForm( FormType type, const std::string& title = EmptyString );

      DataForm( const Tag* tag );

      DataForm( const DataForm& form );

      virtual ~DataForm();

      const std::string& title() const { return m_title; }

      void setTitle( const std::string& title ) { m_title = title; }

      const StringList& instructions() const { return m_instructions; }

      void setInstructions( const StringList& instructions ) { m_instructions = instructions; }

      const DataFormReported* reported() const { return m_reported; }

      const ItemList& items() const { return m_items; }

      FormType type() const { return m_type; }

      void setType( FormType type ) { m_type = type; }

      bool parse( const Tag* tag );

      operator bool() const { return m_type != TypeInvalid; }
 
      // reimplemented from StanzaExtension
      virtual const std::string& filterString() const;
 
      // reimplemented from StanzaExtension
      virtual StanzaExtension* newInstance( const Tag* tag ) const
      {
        return new DataForm( tag );
      }
 
      // reimplemented from StanzaExtension
      virtual Tag* tag() const;
 
      // reimplemented from StanzaExtension
      virtual StanzaExtension* clone() const
      {
        return new DataForm( *this );
      }
 
    protected:
      FormType m_type;
 
    private:
      StringList m_instructions;
 
      std::string m_title;
      DataFormReported* m_reported;
      ItemList m_items;
 
  };
 
}
 
#endif // DATAFORM_H__