dataform.h

/*
  Copyright (c) 2005-2008 by Jakob Schroeter <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 "dataformbase.h"

#include <string>
#include <list>

namespace gloox
{

  class Tag;

  class GLOOX_API DataForm : public DataFormBase
  {
    public:
      enum DataFormType
      {
        FormTypeForm,        
        FormTypeSubmit,      
        FormTypeCancel,      
        FormTypeResult,      
        FormTypeInvalid      
      };

      DataForm( DataFormType type, const StringList& instructions, const std::string& title = "" );

      DataForm( DataFormType type, const std::string& title = "" );

      DataForm( Tag *tag );

      DataForm();

      virtual ~DataForm();

      Tag* tag() const;

      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; }

      DataForm::DataFormType type() const { return m_type; }

      bool parse( Tag *tag );

    private:
      StringList m_instructions;

      DataFormType m_type;
      std::string m_title;
  };

}

#endif // DATAFORM_H__