commonfunctions.h

mopoid game symbian os application development

/*
========================================================================
 Name        : CommonFunctions.h
 Author      : 
 Copyright   : 
 Description : Useful functions that are necessary for many parts of the game.
 License   : 
 
========================================================================
*/
#ifndef COMMONFUNCTIONS_H
#define COMMONFUNCTIONS_H

// INCLUDES
#include <e32std.h>
#include <e32base.h>

#include <bautils.h>
#include <eikenv.h>
#include <eikappui.h>
#include <eikapp.h>
#include <aknutils.h>

/*! 
 @namespace NCommonFunctions
 
 @discussion Useful functions that are necessary for many parts of the game.
 */
namespace NCommonFunctions
	{
	/**
	 * Get the drive number of the drive where this application is installed
	 * (and therefore where it should put its data files)
	 * @param aFs file server session, required to get the drive name
	 * @return drive number of the drive where the app. is installed
	 */
	const TInt GetStoreDriveL(RFs& aFs);

    /**
     * Get the drive letter of the drive where this application is installed
     * (and therefore where it should put its data files)
     * @param aFs file server session, required to get the drive name
     * @return drive letter (1 char) where the app. is installed
     */
    const TChar GetStoreDriveCharL(RFs& aFs);
    
	/**
	 * Add the drive and full private path to the specified filename.
	 * The drive will be the drive where the application was installed.
	 * @param aFs file server session, required to get the drive name.
	 * @param aFilename name of the file that should be appended to the full
	 * private path.
	 * @param aCompleteName the contents of this RBuf will be reset, it is
	 * filled with the full URI of the specified filename - including
	 * the drive and private path of the application.
	 */
	const void AddPrivateDirL(RFs& aFs, const TDesC& aFilename, RBuf& aCompleteName);
	
	/**
	 * Add the drive and full path to the resource directory to the specified
	 * filename.
	 * @param aFilename name of the file that should be appended to the full
	 * resource path.
	 * @param aCompleteName the contents of this RBuf will be reset, it is
	 * filled with the full URI of the specified filename - including
	 * the drive and private path of the application.
	 */
	const void AddResourceDirL(const TDesC& aFilename, RBuf& aCompleteName);
	}

#endif // COMMONFUNCTIONS_H