GXmlText.hpp

Go to the documentation of this file.

/***************************************************************************
 *                   GXmlText.hpp - XML text node class                    *
 * ----------------------------------------------------------------------- *
 *  copyright (C) 2010-2015 by Juergen Knoedlseder                         *
 * ----------------------------------------------------------------------- *
 *                                                                         *
 *  This program is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU General Public License as published by   *
 *  the Free Software Foundation, either version 3 of the License, or      *
 *  (at your option) any later version.                                    *
 *                                                                         *
 *  This program 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 General Public License for more details.                           *
 *                                                                         *
 *  You should have received a copy of the GNU General Public License      *
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.  *
 *                                                                         *
 ***************************************************************************/
/**
 * @file GXmlText.hpp
 * @brief XML text node class interface definition
 * @author Juergen Knoedlseder
 */

#ifndef GXMLTEXT_HPP
#define GXMLTEXT_HPP

/* __ Includes ___________________________________________________________ */
#include <string>
#include "GUrl.hpp"
#include "GXmlNode.hpp"


/***********************************************************************//**
 * @class GXmlText
 *
 * @brief XML text node class
 *
 * This class implements a text segment of a XML document.
 ***************************************************************************/
class GXmlText : public GXmlNode {

public:
    // Constructors and destructors
    GXmlText(void);
    GXmlText(const GXmlText& node);
    explicit GXmlText(const std::string& text);
    virtual ~GXmlText(void);

    // Operators
    GXmlText& operator=(const GXmlText& node);

    // Implemented pure virtual base class methods
    virtual void        clear(void);
    virtual GXmlText*   clone(void) const;
    virtual std::string classname(void) const;
    virtual void        write(GUrl& url, const int& indent = 0) const;
    virtual NodeType    type(void) const;
    virtual std::string print(const GChatter& chatter = NORMAL,
                              const int&      indent = 0) const;

    // Other methods
    const std::string&  text(void) const;
    void                text(const std::string& text);

protected:
    // Protected methods
    void init_members(void);
    void copy_members(const GXmlText& node);
    void free_members(void);

    // Protected data members
    std::string m_text;       //!< Text
};


/***********************************************************************//**
 * @brief Return class name
 *
 * @return String containing the class name ("GXmlText").
 ***************************************************************************/
inline
std::string GXmlText::classname(void) const
{
    return ("GXmlText");
}


/***********************************************************************//**
 * @brief Return text
 *
 * @return Text string.
 ***************************************************************************/
inline
const std::string& GXmlText::text(void) const
{
    return (m_text);
}


/***********************************************************************//**
 * @brief Set text
 *
 * @param[in] text Text string.
 ***************************************************************************/
inline
void GXmlText::text(const std::string& text)
{
    m_text = text;
    return;
}


/***********************************************************************//**
 * @brief Return XML node type
 *
 * @return XML node type (NT_TEXT).
 ***************************************************************************/
inline
GXmlNode::NodeType GXmlText::type(void) const
{
    return (NT_TEXT);
}

#endif /* GXMLTEXT_HPP */