wx.PackageBuilder.PkgFrame Class Reference

The main frame of the package builder. More...

Inheritance diagram for wx.PackageBuilder.PkgFrame:

Inheritance graph

List of all members.

Public Member Functions

void AddCurrentPlatform (TreeItemId srcNode)
void AddCurrentPlatform ()
void AddSrcFileToPkg (TreeItemId id)
void AppendEnvVarInfoTable (StringBuilder htmlCode, ICollection< string > varFilter)
void DisplayContent (Build.ContentFile fileDescr)
void DisplayInfoSrcLeaf (SrcLeafData data)
void DisplayInfoSrcNode (SrcNodeData data)
void DisplayInfoTocLeaf (TocNodeData data)
void DisplayInfoTocNode (TocNodeData data)
ICollection
< PlatformDescr
GetPlatformsInSrc ()
SrcNodeData GetSelectedSrcData ()
Build.ContentFile GetSelectedSrcFile ()
wx.StyledText.StcStyleCollection GetStcStyle (Build.ContentType t)
void LoadDirectoryFiles (TreeItemId srcNode)
void LoadSrcFiles (ICollection< string > filenames)
bool Make (Build.BuildProject p, bool rebuild)
void OnCloseEvent (object sender, Event evt)
void OpenPackageFile (string filenamePkg, string destinationDir)
 PkgFrame ()

Classes

class  AboutBox
class  ProjectUpdateEvent


Detailed Description

The main frame of the package builder.

Constructor & Destructor Documentation

wx.PackageBuilder.PkgFrame.PkgFrame (  ) 


Member Function Documentation

void wx.PackageBuilder.PkgFrame.AddCurrentPlatform ( TreeItemId  srcNode  ) 

Looks for each contained platform specific file whether the local file system contains a version of this file. If this finds a file, the current platform will be added to the platforms supporting that file.

Parameters:
srcNode The operation will be applied to this node and all children.

void wx.PackageBuilder.PkgFrame.AddCurrentPlatform (  ) 

Looks for each contained platform specific file whether the local file system contains a version of this file. If this finds a file, the current platform will be added to the platforms supporting that file.

void wx.PackageBuilder.PkgFrame.AddSrcFileToPkg ( TreeItemId  id  ) 

Adds the data associated with the designated node in the tree of source files to the currently selected feature or installation directory in the package view.

Parameters:
id Valid designator if a node in the source tree.

void wx.PackageBuilder.PkgFrame.AppendEnvVarInfoTable ( StringBuilder  htmlCode,
ICollection< string >  varFilter 
)

This helper method will append HTML code presenting info on environment variables to the provided string builder. This will print info on all known environment variables (using the cache _allUsedEnvVars) if the variable filter argument is null. Otherwise, only those known environment variables will be presented, that also appear in the filter argument.

Parameters:
htmlCode The target of the generated HTML code.
varFilter This is a filter for the presented variables containing variable names. This may be null indicating the desire for unconstrained output of all known variables.

void wx.PackageBuilder.PkgFrame.DisplayContent ( Build.ContentFile  fileDescr  ) 

Displays the content of the provided file in the STC-Window if applicable.

Parameters:
fileDescr Description of the file that shall be displayed.

void wx.PackageBuilder.PkgFrame.DisplayInfoSrcLeaf ( SrcLeafData  data  ) 

void wx.PackageBuilder.PkgFrame.DisplayInfoSrcNode ( SrcNodeData  data  ) 

void wx.PackageBuilder.PkgFrame.DisplayInfoTocLeaf ( TocNodeData  data  ) 

Displays data on a leaf node of the TOC tree in the HTML info control.

Parameters:
data The data to be displayed.

void wx.PackageBuilder.PkgFrame.DisplayInfoTocNode ( TocNodeData  data  ) 

Displays data on a node of the TOC tree in the HTML info control.

Parameters:
data The data to be displayed.

ICollection<PlatformDescr> wx.PackageBuilder.PkgFrame.GetPlatformsInSrc (  ) 

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

Returns:

SrcNodeData wx.PackageBuilder.PkgFrame.GetSelectedSrcData (  ) 

This returns the data that has been associated with the currently selected source node (in the corresponding tree control). This is null if the node does not have any associated content file.

Build.ContentFile wx.PackageBuilder.PkgFrame.GetSelectedSrcFile (  ) 

This returns the content file that is associated with the currently selected source node (in the corresponding tree control). This is null if the node does not have any associated content file.

wx.StyledText.StcStyleCollection wx.PackageBuilder.PkgFrame.GetStcStyle ( Build.ContentType  t  ) 

Returns a collection of STC styles to present data of the provided type in the STC view.

Parameters:
t The content type of the data to be presented.
Returns:

void wx.PackageBuilder.PkgFrame.LoadDirectoryFiles ( TreeItemId  srcNode  ) 

This will open a dialog to edit the contained mime types (extensions) and loads or removes the files in the subtree accordingly.

Parameters:
srcNode A node in the source tree control representing a directory. This will do nothing if this node is not associated with a directory.

void wx.PackageBuilder.PkgFrame.LoadSrcFiles ( ICollection< string >  filenames  ) 

Loads files whose names are listed in the argument into the tree of source files.

Parameters:
filenames Names of the files to be loaded.

bool wx.PackageBuilder.PkgFrame.Make ( Build.BuildProject  p,
bool  rebuild 
)

Builds the provided project using the settings of this application. Messages of the build process will be pasted into the log window.

Parameters:
p The project to be made
rebuild Indicates with true that the project shall be rebuilt.
Returns:
True on success

void wx.PackageBuilder.PkgFrame.OnCloseEvent ( object  sender,
Event  evt 
)

Handler of the close event. Will ask on unsaved changes.

Parameters:
sender The sender of the event. Typically, this is a wx.Window.
evt The event. In this case, this should be a wx.CloseEvent.

void wx.PackageBuilder.PkgFrame.OpenPackageFile ( string  filenamePkg,
string  destinationDir 
)

removes the current package without warning and loadsa package loaded from the provided file.

Parameters:
filenamePkg the file that contains the new package. This is either a project or a package.
destinationDir the directory where all the data will be written to. If this is null, this will load a project file.


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