clan::XMLResourceNode Class Reference

Resource node for a XMLResourceDocument. More...

#include <xml_resource_node.h>

Public Member Functions

 XMLResourceNode ()
 
 ~XMLResourceNode ()
 
std::string get_base_path () const
 Returns the base path of the resource. More...
 
XMLResourceDocument get_document ()
 Returns the resource document owning the resource. More...
 
DomElementget_element ()
 Returns the DOM element describing the resource. More...
 
FileSystem get_file_system () const
 Returns the file system to load resource from. More...
 
std::string get_name () const
 Returns the name of the resource. More...
 
std::string get_type () const
 Returns the resource type. More...
 
bool is_null () const
 
IODevice open_file (const std::string &filename, File::OpenMode mode=File::open_existing, unsigned int access=File::access_read, unsigned int share=File::share_all, unsigned int flags=0) const
 Opens a file relative to the resource base path. More...
 
bool operator== (const XMLResourceNode &other) const
 Compares this resource to another resource. More...
 

Friends

class XMLResourceDocument
 

Detailed Description

Constructor & Destructor Documentation

clan::XMLResourceNode::XMLResourceNode ( )
clan::XMLResourceNode::~XMLResourceNode ( )

Member Function Documentation

std::string clan::XMLResourceNode::get_base_path ( ) const

Returns the base path of the resource.

XMLResourceDocument clan::XMLResourceNode::get_document ( )

Returns the resource document owning the resource.

DomElement& clan::XMLResourceNode::get_element ( )

Returns the DOM element describing the resource.

FileSystem clan::XMLResourceNode::get_file_system ( ) const

Returns the file system to load resource from.

std::string clan::XMLResourceNode::get_name ( ) const

Returns the name of the resource.

std::string clan::XMLResourceNode::get_type ( ) const

Returns the resource type.

bool clan::XMLResourceNode::is_null ( ) const
IODevice clan::XMLResourceNode::open_file ( const std::string filename,
File::OpenMode  mode = File::open_existing,
unsigned int  access = File::access_read,
unsigned int  share = File::share_all,
unsigned int  flags = 0 
) const

Opens a file relative to the resource base path.

param: mode = File::OpenMode modes param: access = File::AccessFlags flags param: share = File::ShareFlags flags param: flags = File::Flags flags

Returns
The IODevice
bool clan::XMLResourceNode::operator== ( const XMLResourceNode other) const

Compares this resource to another resource.

Friends And Related Function Documentation

friend class XMLResourceDocument
friend

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