Murl::Resource::XmlDictionary Class Reference

The XML dictionary resource class. More...

#include "murl_resource_xml_dictionary.h"

Inheritance diagram for Murl::Resource::XmlDictionary:

Additional Inherited Members

- Public Types inherited from Murl::IFactoryObject< IObject >
using ClassInfoArray = Array< const ClassInfo * >
 Definition of an array of ClassInfo objects.
- Public Member Functions inherited from Murl::Resource::IObject
virtual Bool GetFileDependencies (Array< String > &fileNames) const =0
 Fill a given string array with names of files the resource depends on. More...
- Public Member Functions inherited from Murl::IFactoryObject< IObject >
 ~IFactoryObject () override
 The destructor.
virtual const ClassInfo * GetObjectClassInfo () const=0
 Get the object instance's class info, if present. More...
virtual void ResetObjectProperties ()=0
 Reset the object instance's properties to their default values.
- Public Member Functions inherited from Murl::Resource::IDictionary
virtual IObjectGetObjectInterface ()=0
 Get the mutable Resource::IObject interface. More...
virtual const IObjectGetObjectInterface () const =0
 Get the constant Resource::IObject interface. More...
- Static Public Member Functions inherited from Murl::IFactoryObject< IObject >
static const PropertyInfoGetPropertyInfo ()
 Get the class' property info struct. More...
static const AttributeInfoGetAttributeInfo ()
 Get the class' attribute info struct. More...
static void ResetProperties (IFactoryObject< IObject > *object)
 Reset an object instance's properties to their default values. More...

Detailed Description

The XML dictionary resource class.

An XML dictionary file is recognized by its <Dictionary> root element. Within the root element, the only allowed elements are of type <Text>, each of which defines a single IText entry. Using a dictionary resource is useful as a replacement for individual text elements in a package, when there are several texts sharing the same set of include/exclude conditions.

The following attributes are accepted in a <Text> tag:

  • id: The unique ID of the entry
  • value: The actual string value.

Example of an XML dictionary file:

<?xml version="1.0" ?>
<Text id="foo" value="blah"/>
<Text id="bar" value="yaddayadda"/>

Use the <Resource> tag in a .murlres package's resource.xml file to specify an XML dictionary resource. See Resource::Object.

The documentation for this class was generated from the following file:
  • murl_resource_xml_dictionary.h

Copyright © 2011-2024 Spraylight GmbH.