Collapse all Symbian^3 Application Developer Library

CGSBackgroundImage Class Reference

class CGSBackgroundImage : public CBase

CGSBackgroundImage is the background image API class of GS app. It provides functions to get and set background image values.

Inherits from

CGSBackgroundImage
- CBase

Public Member Functions
	~CGSBackgroundImage ()
IMPORT_C TInt	BackgroundImageL ()
IMPORT_C void	DeleteImageL (const TDesC &)
IMPORT_C TInt	GetPlnsStatus ()
IMPORT_C void	IsPersonalisationApplicationL ()
IMPORT_C CGSBackgroundImage *	NewL ()
IMPORT_C void	SetBackgroundImageL (const TInt )
IMPORT_C void	SetBackgroundImagePathL (const TDesC &)
IMPORT_C void	SetBackgroundImagePathL (const TDesC &, TDes &)
IMPORT_C void	SetBackgroundImagePathL (const TDesC &, TDes &, TGSWallpaperType )
IMPORT_C void	SetVTStillImagePathL (const TDesC &, CGSAsyncImageHandling &)
IMPORT_C void	SetWelcomeNoteImageL (const TDesC &, CGSAsyncImageHandling &)

Private Member Functions
	CGSBackgroundImage ()
void	ConstructL ()
void	LoadImageL (const TDesC &, TInt , TInt , TBool , TGSWallpaperType )
void	SaveBitmapsL ( TDes &, const TDesC &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Attributes
TInt	iPlnsInDevice

Private Attributes
CFbsBitmap *	iBitmap
RSharedDataClient *	iClient
TDisplayMode	iDisplayMode
CGSAsyncImageHandling *	iImgHandler
RLibrary	iLibrary
CRepository *	iPersonalizationRepository
RPhCltServer	iPhoneClient
CRepository *	iStartupConfRepository
CRepository *	iTelephonyRepository

Constructor & Destructor Documentation

CGSBackgroundImage()

CGSBackgroundImage

(

)

[private]

C++ default constructor.

~CGSBackgroundImage()

IMPORT_C

~CGSBackgroundImage

(

)

Destructor.

Member Functions Documentation

BackgroundImageL()

IMPORT_C TInt

BackgroundImageL

(

)

Returns background image mode.

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

DeleteImageL(const TDesC &)

IMPORT_C void

DeleteImageL

(

const TDesC &

aImagePath

)

Parameters

const TDesC & aImagePath

GetPlnsStatus()

IMPORT_C TInt

GetPlnsStatus

(

)

IsPersonalisationApplicationL()

IMPORT_C void

IsPersonalisationApplicationL

(

)

LoadImageL(const TDesC &, TInt, TInt, TBool, TGSWallpaperType)

void	LoadImageL	(	const TDesC &	aImagePath,
			TInt	aWidth,
			TInt	aHeight,
			TBool	aBgImage,
			TGSWallpaperType	aWallpaperType
		)	[private]

Parameters

const TDesC & aImagePath
TInt aWidth
TInt aHeight
TBool aBgImage
TGSWallpaperType aWallpaperType

NewL()

IMPORT_C CGSBackgroundImage *

NewL

(

)

[static]

Two-phased constructor.

SaveBitmapsL(TDes &, const TDesC &)

void	SaveBitmapsL	(	TDes &	aBmpFileName,
			const TDesC &	aOriginalFullname
		)	[private]

Parameters

TDes & aBmpFileName
const TDesC & aOriginalFullname

SetBackgroundImageL(const TInt)

IMPORT_C void

SetBackgroundImageL

(

const TInt

aImage

)

Stores background image mode to shared data.

Parameters

const TInt aImage

Background image mode.

SetBackgroundImagePathL(const TDesC &)

IMPORT_C void

SetBackgroundImagePathL

(

const TDesC &

aImagePath

)

Converts an idle background image to bitmap and scales it to fit the screen if necessary.

After successful conversion, the background image path is stored into shared data.

Parameters

const TDesC & aImagePath

Descriptor which contains the background image path. Max length is KGSMaxImagePath.

SetBackgroundImagePathL(const TDesC &, TDes &)

IMPORT_C void	SetBackgroundImagePathL	(	const TDesC &	aImagePath,
			TDes &	aBmpFileName
		)

Converts an idle background image to bitmap, scales it to fit the screen if necessary, and stores it to the given file.

Background image path is not stored into shared data, but must be set separately.

Parameters

const TDesC & aImagePath	Descriptor which contains the background image path. Max length is KGSMaxImagePath.
TDes & aBmpFileName	Descriptor which contains the bitmap file name. Converted image is again stored back in this variable.

SetBackgroundImagePathL(const TDesC &, TDes &, TGSWallpaperType)

IMPORT_C void	SetBackgroundImagePathL	(	const TDesC &	aImagePath,
			TDes &	aBmpFileName,
			TGSWallpaperType	aWallpaperType
		)

Converts the background image to bitmap, scales it to fit the screen if necessary, and stores it to the given file.

Background image path is not stored into shared data, but must be set separately.

Since: 2.6

Parameters

const TDesC & aImagePath	Descriptor which contains the background image path. Max length is KGSMaxImagePath.
TDes & aBmpFileName	Descriptor which contains the bitmap file name. Converted image is again stored back in this variable.
TGSWallpaperType aWallpaperType	Type of the wallpaper.

SetVTStillImagePathL(const TDesC &, CGSAsyncImageHandling &)

IMPORT_C void	SetVTStillImagePathL	(	const TDesC &	aImagePath,
			CGSAsyncImageHandling &	aImgHandler
		)

Set the current image path for Still Image

Parameters

const TDesC & aImagePath
CGSAsyncImageHandling & aImgHandler

SetWelcomeNoteImageL(const TDesC &, CGSAsyncImageHandling &)

IMPORT_C void	SetWelcomeNoteImageL	(	const TDesC &	aImagePath,
			CGSAsyncImageHandling &	aImgHandler
		)

Converts the welcome note image to bitmap, scales it to fit the screen if necessary. Stores the bitmap to mbm file. Stores welcome note image path to shared data.