Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::ProgramInfo Class Reference

This class provides a platform neutral way to access additional information about a program. More...

#include <vcf/FoundationKit/ProgramInfo.h>

Inheritance diagram for VCF::ProgramInfo:

VCF::Object VCF::PackageInfo List of all members.

Public Member Functions

 ProgramInfo (const String &programName, const String &programFileName, const String &author, const String &copyright, const String &company, const String &description, const String &programVersion, const String &fileVersion, const String &helpDirectory, const String &helpName)
String getProgramName () const
String getAuthor () const
 The name of the author of the package.
String getCopyright () const
 the copyright, if any, for the package
String getCompany () const
 The name of the company responsible for the package.
String getDescription () const
String getFileVersion () const
String getProgramVersion () const
String getProgramFileName () const
String getHelpDirectory () const
 This returns the name of the directory that the help content lives in.
String getHelpName () const
 This returns the name of the help "book".

Protected Attributes

String programName_
String programFileName_
String author_
String copyright_
String company_
String description_
String programVersion_
String fileVersion_
String helpDirectory_
String helpName_

Detailed Description

This class provides a platform neutral way to access additional information about a program.

This is information generally intended to be displayed in a human readable format.

The actual information may come from a number of different sources, some of which are platform dependant. These may include:

You should never create a new instance of this by hand. Instead you should retrieve this from the Sytem's resource bundle.
See also:
System::getResourceBundle

ResourceBundle::getProgramInfo


Constructor & Destructor Documentation

VCF::ProgramInfo::ProgramInfo const String programName,
const String programFileName,
const String author,
const String copyright,
const String company,
const String description,
const String programVersion,
const String fileVersion,
const String helpDirectory,
const String helpName
[inline]
 


Member Function Documentation

String VCF::ProgramInfo::getAuthor  )  const [inline]
 

The name of the author of the package.

String VCF::ProgramInfo::getCompany  )  const [inline]
 

The name of the company responsible for the package.

String VCF::ProgramInfo::getCopyright  )  const [inline]
 

the copyright, if any, for the package

String VCF::ProgramInfo::getDescription  )  const [inline]
 

String VCF::ProgramInfo::getFileVersion  )  const [inline]
 

String VCF::ProgramInfo::getHelpDirectory  )  const [inline]
 

This returns the name of the directory that the help content lives in.

The content may be individual HTML files (and other resources) for systems like Mac OSX, or it may be a single binary file, like a .CHM file, for Win32 systems. Typically this is not a complete path, but rather a single directory name under the main application directory, or under the appropriate resources directory. Localized help will need to be duplicated per localized resource directory.

String VCF::ProgramInfo::getHelpName  )  const [inline]
 

This returns the name of the help "book".

This may be the book name for Mac OSX, or it may be the name of the .CHM file for Win32 systems.

String VCF::ProgramInfo::getProgramFileName  )  const [inline]
 

String VCF::ProgramInfo::getProgramName  )  const [inline]
 

String VCF::ProgramInfo::getProgramVersion  )  const [inline]
 


Member Data Documentation

String VCF::ProgramInfo::author_ [protected]
 

String VCF::ProgramInfo::company_ [protected]
 

String VCF::ProgramInfo::copyright_ [protected]
 

String VCF::ProgramInfo::description_ [protected]
 

String VCF::ProgramInfo::fileVersion_ [protected]
 

String VCF::ProgramInfo::helpDirectory_ [protected]
 

String VCF::ProgramInfo::helpName_ [protected]
 

String VCF::ProgramInfo::programFileName_ [protected]
 

String VCF::ProgramInfo::programName_ [protected]
 

String VCF::ProgramInfo::programVersion_ [protected]
 


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information