VCF::PropertyListing Class Reference

A PropertyListing is just a Dictionary with some extra functions that make it easy to deal with sub dictionaries and arrays. More...

#include <vcf/FoundationKit/PropertyListing.h>

Inheritance diagram for VCF::PropertyListing:

List of all members.


Public Member Functions
virtual String	toString () const
	returns a string representation of the object
virtual void	loadFromStream (InputStream *stream, const MIMEType &type=MIMEType())
	Read the object from the specified input stream.
virtual void	saveToStream (OutputStream *stream, const MIMEType &type=MIMEType())
	Write the object to the specified output stream.
Dictionary &	getDict (const String &name)
const Dictionary &	getDict (const String &name) const
VariantArray &	getArray (const String &name)
const VariantArray &	getArray (const String &name) const
VariantData &	getByPath (const String &path)
VariantData	getByPath (const String &path) const

Detailed Description

A PropertyListing is just a Dictionary with some extra functions that make it easy to deal with sub dictionaries and arrays.

Also supports reading and writing itself using the property list xml format.

Member Function Documentation

const VariantArray& VCF::PropertyListing::getArray ( const String & name ) const [inline]

VariantArray& VCF::PropertyListing::getArray ( const String & name ) [inline]

VariantData VCF::PropertyListing::getByPath ( const String & path ) const [inline]

VariantData& VCF::PropertyListing::getByPath ( const String & path ) [inline]

const Dictionary& VCF::PropertyListing::getDict ( const String & name ) const [inline]

Dictionary& VCF::PropertyListing::getDict ( const String & name ) [inline]

virtual void VCF::PropertyListing::loadFromStream ( InputStream * stream,

const MIMEType & type = MIMEType()

) [inline, virtual]

Read the object from the specified input stream.

Parameters:

InputStream

MIMEType indicates how to read the data from the stream. For example, if the object was some sort of image object, and had an array of pixels, then the type might indicate how the data in the stream should be interpreted, such as the JPEG format ("image/jpeg"), or the PNG format ("image/png").

Reimplemented from VCF::Dictionary.

virtual void VCF::PropertyListing::saveToStream ( OutputStream * stream,

const MIMEType & type = MIMEType()

) [inline, virtual]

Write the object to the specified output stream.

Parameters:

OutputStream

MIMEType indicates how the object should write it's data. For example, if the object was some sort of image object, and had an array of pixels, then the type might indicate what kind of image type to write the data in, such as the JPEG format ("image/jpeg"), or the PNG format ("image/png").

Reimplemented from VCF::Dictionary.

virtual String VCF::PropertyListing::toString ( ) const [inline, virtual]

returns a string representation of the object

Reimplemented from VCF::Object.

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

vcf/FoundationKit/PropertyListing.h

VCF::PropertyListing Class Reference

Public Member Functions

Detailed Description

Member Function Documentation