williamr@2: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: // which accompanies this distribution, and is available williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // williamr@2: williamr@2: williamr@2: williamr@2: /** williamr@2: Gets the CEikonEnv maintained by the framework for the application. williamr@2: williamr@2: This function should never be run in a thread where such a static Uikon environment williamr@2: does not exist. Code that may run on the server side of an application server williamr@2: is one such case. williamr@2: williamr@2: @return A static CEikonEnv. williamr@2: @see CCoeEnv::Static() williamr@2: */ williamr@2: inline CEikonEnv* CEikonEnv::Static() williamr@2: { return((CEikonEnv*)(CCoeEnv::Static())); } williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline TInt CEikonEnv::EditableControlStandardHeight() const williamr@2: { return(iEditableControlStandardHeight); } williamr@2: williamr@2: /** Gets the Uikon process that manages the files of applications started in this williamr@2: environment. williamr@2: williamr@2: @return The CEikProcess object. */ williamr@2: inline CEikProcess* CEikonEnv::Process() const williamr@2: { return(iProcess); } williamr@2: williamr@2: /** Gets the application UI of the application using this CEikonEnv. williamr@2: williamr@2: @return Pointer to the CEikAppUi. */ williamr@2: inline CEikAppUi* CEikonEnv::EikAppUi() const williamr@2: { return((CEikAppUi*)iAppUi); } williamr@2: inline const MEikAlertWin* CEikonEnv::Alert() const williamr@2: { return(iAlertWin); } williamr@2: williamr@2: /** Gets the minus nudge character, this could be the left arrow for example. williamr@2: williamr@2: @return Minus nudge character. */ williamr@2: inline TChar CEikonEnv::NudgeCharMinus() const williamr@2: {return(iNudgeChars[0]);} williamr@2: williamr@2: /** Gets the plus nudge character, this could be the right arrow for example. williamr@2: williamr@2: @return Plus nudge character. */ williamr@2: inline TChar CEikonEnv::NudgeCharPlus() const williamr@2: {return(iNudgeChars[1]);} williamr@2: williamr@2: /** Gets the physical (TRgb) colour which corresponds to a logical colour. williamr@2: williamr@2: @param aLogicalColor A logical colour value. williamr@2: @return The physical colour which corresponds to aLogicalColor. */ williamr@2: inline TRgb CEikonEnv::Color(TLogicalColor aLogicalColor) const williamr@2: {return ColorList().Color(aLogicalColor); } williamr@2: williamr@2: /** Gets the custom colour array. williamr@2: williamr@2: @return The custom colour array. */ williamr@2: inline CColorArray& CEikonEnv::CustomColorArray() const williamr@2: {return *(ColorList().ColorArray(TUid::Uid(KEikCustomColorsArrayValue)));} williamr@2: williamr@2: /** Gets the application's colour list. williamr@2: williamr@2: The colour list provides member functions to retrieve and modify colours williamr@2: in the list, and to append new arrays of colours to the colour list. williamr@2: williamr@2: @return The application's colour list */ williamr@2: inline CColorList& CEikonEnv::ColorList() const williamr@2: {__ASSERT_DEBUG(iColorList,User::Invariant()); return *iColorList; } williamr@2: williamr@2: /** Sets a mapping in the application's colour list between the logical and physical williamr@2: colours specified. williamr@2: williamr@2: @param aLogicalColor A logical colour value. williamr@2: @param aColor A physical colour value. */ williamr@2: inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor) williamr@2: { ColorList().SetColor(aLogicalColor, aColor); } williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline void CEikonEnv::SetCDlgDialogFactory(MEikCDlgDialogFactory* aDialogFactory) williamr@2: {iCDlgDialogFactory=aDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline void CEikonEnv::SetPrintDialogFactory(MEikPrintDialogFactory* aDialogFactory) williamr@2: {iPrintDialogFactory=aDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline void CEikonEnv::SetFileDialogFactory(MEikFileDialogFactory* aDialogFactory) williamr@2: {iFileDialogFactory=aDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline void CEikonEnv::SetIrFactory(MEikIrFactory* aIrFactory) williamr@2: {iIrFactory=aIrFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline MEikCDlgDialogFactory* CEikonEnv::CDlgDialogFactory() const williamr@2: {return iCDlgDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline MEikPrintDialogFactory* CEikonEnv::PrintDialogFactory() const williamr@2: {return iPrintDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline MEikFileDialogFactory* CEikonEnv::FileDialogFactory() const williamr@2: {return iFileDialogFactory;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline MEikIrFactory* CEikonEnv::IrFactory() const williamr@2: {return iIrFactory;} williamr@2: williamr@2: williamr@2: inline TInt CEikonEnv::AddLibraryL(TCreateByTypeFunction aControlFactory) williamr@2: {return(AddLibraryL(aControlFactory, NULL));} williamr@2: inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile) williamr@2: {return(AddLibraryL(NULL, aResourceFile));} williamr@2: inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory) williamr@2: {RemoveLibrary(aControlFactory, NULL);} williamr@2: inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset) williamr@2: {RemoveLibrary(NULL, aResourceFileOffset);} williamr@2: williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @deprecated williamr@2: */ williamr@2: inline CBase* CEikonEnv::Extension() const williamr@2: {return iExtension;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline TInt CEikonEnv::StatusPaneCoreResId() const williamr@2: {return iStatusPaneCoreResId;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline void CEikonEnv::SetStatusPaneCoreResId(TInt aStatusPaneCoreResId) williamr@2: {iStatusPaneCoreResId=aStatusPaneCoreResId;} williamr@2: williamr@2: /** williamr@2: @publishedPartner williamr@2: @released williamr@2: */ williamr@2: inline CEikAutoMenuTitleArray* CEikonEnv::AutoMenuTitleArray() const williamr@2: {return iAutoMenuTitleArray;} williamr@2: williamr@2: inline const CEikDialog* MEikAlertWin::AsEikDialog() const williamr@2: {return (const CEikDialog*)const_cast(this)->AsEikDialog();} williamr@2: williamr@2: inline const CCoeControl* MEikAlertWin::AsCoeControl() const williamr@2: {return (const CCoeControl*)const_cast(this)->AsCoeControl();}