Logo ROOT  
Reference Guide
TXMLNode Class Reference

TXMLNode contains a pointer to xmlNode, which is a node under the DOM tree. A node can be an Element, an Attribute, a Text Node or a Comment Node. One can navigate the DOM tree by accessing the siblings and parent or child nodes. Also retriving the Attribute or the Text in an Element node.

Definition at line 20 of file TXMLNode.h.

Public Types

enum  EXMLElementType { kXMLElementNode = 1, kXMLAttributeNode = 2, kXMLTextNode = 3, kXMLCommentNode = 8 }
 This enum is based on libxml tree Enum xmlElementType. More...
 
- Public Types inherited from TObject
enum  {
  kIsOnHeap = 0x01000000, kNotDeleted = 0x02000000, kZombie = 0x04000000, kInconsistent = 0x08000000,
  kBitMask = 0x00ffffff
}
 
enum  { kSingleKey = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 

Public Member Functions

 TXMLNode (_xmlNode *node, TXMLNode *parent=0, TXMLNode *previous=0)
 
virtual ~TXMLNode ()
 Destructor. More...
 
TListGetAttributes ()
 Returns a list of node's attribute if any, returns 0 if no attribute. More...
 
TXMLNodeGetChildren ()
 Returns the node's child if any, returns 0 if no child. More...
 
const char * GetContent () const
 Returns the content if any, or 0. More...
 
const char * GetNamespaceHref () const
 Returns the URL for the namespace, or 0 if no namespace. More...
 
const char * GetNamespacePrefix () const
 Returns prefix for the namespace, or 0 if no namespace. More...
 
TXMLNodeGetNextNode ()
 Returns the next sibling XMLNode in the DOM tree, if any return 0 if no next node. More...
 
const char * GetNodeName () const
 Returns the node's name. More...
 
EXMLElementType GetNodeType () const
 Returns the node's type. More...
 
TXMLNodeGetParent () const
 Returns the node's parent if any, returns 0 if no parent. More...
 
TXMLNodeGetPreviousNode () const
 Returns the previous sibling XMLNode in the DOM tree, if any return 0 if no previous node. More...
 
const char * GetText () const
 Returns the content of a Text node if node is a TextNode, 0 otherwise. More...
 
Bool_t HasAttributes () const
 Returns true if Element node has attribute. More...
 
Bool_t HasChildren () const
 Returns true if node has children. More...
 
Bool_t HasNextNode () const
 Returns true if has next node. More...
 
Bool_t HasParent () const
 Returns true if node has parent. More...
 
Bool_t HasPreviousNode () const
 Returns true if has previous node. More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
ULong_t CheckedHash ()
 Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
Bool_t HasInconsistentHash () const
 Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
R__ALWAYS_INLINE Bool_t IsOnHeap () const
 
virtual Bool_t IsSortable () const
 
R__ALWAYS_INLINE Bool_t IsZombie () const
 
virtual void ls (Option_t *option="") const
 The ls function lists the contents of a class on stdout. More...
 
void MayNotUse (const char *method) const
 Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f)
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
R__ALWAYS_INLINE Bool_t TestBit (UInt_t f) const
 
Int_t TestBits (UInt_t f) const
 
virtual void UseCurrentStyle ()
 Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

Private Member Functions

 TXMLNode (const TXMLNode &)=delete
 
TXMLNodeoperator= (const TXMLNode &)=delete
 

Private Attributes

TListfAttrList
 List of Attributes. More...
 
TXMLNodefChildren
 Children node. More...
 
TXMLNodefNextNode
 Next sibling node. More...
 
TXMLNodefParent
 Parent node. More...
 
TXMLNodefPreviousNode
 Previous sibling node. More...
 
_xmlNode * fXMLNode
 libxml node More...
 

Additional Inherited Members

- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- Protected Member Functions inherited from TObject
virtual void DoError (int level, const char *location, const char *fmt, va_list va) const
 Interface to ErrorHandler (protected). More...
 
void MakeZombie ()
 

#include <TXMLNode.h>

Inheritance diagram for TXMLNode:
[legend]

Member Enumeration Documentation

◆ EXMLElementType

This enum is based on libxml tree Enum xmlElementType.

Enumerator
kXMLElementNode 
kXMLAttributeNode 
kXMLTextNode 
kXMLCommentNode 

Definition at line 36 of file TXMLNode.h.

Constructor & Destructor Documentation

◆ TXMLNode() [1/2]

TXMLNode::TXMLNode ( const TXMLNode )
privatedelete

◆ TXMLNode() [2/2]

TXMLNode::TXMLNode ( _xmlNode *  node,
TXMLNode parent = 0,
TXMLNode previous = 0 
)

◆ ~TXMLNode()

TXMLNode::~TXMLNode ( )
virtual

Destructor.

It deletes the node's child, next sibling and the attribute list.

Definition at line 45 of file TXMLNode.cxx.

Member Function Documentation

◆ GetAttributes()

TList * TXMLNode::GetAttributes ( )

Returns a list of node's attribute if any, returns 0 if no attribute.

Definition at line 108 of file TXMLNode.cxx.

◆ GetChildren()

TXMLNode * TXMLNode::GetChildren ( )

Returns the node's child if any, returns 0 if no child.

Definition at line 74 of file TXMLNode.cxx.

◆ GetContent()

const char * TXMLNode::GetContent ( ) const

Returns the content if any, or 0.

Definition at line 97 of file TXMLNode.cxx.

◆ GetNamespaceHref()

const char * TXMLNode::GetNamespaceHref ( ) const

Returns the URL for the namespace, or 0 if no namespace.

Definition at line 206 of file TXMLNode.cxx.

◆ GetNamespacePrefix()

const char * TXMLNode::GetNamespacePrefix ( ) const

Returns prefix for the namespace, or 0 if no namespace.

Definition at line 217 of file TXMLNode.cxx.

◆ GetNextNode()

TXMLNode * TXMLNode::GetNextNode ( )

Returns the next sibling XMLNode in the DOM tree, if any return 0 if no next node.

Definition at line 130 of file TXMLNode.cxx.

◆ GetNodeName()

const char * TXMLNode::GetNodeName ( ) const

Returns the node's name.

Definition at line 66 of file TXMLNode.cxx.

◆ GetNodeType()

TXMLNode::EXMLElementType TXMLNode::GetNodeType ( ) const

Returns the node's type.

Definition at line 58 of file TXMLNode.cxx.

◆ GetParent()

TXMLNode * TXMLNode::GetParent ( ) const

Returns the node's parent if any, returns 0 if no parent.

Definition at line 89 of file TXMLNode.cxx.

◆ GetPreviousNode()

TXMLNode * TXMLNode::GetPreviousNode ( ) const

Returns the previous sibling XMLNode in the DOM tree, if any return 0 if no previous node.

Definition at line 146 of file TXMLNode.cxx.

◆ GetText()

const char * TXMLNode::GetText ( ) const

Returns the content of a Text node if node is a TextNode, 0 otherwise.

Definition at line 154 of file TXMLNode.cxx.

◆ HasAttributes()

Bool_t TXMLNode::HasAttributes ( ) const

Returns true if Element node has attribute.

Definition at line 198 of file TXMLNode.cxx.

◆ HasChildren()

Bool_t TXMLNode::HasChildren ( ) const

Returns true if node has children.

Definition at line 166 of file TXMLNode.cxx.

◆ HasNextNode()

Bool_t TXMLNode::HasNextNode ( ) const

Returns true if has next node.

Definition at line 174 of file TXMLNode.cxx.

◆ HasParent()

Bool_t TXMLNode::HasParent ( ) const

Returns true if node has parent.

Definition at line 182 of file TXMLNode.cxx.

◆ HasPreviousNode()

Bool_t TXMLNode::HasPreviousNode ( ) const

Returns true if has previous node.

Definition at line 190 of file TXMLNode.cxx.

◆ operator=()

TXMLNode& TXMLNode::operator= ( const TXMLNode )
privatedelete

Member Data Documentation

◆ fAttrList

TList* TXMLNode::fAttrList
private

List of Attributes.

Definition at line 32 of file TXMLNode.h.

◆ fChildren

TXMLNode* TXMLNode::fChildren
private

Children node.

Definition at line 29 of file TXMLNode.h.

◆ fNextNode

TXMLNode* TXMLNode::fNextNode
private

Next sibling node.

Definition at line 30 of file TXMLNode.h.

◆ fParent

TXMLNode* TXMLNode::fParent
private

Parent node.

Definition at line 28 of file TXMLNode.h.

◆ fPreviousNode

TXMLNode* TXMLNode::fPreviousNode
private

Previous sibling node.

Definition at line 31 of file TXMLNode.h.

◆ fXMLNode

_xmlNode* TXMLNode::fXMLNode
private

libxml node

Definition at line 26 of file TXMLNode.h.

Libraries for TXMLNode:
[legend]

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