Class: exml::Document

Synopsis:

+                         Document                     (void);
+                        ~Document                     (void);
+  void                   setCharset                   (enum unicode::charset _charset);
+  enum unicode::charset  getCharset                   (void);
+  void                   setCaseSensitive             (bool _val);
+  bool                   getCaseSensitive             (void);
+  bool                   parse                        (const std::string & _data);
+  bool                   parse                        (const std::u32string & _data);
+  bool                   generate                     (std::string & _data);
+  bool                   generate                     (std::u32string & _data);
+  bool                   load                         (const std::string & _file);
+  bool                   load                         (const std::u32string & _file);
+  bool                   store                        (const std::string & _file);
+  bool                   store                        (const std::u32string & _file);
+  void                   display                      (void);
+  void                   displayErrorWhenDetected     (void);
+  void                   notDisplayErrorWhenDetected  (void);
+  void                   createError                  (const std::string & _data,
                                                        int32_t _pos,
                                                        const exml::filePos & _filePos,
                                                        const std::string & _comment);
+  void                   displayError                 (void);
+  enum nodeType          getType                      (void);
+  bool                   iGenerate                    (std::string & _data,
                                                        int32_t _indent);
+  exml::Document *       toDocument                   (void);
+  const exml::Document * toDocument                   (void);

Object Hierarchy:

AttributeList
    +--> exml::Element
        +--> exml::Document

Detail:

exml::Document ()

Document(void);

Constructor

---

exml::~Document ()

~Document(void);

Destructor

---

setCharset ()

void setCharset(enum unicode::charset _charset);

get the current charset of the Parsing

Parameter [input]: _charset The new charset

---

getCharset ()

enum unicode::charset getCharset(void);

get the current charset of the Parsing

Return: The current charset

---

setCaseSensitive ()

void setCaseSensitive(bool _val);

Enable or diasable the case sensitive (must be done before the call of parsing)

Parameter [input]: _val true if enable; false else.

---

getCaseSensitive ()

bool getCaseSensitive(void);

get the status of case sensitive mode.

Return: true if case sensitive is active

---

parse ()

bool parse(const std::string & _data);

parse a string that contain an XML

Parameter [input]: _data Data to parse
Return: false : An error occured
Return: true : Parsing is OK

---

parse ()

bool parse(const std::u32string & _data);

---

generate ()

bool generate(std::string & _data);

generate a string that contain the created XML

Parameter [output]: _data Data where the xml is stored
Return: false : An error occured
Return: true : Parsing is OK

---

generate ()

bool generate(std::u32string & _data);

---

load ()

bool load(const std::string & _file);

Load the file that might contain the xml

Parameter [input]: _file Filename of the xml (compatible with etk FSNode naming)
Return: false : An error occured
Return: true : Parsing is OK

---

load ()

bool load(const std::u32string & _file);

---

store ()

bool store(const std::string & _file);

Store the Xml in the file

Parameter [input]: _file Filename of the xml (compatible with etk FSNode naming)
Return: false : An error occured
Return: true : Parsing is OK

---

store ()

bool store(const std::u32string & _file);

---

display ()

void display(void);

Display the Document on console

---

displayErrorWhenDetected ()

void displayErrorWhenDetected(void);

---

notDisplayErrorWhenDetected ()

void notDisplayErrorWhenDetected(void);

---

createError ()

void createError(const std::string & _data,
                 int32_t _pos,
                 const exml::filePos & _filePos,
                 const std::string & _comment);

---

displayError ()

void displayError(void);

---

getType ()

enum nodeType getType(void);

---

iGenerate ()

bool iGenerate(std::string & _data,
               int32_t _indent);

---

toDocument ()

exml::Document * toDocument(void);

---

toDocument ()

const exml::Document * toDocument(void);

---