Valuable Namespace Reference

A library for automatically saving and loading class member values. More...

Namespaces
namespace	Serializer
	XML Serializer namespace that has handles the (de)serialize dispatching.

Classes
class	Archive
	Abstract class that defines an interface that allows working with elements. More...
class	ArchiveElement
	ArchiveElement defines the serialization API. More...
class	ArchiveElementImpl
	Interface for classes that want to implement ArchiveElement API ArchiveElement has a name, list of children, map of (name -> value) -pairs, and the content string. More...
class	ArchiveIterator
	Child iterator for ArchiveElement children, uses instance of ArchiveIteratorImpl to provide implementation for different element types. More...
class	ArchiveIteratorImpl
	Classes that implement this interface provide the functionality for ArchiveIterator for one specific element type. More...
class	Attribute
	The base class for value objects. More...
class	AttributeAlias
	Alias to another Attribute object. More...
class	AttributeBool
	A value object for boolean. More...
class	AttributeColor
	A value object holding a Radiant::Color value. More...
class	AttributeContainer
	Template class for all STL-like containers. More...
class	AttributeContainer< std::map< Key, T, Compare, Allocator > >
	This class handles container attributes. More...
class	AttributeContainerT
	This class is a base class for wrapping STL-like containers into attributes. More...
class	AttributeEnum
class	AttributeEnumT
	Valuable enum. More...
class	AttributeFlagsT
	Attribute containing flags, bitmask of enum values. More...
class	AttributeFloatT
	Template class for floating-point values. More...
struct	AttributeFor
	Value struct helps finding the correct Attribute for any type T. More...
class	AttributeFrame
	This class provides an attribute that stores a two-dimensional frame. More...
class	AttributeIntT
	Template class for integer values. More...
class	AttributeLocation2f
	This class provides an attribute for Nimble::Vector2f. More...
class	AttributeMatrix
	A matrix value object. More...
class	AttributeNumericT
	A template base class for numeric values. More...
class	AttributeRectT
	A valuable object holding a Nimble::Rect object. More...
class	AttributeSizeT
	This class defines an attribute that stores a Nimble::Size(F) object. More...
class	AttributeString
	String value. More...
class	AttributeStringList
	This class provides a QStringList attribute. More...
class	AttributeStringMap
	This class provides a QMap<QString, QString> attribute. More...
class	AttributeStyleValue
	This class provides a StyleValue attribute. More...
class	AttributeT
	Every Attribute is some kind of AttributeT<T> object. More...
class	AttributeTimeStamp
	This class provides a Radiant::TimeStamp attribute. More...
class	AttributeVector
	A template class for vector values. More...
class	AttributeVectorT
	This class is a utility class that provides a setter for vector attributes. More...
class	CmdParser
	Command line parser. More...
class	ConfigDocument
	Text document used to configure various settings with key-value pairs. More...
class	ConfigElement
	Configuration block in ConfigDocument. More...
class	ConfigValue
	A configurable value. More...
class	DOMDocument
	Represents a DOM document. More...
class	DOMElement
	An element in DOMDocument. More...
struct	EnumNames
	This struct is used to define the name strings for enum values so they can be referenced from CSS. More...
class	FileWatcher
	FileWatcher provides an interface for monitoring files and directories for modifications. More...
class	FlagAlias
class	FlagAliasT
	This class provides a mechanism to toggle individual flags on and off using their name from CSS. More...
struct	FlagNames
	This struct is used to define the name strings for flags so they can be referenced from CSS. More...
class	ListenerHolder
	Provides lifetime management for listeners. More...
class	Node
	Base class for objects that include member variables with automatic IO. More...
class	Serializable
	The base class for all serializable objects. More...
class	SerializationOptions
	Options that define the behaviour of the (de)serialize() methods. More...
class	State
	State machine that doesn't define any transitions or triggers, but implements thread-safe access and monitoring callbacks. More...
class	StyleValue
	CSS attribute value is a list of variant components. More...
class	XMLArchive
	Wrapper for DOMDocument that implements the Archive interface. More...
class	XMLArchiveElement
	Wrapper for DOMElement that implements the ArchiveElementImpl interface. More...

Typedefs
typedef AttributeFloatT< float >	AttributeFloat
	Float value object.
typedef AttributeIntT< int32_t >	AttributeInt
	32-bit integer value object.
typedef AttributeIntT< int32_t >	AttributeInt32
	32-bit integer value object.
typedef AttributeIntT< int64_t >	AttributeInt64
	64-bit integer value object.
typedef AttributeMatrix < Nimble::Matrix2f, float, 4 >	AttributeMatrix2f
	A float Matrix2 value object.
typedef AttributeMatrix < Nimble::Matrix3f, float, 9 >	AttributeMatrix3f
	A float Matrix3 value object.
typedef AttributeMatrix < Nimble::Matrix4f, float, 16 >	AttributeMatrix4f
	A float Matrix4 value object.
typedef AttributeRectT< float >	AttributeRect
	Default floating point AttributeRectT typedef.
typedef AttributeRectT< double >	AttributeRectd
	AttributeRectT of doubles.
typedef AttributeRectT< float >	AttributeRectf
	AttributeRectT of floats.
typedef AttributeRectT< int >	AttributeRecti
	AttributeRectT of ints.
typedef AttributeSizeT< int, Nimble::Size, AttributeInt >	AttributeSize
typedef AttributeSizeT< float, Nimble::SizeF, AttributeFloat >	AttributeSizeF
typedef AttributeIntT< uint32_t >	AttributeUInt32
	32-bit unsigned integer value object.
typedef AttributeIntT< uint64_t >	AttributeUInt64
	64-bit unsigned integer value object.
typedef Valuable::AttributeIntT < Node::Uuid >	AttributeUuid
typedef AttributeVectorT < Nimble::Vector2T, float >	AttributeVector2f
	A float Nimble::Vector2f value object.
typedef AttributeVectorT < Nimble::Vector2T, int >	AttributeVector2i
	An integer Nimble::Vector2f value object.
typedef AttributeVectorT < Nimble::Vector3T, float >	AttributeVector3f
	A float vector3 value object.
typedef AttributeVectorT < Nimble::Vector3T, int >	AttributeVector3i
	An integer vector3 value object.
typedef AttributeVectorT < Nimble::Vector4T, float >	AttributeVector4f
	A float vector4 value object.
typedef AttributeVectorT < Nimble::Vector4T, int >	AttributeVector4i
	An integer vector4 value object.
typedef State< LoadingEnum >	LoadingState
	Commonly used state.

Enumerations
enum	LoadingEnum {   STATE_NEW = 1 << 0, STATE_LOADING = 1 << 1, STATE_HEADER_READY = 1 << 2, STATE_READY = 1 << 3,   STATE_ERROR = 1 << 4 }
	Content-loading states. More...

Functions
void VALUABLE_API	convert (DOMDocument &doc, DOMElement &to, const ConfigElement &from)
	Converts from text element to XML element.
void VALUABLE_API	convert (ConfigElement &to, DOMElement from)
	Converts from XML element to text element.
VALUABLE_API std::ostream &	operator<< (std::ostream &os, const StyleValue &value)
	Converts StyleValue to CSS string and writes that to stream. More...
template<typename T >
bool	operator== (const AttributeEnumT< T > &a, T e)
STYLISH_API std::istream &	operator>> (std::istream &is, StyleValue &value)
	Reads one line from stream and parses that with CSS parser to StyleValue. More...

Detailed Description

A library for automatically saving and loading class member values.

The purpose of this framework is to handle:

Saving classes with members to XML files

Loading classes with members from XML files

Set/get parameter member values dynamically by string name

Enumeration Type Documentation

enum Valuable::LoadingEnum

Content-loading states.

Enumerator
STATE_NEW	Default object state when loading has not yet been initiated.
STATE_LOADING	Loading has been initiated.
STATE_HEADER_READY	Content meta-data, including size has been loaded.
STATE_READY	Enough content has been loaded to render.
STATE_ERROR	An error occured during loading.

Function Documentation

VALUABLE_API std::ostream& Valuable::operator<<	(	std::ostream &	os,
		const StyleValue &	value
	)

Converts StyleValue to CSS string and writes that to stream.

Parameters

[out]	os	output stream
[in]	value	StyleValue to write

Returns

os

STYLISH_API std::istream& Valuable::operator>>	(	std::istream &	is,
		StyleValue &	value
	)

Reads one line from stream and parses that with CSS parser to StyleValue.

Parameters

[in]	is	stream to read the line
[out]	value	StyleValue to fill

Returns

is

Note

This needs full CSS parser to work, so its implemented in Stylish