dom_document.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_core.h"
#include "dom_node.h"
#include <vector>

class CL_IODevice;
class CL_DomDocumentType;
class CL_DomImplementation;
class CL_DomCDATASection;
class CL_DomProcessingInstruction;
class CL_DomElement;
class CL_DomDocumentFragment;
class CL_DomComment;
class CL_DomText;
class CL_DomAttr;
class CL_DomEntityReference;
class CL_DomNodeList;
class CL_DomDocument_Generic;

class CL_API_CORE CL_DomDocument : public CL_DomNode
{

public:
        CL_DomDocument();

        CL_DomDocument(CL_IODevice &input, bool eat_whitespace = true);

        CL_DomDocument(
                const CL_DomString &namespace_uri,
                const CL_DomString &qualified_name,
                const CL_DomDocumentType &doctype);

        CL_DomDocument(const CL_SharedPtr<CL_DomNode_Generic> &impl);

        ~CL_DomDocument();


public:

        CL_DomDocumentType get_doctype();

        CL_DomImplementation get_implementation();


        CL_DomElement get_document_element();


public:

        CL_DomElement create_element(const CL_DomString &tag_name);

        CL_DomElement create_element_ns(
                const CL_DomString &namespace_uri,
                const CL_DomString &qualified_name);

        CL_DomDocumentFragment create_document_fragment();

        CL_DomText create_text_node(const CL_DomString &data);

        CL_DomComment create_comment(const CL_DomString &data);

        CL_DomCDATASection create_cdata_section(const CL_DomString &data);

        CL_DomProcessingInstruction create_processing_instruction(
                const CL_DomString &target,
                const CL_DomString &data);


        CL_DomAttr create_attribute(const CL_DomString &name);


        CL_DomAttr create_attribute_ns(
                const CL_DomString &namespace_uri,
                const CL_DomString &qualified_name);

        CL_DomEntityReference create_entity_reference(const CL_DomString &name);


        CL_DomNodeList get_elements_by_tag_name(const CL_DomString &tag_name);


        CL_DomNodeList get_elements_by_tag_name_ns(
                const CL_DomString &namespace_uri,
                const CL_DomString &qualified_name);

        CL_DomElement get_element_by_id(const CL_DomString &element_id);


        CL_DomNode import_node(
                const CL_DomNode &node,
                bool deep);

        std::vector<CL_DomNode> load(
                CL_IODevice &input,
                bool eat_whitespace = true,
                CL_DomNode insert_point = CL_DomNode());

        void save(CL_IODevice &output, bool insert_whitespace = true);

        void clear_all();


private:
};

---