Chat-O-Matic/libs/libgloox/dataformreported.h

/*
  Copyright (c) 2005-2015 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 DATAFORMREPORTED_H__
#define DATAFORMREPORTED_H__

#include "dataformfieldcontainer.h"

namespace gloox
{

  class Tag;

  /**
   * @brief An abstraction of a &lt;reported&gt; element in a @xep{0004} Data Form of type result.
   *
   * There are some constraints regarding usage of this element you should be aware of. Check @xep{0004}
   * section 3.4. This class does not enforce correct usage at this point.
   *
   * @author Jakob Schröter <js@camaya.net>
   * @since 0.7
   */
  class GLOOX_API DataFormReported : public DataFormFieldContainer
  {
    public:
      /**
       * Creates an empty 'reported' element you can add fields to.
       */
      DataFormReported();

      /**
       * Creates a 'reported' element and fills it with the 'field' elements contained in the given Tag.
       * The Tag's root element must be a 'reported' element. Its child element should be 'field' elements.
       * @param tag The tag to read the 'field' elements from.
       * @since 0.8.5
       */
      DataFormReported( Tag* tag );

      /**
       * Virtual destructor.
       */
      virtual ~DataFormReported();

      /**
       * Creates and returns a Tag representation of the current object.
       * @return A Tag representation of the current object.
       */
      virtual Tag* tag() const;

  };

}

#endif // DATAFORMREPORTED_H__