libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Friends | List of all members
crn::xml::Comment Class Reference

XML comment. More...

#include <CRNXml.h>

+ Inheritance diagram for crn::xml::Comment:
+ Collaboration diagram for crn::xml::Comment:

Public Member Functions

 Comment (const Comment &)=default
 
 Comment (Comment &&)=default
 
Commentoperator= (const Comment &)=default
 
Commentoperator= (Comment &&)=default
 
virtual ~Comment () override
 Destructor. More...
 
- Public Member Functions inherited from crn::xml::Node
virtual ~Node ()
 Destructor. More...
 
 Node (const Node &)=default
 
 Node (Node &&)=default
 
Nodeoperator= (const Node &)=default
 
Nodeoperator= (Node &&)=default
 
bool IsElement ()
 Checks if the node is an element. More...
 
bool IsComment ()
 Checks if the node is a comment. More...
 
bool IsText ()
 Checks if the node is a text. More...
 
Element AsElement ()
 Converts to element. More...
 
Comment AsComment ()
 Converts to comment. More...
 
Text AsText ()
 Converts to text. More...
 
 operator bool () const noexcept
 Checks if the node is not null. More...
 
bool operator! () const noexcept
 Checks if the node is null. More...
 
bool operator== (const Node &other) const noexcept
 Comparison operator. More...
 
bool operator!= (const Node &other) const noexcept
 Comparison operator. More...
 
virtual StringUTF8 GetValue () const
 Gets the content of the node. More...
 
void SetValue (const StringUTF8 &s)
 Sets the content of the node. More...
 
Node GetParent ()
 Gets the parent node if any. More...
 
Node GetPreviousSibling ()
 Gets the previous sibling node. More...
 
Node GetNextSibling ()
 Gets the next sibling node. More...
 
Nodeoperator++ ()
 Moves to the next sibling node. More...
 
Node operator++ (int)
 Moves to the next sibling node. More...
 
Element GetNextSiblingElement (const StringUTF8 &name="")
 Gets the next sibling element. More...
 
Element GetPreviousSiblingElement (const StringUTF8 &name="")
 Gets the previous sibling element. More...
 

Protected Member Functions

 Comment (tinyxml2::XMLComment *c, const SCharsetConverter &co)
 Constructor. More...
 
- Protected Member Functions inherited from crn::xml::Node
 Node (tinyxml2::XMLNode *n, const SCharsetConverter &c)
 Constructor. More...
 

Friends

class Element
 
class Node
 
class Document
 

Additional Inherited Members

- Protected Attributes inherited from crn::xml::Node
SCharsetConverter conv
 

Detailed Description

XML comment.

An XML comment

Version
1.0
Author
Yann LEYDIER
Date
August 2012

Definition at line 364 of file CRNXml.h.

Constructor & Destructor Documentation

crn::xml::Comment::Comment ( const Comment )
default
crn::xml::Comment::Comment ( Comment &&  )
default
virtual crn::xml::Comment::~Comment ( )
inlineoverridevirtual

Destructor.

Definition at line 372 of file CRNXml.h.

Comment::Comment ( tinyxml2::XMLComment c,
const SCharsetConverter &  co 
)
protected

Constructor.

Constructor

Parameters
[in]cthe inner node handle
[in]coa character set converter

Definition at line 859 of file CRNXml.cpp.

Member Function Documentation

Comment& crn::xml::Comment::operator= ( const Comment )
default
Comment& crn::xml::Comment::operator= ( Comment &&  )
default

Friends And Related Function Documentation

friend class Document
friend

Definition at line 383 of file CRNXml.h.

friend class Element
friend

Definition at line 381 of file CRNXml.h.

friend class Node
friend

Definition at line 382 of file CRNXml.h.


The documentation for this class was generated from the following files: