className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FXmlFile::GetRootNode
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Returns the root node of the loaded file. nullptr if no file loaded. It is assumed that there will always be one and only one root node. Pointer to root node
XmlParser
[FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetRootNode()
[]
FXmlFile::LoadFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Loads the file with the passed path. Path is either treated as a filename to open, or as a text buffer to load.
XmlParser
bool LoadFile ( const [FString](API\Runtime\Core\Containers\FString) & Path, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )
[]
FXmlFile::operator=
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
[FXmlFile](API\Runtime\XmlParser\FXmlFile) & operator= ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Constructs the file without a path
XmlParser
FXmlFile()
[]
FXmlFile::Save
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Write to disk, UTF-16 format only at the moment Whether writing the XML to a file succeeded
XmlParser
bool Save ( const [FString](API\Runtime\Core\Containers\FString) & Path )
[]
FXmlFile::IsValid
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Checks to see if a file is loaded
XmlParser
bool IsValid() const
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
FXmlFile ( const [FXmlFile](API\Runtime\XmlParser\FXmlFile) & rhs )
[]
FXmlFile::FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Constructs the file with the passed path. InFile is either treated as a filename to open, or as a text buffer to load.
XmlParser
FXmlFile ( const [FString](API\Runtime\Core\Containers\FString) & InFile, [EConstructMethod::Type](API\Runtime\XmlParser\EConstructMethod__Type) ConstructMethod )
[]
FXmlFile::~FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
XmlParser
~FXmlFile()
[]
FXmlFile
/Engine/Source/Runtime/XmlParser/Public/XmlFile.h
Class representing an XML file
XmlParser
class FXmlFile
[]
FXmlNode::FindChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Finds the first child node that contains the specified tag
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const
[]
FXmlNode::AppendChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Adds a child node to this node
XmlParser
void AppendChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag, const [FString](API\Runtime\Core\Containers\FString) & InContent, const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )
[]
FXmlNode::FindChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Finds the first child node that contains the specified tag
XmlParser
[FXmlNode](API\Runtime\XmlParser\FXmlNode) * FindChildNode ( const [FString](API\Runtime\Core\Containers\FString) & InTag )
[]
FXmlNode::GetAttribute
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets an attribute that corresponds with the passed-in tag
XmlParser
[FString](API\Runtime\Core\Containers\FString) GetAttribute ( const [FString](API\Runtime\Core\Containers\FString) & InTag ) const
[]
FXmlNode::GetAttributes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets all of the attributes in this node List of attributes in this node
XmlParser
const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & GetAttributes() const
[]
FXmlNode::GetChildrenNodes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets a list of children nodes
XmlParser
const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlNode](API\Runtime\XmlParser\FXmlNode) * > & GetChildrenNodes() const
[]
FXmlNode::GetFirstChildNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the first child of this node which can be iterated into with GetNextNode
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetFirstChildNode() const
[]
FXmlNode::GetContent
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the value of the node
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetContent() const
[]
FXmlNode::GetNextNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the next node in a list of nodes
XmlParser
const [FXmlNode](API\Runtime\XmlParser\FXmlNode) * GetNextNode() const
[]
FXmlNode::GetTag
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Gets the tag of the node
XmlParser
const [FString](API\Runtime\Core\Containers\FString) & GetTag() const
[]
FXmlNode::SetContent
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Sets the new value of the node
XmlParser
void SetContent ( const [FString](API\Runtime\Core\Containers\FString) & InContent )
[]
FXmlNode::SetAttributes
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
Sets the attributes of the node
XmlParser
void SetAttributes ( const [TArray](API\Runtime\Core\Containers\TArray)< [FXmlAttribute](API\Runtime\XmlParser\FXmlAttribute) > & InAttributes )
[]
FXmlNode
/Engine/Source/Runtime/XmlParser/Public/XmlNode.h
No destructors are accessible with public or protected access.
XmlParser
class FXmlNode
[]
IFastXmlCallback::ProcessAttribute
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when an XML attribute is encountered for the current scope's element. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessAttribute ( const TCHAR * AttributeName, const TCHAR * AttributeValue )
[]
IFastXmlCallback::ProcessComment
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when a comment is encountered. This can happen pretty much anywhere in the file.
XmlParser
bool ProcessComment ( const TCHAR * Comment )
[]
IFastXmlCallback::ProcessClose
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when an element's scope ends in the XML file You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessClose ( const TCHAR * Element )
[]
IFastXmlCallback::ProcessElement
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called when a new XML element is encountered, starting a new scope. You'll receive a call toProcessClose()when this element's scope has ended. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessElement ( const TCHAR * ElementName, const TCHAR * ElementData, int32 XmlFileLineNumber )
[]
IFastXmlCallback
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Create your own class that implements theIFastXmlCallbackinterface to process the XML elements as they are loaded byFFastXml::ParseXmlFile(). You'll receive aProcessElement()call for every XML element that is encountered, along with a correspondingProcessClose()when that element's scope has ended.ProcessAttribute()will be called for any attributes found within the scope of the current element.
XmlParser
class IFastXmlCallback
[]
IFastXmlCallback::ProcessXmlDeclaration
/Engine/Source/Runtime/XmlParser/Public/FastXml.h
Called after the XML's header is parsed. This is usually the first call that you'll get back. You should return true to continue processing the file, or false to stop processing immediately.
XmlParser
bool ProcessXmlDeclaration ( const TCHAR * ElementData, int32 XmlFileLineNumber )
[]