// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// which accompanies this distribution, and is available

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

/**

 Gets the CEikonEnv maintained by the framework for the application. 

 This function should never be run in a thread where such a static Uikon environment 

 does not exist. Code that may run on the server side of an application server 

 is one such case.

 @return A static CEikonEnv. 

 @see CCoeEnv::Static() 

*/

inline CEikonEnv* CEikonEnv::Static()

	{ return((CEikonEnv*)(CCoeEnv::Static())); }

/** Gets the Uikon process that manages the files of applications started in this 

environment.

@return The CEikProcess object. */

inline CEikProcess* CEikonEnv::Process() const

	{ return(iProcess); }

/** Gets the application UI of the application using this CEikonEnv.

@return Pointer to the CEikAppUi. */

inline CEikAppUi* CEikonEnv::EikAppUi() const

	{ return((CEikAppUi*)iAppUi); }

inline const MEikAlertWin* CEikonEnv::Alert() const

	{ return(iAlertWin); }

/** Gets the minus nudge character, this could be the left arrow for example. 

@return Minus nudge character. */

inline TChar CEikonEnv::NudgeCharMinus() const

	{return(iNudgeChars[0]);}

/** Gets the plus nudge character, this could be the right arrow for example.

@return Plus nudge character. */

inline TChar CEikonEnv::NudgeCharPlus() const

	{return(iNudgeChars[1]);}

/** Gets the physical (TRgb) colour which corresponds to a logical colour.

@param aLogicalColor A logical colour value. 

@return The physical colour which corresponds to aLogicalColor. */

inline TRgb CEikonEnv::Color(TLogicalColor aLogicalColor) const

	{return ColorList().Color(aLogicalColor); }

/** Gets the custom colour array.

@return The custom colour array. */

inline CColorArray& CEikonEnv::CustomColorArray() const

	{return *(ColorList().ColorArray(TUid::Uid(KEikCustomColorsArrayValue)));}

/** Gets the application's colour list. 

The colour list provides member functions to retrieve and modify colours 

in the list, and to append new arrays of colours to the colour list.

@return The application's colour list */

inline CColorList& CEikonEnv::ColorList() const

	{__ASSERT_DEBUG(iColorList,User::Invariant()); return *iColorList; }

/** Sets a mapping in the application's colour list between the logical and physical 

colours specified.

@param aLogicalColor A logical colour value. 

@param aColor A physical colour value. */

inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor)

	{ ColorList().SetColor(aLogicalColor, aColor); }

inline TInt CEikonEnv::AddLibraryL(TCreateByTypeFunction aControlFactory)

	{return(AddLibraryL(aControlFactory, NULL));}

inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile)

	{return(AddLibraryL(NULL, aResourceFile));}

inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory)

	{RemoveLibrary(aControlFactory, NULL);}

inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset)

	{RemoveLibrary(NULL, aResourceFileOffset);}

/**

@publishedPartner

@deprecated

*/

inline CBase* CEikonEnv::Extension() const

	{return iExtension;}