wx.Build.TempFilesParameters Class Reference

Inheritance diagram for wx.Build.TempFilesParameters:

Inheritance graph

List of all members.

Public Member Functions

virtual void AdditionalInfoToXML (System.Xml.XmlWriter destination)
override BuildParameters Clone ()
ContentFile CreatePathFor (string srcFilename, ContentType targetType)
virtual string GetDirectory (string subPath)
string GetDirectory ()
 TempFilesParameters ()

Static Public Member Functions

static string MakePathRelative (string toBeMadeRelative, string theBasePath)

Public Attributes

bool KeepFiles = false

Properties

static string BuildDir [get]


Detailed Description

A standard parameter specifying some standard properties regarding temporary files.

Constructor & Destructor Documentation

wx.Build.TempFilesParameters.TempFilesParameters (  ) 


Member Function Documentation

virtual void wx.Build.BuildParameters.AdditionalInfoToXML ( System.Xml.XmlWriter  destination  )  [virtual, inherited]

This prints all public properties and fields on the provided destination. This may be overloaded by subclasses.

override BuildParameters wx.Build.TempFilesParameters.Clone (  )  [virtual]

This creates a clone of the argument.

Implements wx.Build.BuildParameters.

ContentFile wx.Build.TempFilesParameters.CreatePathFor ( string  srcFilename,
ContentType  targetType 
)

Derive a temporary filename from the srcFilename for content of type targetType. targetType will be the type of the result. The filename will be derived from srcFilename using GetDirectory() and an appropriate filename extension.

Parameters:
srcFilename The filename that will be used as reference to produce a temporary file.
targetType the type of the resulting file. This may be used to produce the filename of the temporary file.
Returns:
Descriptor of a content file of the provided type that is in a subdir of all temporary files. The filename of the result will contain underscores '_' instead of blanks ' '.

virtual string wx.Build.TempFilesParameters.GetDirectory ( string  subPath  )  [virtual]

Returns the path to a temporary directory and creates it if this does not exist. This accepts the null argument and will create a path to the base path of temporary files for the current default configuration.

string wx.Build.TempFilesParameters.GetDirectory (  ) 

Returns a path to the standard directory of temporary files for the current default configuration.

static string wx.Build.TempFilesParameters.MakePathRelative ( string  toBeMadeRelative,
string  theBasePath 
) [static]

Utility to turn the first path into an equivalent (referring to the same file) that is, however, relative to the second path.

Parameters:
toBeMakeRelative The result will be equivalent to this but relative to the argument.
theBasePath The result will be relative to this.
            System.Console.WriteLine(wx.Build.TempFilesParameters(
               "C:\ADirectory\toBeMadeRelative", 
               "C:\ADirectory\theBasePath");
The sniplet above will cause the following ouput on the console:
            "..\toBeMadeRelative"


Member Data Documentation

bool wx.Build.TempFilesParameters.KeepFiles = false


Property Documentation

string wx.Build.TempFilesParameters.BuildDir [static, get]

The base path of all non-target files that will be created building the targets.


The wx.NET Build System.   (c) 2009-2010 Harald Meyer auf'm Hofe