XmlComment.h

Go to the documentation of this file.

/*********************************************************\
 *  File: XmlComment.h                                   *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLCORE_XML_COMMENT_H__
#define __PLCORE_XML_COMMENT_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLCore/Xml/XmlNode.h"


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLCore {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    XML comment node
*/
class XmlComment : public XmlNode {


    //[-------------------------------------------------------]
    //[ Friends                                               ]
    //[-------------------------------------------------------]
    friend class XmlNode;


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Default constructor
        */
        PLCORE_API XmlComment();

        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] sValue
        *    Value of this text node
        */
        PLCORE_API XmlComment(const String &sValue);

        /**
        *  @brief
        *    Copy constructor
        *
        *  @param[in] cSource
        *    Source to copy from
        */
        PLCORE_API XmlComment(const XmlComment &cSource);

        /**
        *  @brief
        *    Destructor
        */
        PLCORE_API virtual ~XmlComment();

        /**
        *  @brief
        *    Copy operator
        *
        *  @param[in] cSource
        *    Source to copy from
        *
        *  @return
        *    Reference to this instance
        */
        inline XmlComment &operator =(const XmlComment &cSource);


    //[-------------------------------------------------------]
    //[ Public virtual XmlBase functions                      ]
    //[-------------------------------------------------------]
    public:
        PLCORE_API virtual bool Save(File &cFile, uint32 nDepth = 0) override;
        PLCORE_API virtual String ToString(uint32 nDepth = 0) const override;
        PLCORE_API virtual const char *Parse(const char *pszData, XmlParsingData *pData = nullptr, EEncoding nEncoding = EncodingUnknown) override;


    //[-------------------------------------------------------]
    //[ Public virtual XmlNode functions                      ]
    //[-------------------------------------------------------]
    public:
        PLCORE_API virtual XmlNode *Clone() const override;


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLCore


//[-------------------------------------------------------]
//[ Implementation                                        ]
//[-------------------------------------------------------]
#include "PLCore/Xml/XmlComment.inl"


#endif // __PLCORE_XML_COMMENT_H__