wx.PackageBuilder.PackagerApp Class Reference

Inheritance diagram for wx.PackageBuilder.PackagerApp:

List of all members.

Public Member Functions
Config	GetConfig ()
List< string >	GetLastPackages ()
Locale	GetLocale ()
ICollection < Build.ContentType >	GetRelevantContentTypes ()
override bool	OnInit ()
	PackagerApp (string packageFile)
void	ReportOpenedPackage (string filename)
void	RestoreEnvVariables ()
void	SetEnvVariable (string varName, string value)
Static Public Member Functions
static int	Main (string[] args)
Properties
string	PlatformDescription [get, set]
int	PlatformID [get]

---

Detailed Description

The application.

---

Constructor & Destructor Documentation

wx.PackageBuilder.PackagerApp.PackagerApp

(

string

packageFile

)

---

Member Function Documentation

Config wx.PackageBuilder.PackagerApp.GetConfig

(

)

List<string> wx.PackageBuilder.PackagerApp.GetLastPackages

(

)

Reads from the configuration the last packages that have been used. This will for instance be used to set up the corsponding menu entries.

Returns:

A possibly empty list of file names.

Locale wx.PackageBuilder.PackagerApp.GetLocale

(

)

The locale that shall be used within this application.

Use something like the following to extract English text strings from the program code:

xgettext.exe -C --force -po -k_ -k__ -o PkgBuilder.pot PgkToc.cs PkgFrame.cs PkgApp.cs

ICollection<Build.ContentType> wx.PackageBuilder.PackagerApp.GetRelevantContentTypes

(

)

Reads the collection of relevant content types from the configuration.

Returns:

static int wx.PackageBuilder.PackagerApp.Main

(

string[]

args

)

[static]

The main program.

Parameters:

args

Command line arguments

Returns:

Error code

override bool wx.PackageBuilder.PackagerApp.OnInit

(

)

Initializes the application.

Returns:

True on success to tell the application to proceed

void wx.PackageBuilder.PackagerApp.ReportOpenedPackage

(

string

filename

)

This will report the use of the designated package file to the used configuration.

Parameters:

filename

the name of the currently used configuration file.

void wx.PackageBuilder.PackagerApp.RestoreEnvVariables

(

)

This will reassign all assignments to environment variables that have been saved by SetEnvVariable().

void wx.PackageBuilder.PackagerApp.SetEnvVariable	(	string	varName,
		string	value
	)

Updates the provided value for the provided environment variable. The values assigned to variables here will be restored on restarting the application.

Parameters:

	varName	The name of the variable, e.g. INCLUDE
	value	The assigned value like e.g. "c:\MinGW\include".

---

Property Documentation

string wx.PackageBuilder.PackagerApp.PlatformDescription [get, set]

This is the platform description that users may add in the HTML info to describe the platform that they used to compile projects.

int wx.PackageBuilder.PackagerApp.PlatformID [get]

A typically unique identifier of the machine rangind from 0 to 999.999. Use this to create indices for the platform descriptor.

This will be created using a randomizer. Thus, this is not really guaranteed to be unique.

---