wx.PackageBuilder.TableOfContents Class Reference

Inheritance diagram for wx.PackageBuilder.TableOfContents:

List of all members.

Public Member Functions
void	Clear ()
ICollection < PlatformDescr >	GetPlatformsInSrc ()
System.Xml.Schema.XmlSchema	GetSchema ()
string	GetSrcBasePath ()
void	Load (Build.ErrorHandler errorHandler, string filename, string destination)
void	NormalizeOriginalFileNames (string nameOfAValidDirOrFile)
void	ReadXml (System.Xml.XmlReader reader)
void	Save (Build.ErrorHandler errorHandler, string filename)
	TableOfContents ()
override string	ToString ()
void	WriteXml (System.Xml.XmlWriter writer)
Public Attributes
SortedList< string, string >	EnvVarAssignments = new SortedList<string, string>()
TreeOfContentFiles < SrcNodeData, SrcLeafData >	SrcFiles = new TreeOfContentFiles<SrcNodeData, SrcLeafData>(null)
TreeOfContentFiles < TocNodeData, TocNodeData >	TocFiles = new TreeOfContentFiles<TocNodeData, TocNodeData>(null)

---

Detailed Description

Lists the content of a package. Instances of this class serve as a data model for package builder and the component that will decompress the contained files and projects.

---

Constructor & Destructor Documentation

wx.PackageBuilder.TableOfContents.TableOfContents

(

)

Creates an empty instance.

---

Member Function Documentation

void wx.PackageBuilder.TableOfContents.Clear

(

)

Clears all data.

ICollection<PlatformDescr> wx.PackageBuilder.TableOfContents.GetPlatformsInSrc

(

)

This will traverse the complete source tree and search for all platform descriptors containing at least one file.

Returns:

System.Xml.Schema.XmlSchema wx.PackageBuilder.TableOfContents.GetSchema

(

)

Simply returns null as suggested by the framework documentation.

Returns:

string wx.PackageBuilder.TableOfContents.GetSrcBasePath

(

)

Returns the longest path that is common to all contained source files.

Returns:

void wx.PackageBuilder.TableOfContents.Load	(	Build.ErrorHandler	errorHandler,
		string	filename,
		string	destination
	)

This will load a TOC and the listed files from the designated file. All files that have been attached to the data source will be saved relatively to the provided directory name.

Parameters:

	errorHandler	This method will write errors to this.
	filename	The filenmae of the data source
	destination

See also:

Save

void wx.PackageBuilder.TableOfContents.NormalizeOriginalFileNames

(

string

nameOfAValidDirOrFile

)

All internal "original" filenames will be changed to denote the file designated by the absolute filename but relative to the directory provided as argument to this method. This will also set the Build.BuildConfig.PathRoot.

Parameters:

nameOfAValidDirOrFile

Implements wx.PackageBuilder.IDataReferringToFiles.

void wx.PackageBuilder.TableOfContents.ReadXml

(

System.Xml.XmlReader

reader

)

void wx.PackageBuilder.TableOfContents.Save	(	Build.ErrorHandler	errorHandler,
		string	filename
	)

Saves the serialization of this tree and all the designated files into a resource file of the provided name.

Parameters:

	errorHandler	This method will write errors to this.
	filename	Filename of the destination.

See also:

Load

override string wx.PackageBuilder.TableOfContents.ToString

(

)

void wx.PackageBuilder.TableOfContents.WriteXml

(

System.Xml.XmlWriter

writer

)

---

Member Data Documentation

SortedList<string, string> wx.PackageBuilder.TableOfContents.EnvVarAssignments = new SortedList<string, string>()

Key is the name of a variable. The value is the assigned value. This will only contain those assignments that differ from the default values.

Currently not used.

TreeOfContentFiles<SrcNodeData, SrcLeafData> wx.PackageBuilder.TableOfContents.SrcFiles = new TreeOfContentFiles<SrcNodeData, SrcLeafData>(null)

A collection of source files that provide data to be included into the package.

TreeOfContentFiles<TocNodeData, TocNodeData> wx.PackageBuilder.TableOfContents.TocFiles = new TreeOfContentFiles<TocNodeData, TocNodeData>(null)

Collection of files that will be installed.

---