Otclient  14/8/2020
otmldocument.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010-2020 OTClient <https://github.com/edubart/otclient>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 #ifndef OTMLDOCUMENT_H
24 #define OTMLDOCUMENT_H
25 
26 #include "otmlnode.h"
27 
28 class OTMLDocument : public OTMLNode
29 {
30 public:
31  virtual ~OTMLDocument() { }
32 
34  static OTMLDocumentPtr create();
35 
37  static OTMLDocumentPtr parse(const std::string& fileName);
38 
41  static OTMLDocumentPtr parse(std::istream& in, const std::string& source);
42 
44  std::string emit();
45 
47  bool save(const std::string& fileName);
48 
49 private:
50  OTMLDocument() { }
51 };
52 
53 #endif
OTMLNode::source
std::string source()
Definition: otmlnode.h:38
OTMLNode
Definition: otmlnode.h:28
OTMLDocument::~OTMLDocument
virtual ~OTMLDocument()
Definition: otmldocument.h:31
OTMLDocument::create
static OTMLDocumentPtr create()
Create a new OTML document for filling it with nodes.
Definition: otmldocument.cpp:29
OTMLDocument::parse
static OTMLDocumentPtr parse(const std::string &fileName)
Parse OTML from a file.
Definition: otmldocument.cpp:36
OTMLDocument::save
bool save(const std::string &fileName)
Save this document to a file.
Definition: otmldocument.cpp:58
OTMLDocument::emit
std::string emit()
Emits this document and all it's children to a std::string.
Definition: otmldocument.cpp:53
otmlnode.h
stdext::shared_object_ptr< OTMLDocument >
OTMLDocument
Definition: otmldocument.h:28