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

/*
  Copyright (c) 2007-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 XHTMLIM_H__
#define XHTMLIM_H__

#include "jid.h"
#include "stanzaextension.h"
#include "tag.h"

#include <string>

namespace gloox
{

  class Tag;

  /**
   * @brief This is a wrapper of an XHTML-IM (@xep{0071}) message body.
   *
   * @author Jakob Schröter <js@camaya.net>
   * @since 1.0
   */
  class GLOOX_API XHtmlIM : public StanzaExtension
  {

    public:
      /**
       * Constructs a new object with the given resource string.
       * @param xhtml XHTML to include.
       */
      XHtmlIM( const Tag* xhtml = 0 );

      /**
       * Virtual Destructor.
       */
      virtual ~XHtmlIM();

      /**
       * Returns a pointer to the internally stored XHTML, as opposed to tag(),
       * which returns a copy (which you need to delete manually).
       * @return A pointer to the XHTML. Do not delete this Tag.
       */
      const Tag* xhtml() const { return m_xhtml; }

      // reimplemented from StanzaExtension
      virtual const std::string& filterString() const;

      // reimplemented from StanzaExtension
      virtual StanzaExtension* newInstance( const Tag* tag ) const
      {
        return new XHtmlIM( tag );
      }

      // reimplemented from StanzaExtension
      virtual Tag* tag() const;

      // reimplemented from StanzaExtension
      virtual StanzaExtension* clone() const;

    private:
      Tag* m_xhtml;

  };

}

#endif // XHTMLIM_H__