programinfo.h

来自「这是VCF框架的代码」· C头文件 代码 · 共 137 行

#ifndef _VCF_PROGRAMINFO_H__
#define _VCF_PROGRAMINFO_H__

namespace VCF {
	/**
	\class ProgramInfo ProgramInfo.h "vcf/FoundationKit/ProgramInfo.h"
	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:
		\li binary resource data embedded directly into the executable
		such as Win32 resources (see VS_VERSIONINFO and GetFileVersionInfo)
		\li external files such as Mac OS X Info.plist files. 
	
	You should never create a new instance of this by hand. Instead you should 
	retrieve this from the Sytem's resource bundle.
	@see System::getResourceBundle
	@see ResourceBundle::getProgramInfo
	*/
	class FOUNDATIONKIT_API ProgramInfo : public Object {
	public:

		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):
							programName_(programName),
							programFileName_(programFileName),
							author_(author),
							copyright_(copyright),
							company_(company),
							description_(description),
							programVersion_(programVersion),
							fileVersion_(fileVersion),
							helpDirectory_(helpDirectory),
							helpName_(helpName){}



		String getProgramName() const {
			return programName_;
		}

		/**
		*The name of the author of the package
		*/
		String getAuthor()  const {
			return author_;
		}

		/**
		*the copyright, if any, for the package
		*/
		String getCopyright()  const {
			return copyright_;
		}

		/**
		*The name of the company responsible for the package
		*/
		String getCompany()  const {
			return company_;
		}

		String getDescription() const  {
			return description_;
		}

		String getFileVersion() const {
			return fileVersion_;
		}

		String getProgramVersion() const {
			return programVersion_;
		}

		String getProgramFileName() const {
			return programFileName_;	
		}

		/**
		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
		\em 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 getHelpDirectory() const {
			return helpDirectory_;	
		}

		/**
		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 getHelpName() const {
			return helpName_;	
		}
	protected:
		String programName_;
		String programFileName_;
		String author_;
		String copyright_;
		String company_;
		String description_;
		String programVersion_;
		String fileVersion_;
		String helpDirectory_;
		String helpName_;
	};


};



#endif //_VCF_PROGRAMINFO_H__