CEikonEnv Class Reference

#include <mw/eikenv.h>

Link against: eikcore.lib

class CEikonEnv : public CCoeEnv

Inherits from

  • CEikonEnv
    Public Member Enumerations
    enumTErrorValidity { EErrorNumValid, EErrorNumInvalid }
    Public Member Functions
    CEikonEnv()
    ~CEikonEnv()
    IMPORT_C voidAddAlertDialogLikeControlToStackL(CCoeControl *)
    IMPORT_C voidAddAppUiFactoryL(MEikAppUiFactory *)
    IMPORT_C voidAddAutoMenuTitleL(CEikAutoMenuTitle *)
    IMPORT_C voidAddDialogLikeControlToStackL(CCoeControl *)
    IMPORT_C TIntAddLibraryL(TCreateByTypeFunction, TFileName *)
    TInt AddLibraryL(TCreateByTypeFunction)
    TInt AddLibraryL(TFileName *)
    IMPORT_C voidAddPictureFactoryL(MEikPictureFactory &)
    IMPORT_C voidAddSleepingAlertDialogToStackL(CCoeControl *)
    IMPORT_C voidAddSleepingDialogToStackL(CCoeControl *)
    IMPORT_C voidAddWindowShadow(CCoeControl *)
    const MEikAlertWin *Alert()
    IMPORT_C voidAlertWin(const TDesC &)
    IMPORT_C voidAlertWin(const TDesC &, const TDesC &)
    IMPORT_C voidAllocInfoMsg()
    IMPORT_C const CFont *AnnotationFont()
    IMPORT_C CEikAppServer *AppServer()
    IMPORT_C MEikAppUiFactory *AppUiFactory()
    IMPORT_C MEikAppUiFactory *AppUiFactory(const CEikAppUi &)
    TLanguage ApplicationLanguage()
    CEikAutoMenuTitleArray *AutoMenuTitleArray()
    IMPORT_C voidBeep()
    IMPORT_C const CFbsBitmap *Bitmap(TUid)
    IMPORT_C voidBringForwards(TBool, TInt)
    IMPORT_C voidBusyMsgCancel()
    IMPORT_C voidBusyMsgL(const TDesC &)
    IMPORT_C voidBusyMsgL(const TDesC &, TGulAlignment)
    IMPORT_C voidBusyMsgL(TInt)
    IMPORT_C voidBusyMsgL(const TDesC &, TTimeIntervalMicroSeconds32)
    IMPORT_C voidBusyMsgL(const TDesC &, TGulAlignment, TTimeIntervalMicroSeconds32)
    IMPORT_C voidBusyMsgL(TInt, TTimeIntervalMicroSeconds32)
    MEikCDlgDialogFactory *CDlgDialogFactory()
    IMPORT_C RAnimDll &ClockDllL()
    TRgb Color(TLogicalColor)
    CColorList &ColorList()
    IMPORT_C TBoolConfirmLossOfAllChangesL()
    IMPORT_C voidConstructAppFromCommandLineL(const TApaApplicationFactory &, const CApaCommandLine &)
    IMPORT_C voidConstructL()
    IMPORT_C voidConstructL(TBool)
    IMPORT_C voidConstructL(TBool, TInt)
    TInt ConstructorError()
    IMPORT_C TRgbControlColor(TLogicalColor, const CCoeControl &)
    CArrayFix< TCreateByTypeFunction > *ControlFactoryFuncArray()
    IMPORT_C voidControlStackReadyL()
    IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &, TInt)
    IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &, TInt, TBool)
    IMPORT_C CGulIcon *CreateIconFromMaskedBitmapL(const CApaMaskedBitmap &)
    IMPORT_C CGulIcon *CreateIconL(const TDesC &, TInt, TInt)
    IMPORT_C CColorList *CreateSystemColorListL()
    IMPORT_C CColorList *CreateSystemColorListL(const CColorList &)
    CColorArray &CustomColorArray()
    IMPORT_C TDisplayModeDefaultDisplayMode()
    IMPORT_C const CFont *DenseFont()
    virtual IMPORT_C voidDestroyEnvironment()
    IMPORT_C voidDismissTaskList()
    IMPORT_C voidDisplayTaskList()
    IMPORT_C voidDoGetErrorText(TDes &, TInt)
    IMPORT_C TErrorValidityDoGetErrorTextAndTitle(TDes &, TInt, TInt &, TUint &, TDes &, TBool)
    IMPORT_C TBoolDocNameIsAFile()
    IMPORT_C voidDrawCursor(const CCoeControl *, const TPoint &, TInt)
    IMPORT_C voidDrawCursor(const CCoeControl *, const TPoint &, TInt, TInt, TInt)
    TInt EditableControlStandardHeight()
    CEikAppUi *EikAppUi()
    IMPORT_C MEikPictureFactory *ExtendedPictureFactory(TUid)
    CBase *Extension()
    MEikFileDialogFactory *FileDialogFactory()
    IMPORT_C const CFont *Font(const TLogicalFont &)
    IMPORT_C voidFservAllocInfoMsg()
    IMPORT_C voidGetErrorText(TDes &, TInt)
    IMPORT_C TErrorValidityGetErrorText(TDes &, TInt, TUid)
    IMPORT_C TErrorValidityGetErrorTextAndTitle(TDes &, TInt, TDes &)
    IMPORT_C voidGetPrinterNamesL(CPrinterModelList *, CDesCArray &)
    IMPORT_C const CFbsBitmap *GrayBitmap()
    virtual IMPORT_C voidHandleError(TInt)
    IMPORT_C voidHandleErrorWithContext(TInt, TInt)
    IMPORT_C voidHideCursor(const CCoeControl *)
    IMPORT_C const CFbsBitmap *HighlightedOptionBitmap()
    IMPORT_C MEikInfoDialog *InfoDialog()
    IMPORT_C voidInfoMsg(const TDesC &)
    IMPORT_C voidInfoMsg(TInt, ...)
    IMPORT_C voidInfoMsg(TInt, VA_LIST)
    IMPORT_C voidInfoMsgCancel()
    IMPORT_C voidInfoMsgWithAlignment(TGulAlignment, const TDesC &)
    IMPORT_C voidInfoMsgWithAlignment(TGulAlignment, TInt, ...)
    IMPORT_C voidInfoMsgWithAlignment(TGulAlignment, TInt, VA_LIST)
    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignment, const TDesC &, TTimeIntervalMicroSeconds32)
    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignment, TInt, TTimeIntervalMicroSeconds32, ...)
    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignment, TInt, TTimeIntervalMicroSeconds32, VA_LIST)
    IMPORT_C voidInfoMsgWithDuration(const TDesC &, TTimeIntervalMicroSeconds32)
    IMPORT_C voidInfoMsgWithDuration(TInt, TTimeIntervalMicroSeconds32, ...)
    IMPORT_C voidInfoMsgWithDuration(TInt, TTimeIntervalMicroSeconds32, VA_LIST)
    IMPORT_C voidInfoWinL(const TDesC &, const TDesC &)
    IMPORT_C voidInfoWinL(TInt, TInt)
    voidInitSystemBitmapsL()
    MEikIrFactory *IrFactory()
    IMPORT_C TBoolIsBusy()
    TBool IsEiksrvThread()
    IMPORT_C TBoolIsSystem()
    IMPORT_C TPtrCKeyPressLabel(TInt)
    IMPORT_C MLafEnv &LafEnv()
    IMPORT_C voidLaunchPopupMenuL(TInt, const TPoint &, TPopupTargetPosType, const CEikHotKeyTable *)
    IMPORT_C voidLeaveWithErrorContext(TInt, const TDesC &)
    IMPORT_C voidLeaveWithInfoMsg(TInt, ...)
    IMPORT_C const CFont *LegendFont()
    IMPORT_C CCharFormatLayer *NewDefaultCharFormatLayerL()
    IMPORT_C CParaFormatLayer *NewDefaultParaFormatLayerL()
    IMPORT_C CPrintSetup *NewDefaultPrintSetupL()
    IMPORT_C CParaFormatLayer *NewDefaultSingleLineParaFormatLayerL()
    IMPORT_C voidNotifyIdleError(TInt, TInt)
    IMPORT_C voidNotifyIdleErrorWhileRedrawing(TInt)
    TChar NudgeCharMinus()
    TChar NudgeCharPlus()
    IMPORT_C const CFbsBitmap *OptionBitmap()
    IMPORT_C const CFbsBitmap *OptionMaskBitmap()
    IMPORT_C MPictureFactory *PictureFactory()
    IMPORT_C CColorList *PopulateColorArrayL()
    voidPostAppUiDestroy()
    voidPostAppUiInitializeL()
    MEikPrintDialogFactory *PrintDialogFactory()
    CEikProcess *Process()
    IMPORT_C MEikInfoDialog *QueryDialog()
    IMPORT_C TBoolQueryWinL(const TDesC &, const TDesC &)
    IMPORT_C TBoolQueryWinL(TInt, TInt)
    IMPORT_C voidRemoveAppUiFactory()
    IMPORT_C voidRemoveFromStack(CCoeControl *)
    IMPORT_C voidRemoveLibrary(TCreateByTypeFunction, TInt)
    voidRemoveLibrary(TCreateByTypeFunction)
    voidRemoveLibrary(TInt)
    IMPORT_C voidRemovePictureFactory(TUid)
    IMPORT_C voidResolveError(TInt, TUid)
    IMPORT_C TBoolRespondsToShutdownEvent()
    IMPORT_C TBoolRespondsToSwitchFilesEvent()
    IMPORT_C voidRouseSleepingDialog(CCoeControl *, TBool)
    IMPORT_C voidSendEventToEikonServer(TInt, const TAny *, TInt)
    IMPORT_C voidSetAlertWin(MEikAlertWin *)
    IMPORT_C voidSetAppUiFactoryL(MEikAppUiFactory *)
    IMPORT_C voidSetAutoForwarding(TBool)
    IMPORT_C voidSetBusy(TBool)
    voidSetCDlgDialogFactory(MEikCDlgDialogFactory *)
    voidSetColor(TLogicalColor, TRgb)
    IMPORT_C voidSetDebugKeys(MEikDebugKeys *)
    IMPORT_C voidSetDocNameIsAFile(TBool)
    IMPORT_C voidSetExtension(CBase *)
    voidSetFileDialogFactory(MEikFileDialogFactory *)
    IMPORT_C voidSetInfoDialog(MEikInfoDialog *)
    voidSetIrFactory(MEikIrFactory *)
    voidSetPrintDialogFactory(MEikPrintDialogFactory *)
    IMPORT_C voidSetQueryDialog(MEikInfoDialog *)
    IMPORT_C voidSetRequestInfoDialogFunc(TRequestDialogFunc)
    IMPORT_C voidSetRequestQueryDialogFunc(TRequestDialogFunc)
    IMPORT_C voidSetRespondsToShutdownEvent(TBool)
    IMPORT_C voidSetRespondsToSwitchFilesEvent(TBool)
    voidSetStatusPaneCoreResId(TInt)
    IMPORT_C voidSetSystem(TBool)
    IMPORT_C voidSetVerboseInfoReporting(TBool)
    IMPORT_C TBoolStartedAsServerApp()
    CEikonEnv *Static()
    TInt StatusPaneCoreResId()
    IMPORT_C const CFont *SymbolFont()
    IMPORT_C CCharFormatLayer *SystemCharFormatLayerL()
    IMPORT_C CParaFormatLayer *SystemParaFormatLayerL()
    IMPORT_C CParaFormatLayer *SystemSingleLineParaFormatLayerL()
    IMPORT_C const CFbsBitmap *TexturedBitmap()
    IMPORT_C const CFont *TitleFont()
    voidUpdateColorListL()
    IMPORT_C voidUpdateSystemColorListL(const CColorList &)
    IMPORT_C voidUpdateSystemFontsL()
    IMPORT_C voidUpdateTaskNameL()
    IMPORT_C voidVerboseInfoMsg(const TDesC &)
    IMPORT_C TVersionVersion()
    IMPORT_C TEikVirtualCursor &VirtualCursor()
    IMPORT_C voidWriteInternalStateOfStackedControlsL()
    IMPORT_C voidWservAllocInfoMsg()
    Inherited Attributes
    CActive::iStatus
    CCoeEnv::iAppUi
    CCoeEnv::iFsSession
    CCoeEnv::iLastEvent
    CCoeEnv::iNormalFont
    CCoeEnv::iResourceFileArray
    CCoeEnv::iRootWin
    CCoeEnv::iScreen
    CCoeEnv::iSystemGc
    CCoeEnv::iWsSession
    Inherited Enumerations
    CActive:TPriority
    Inherited Functions
    CActive::CActive(TInt)
    CActive::Cancel()
    CActive::Deque()
    CActive::Extension_(TUint,TAny *&,TAny *)
    CActive::IsActive()const
    CActive::IsAdded()const
    CActive::Priority()const
    CActive::SetActive()
    CActive::SetPriority(TInt)
    CActive::~CActive()
    CBase::CBase()
    CBase::Delete(CBase *)
    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()
    CCoeEnv::AddFepObserverL(MCoeFepObserver &)
    CCoeEnv::AddFocusObserverL(MCoeFocusObserver &)
    CCoeEnv::AddForegroundObserverL(MCoeForegroundObserver &)
    CCoeEnv::AddMessageMonitorObserverL(MCoeMessageMonitorObserver &)
    CCoeEnv::AddMessageObserverL(MCoeMessageObserver &)
    CCoeEnv::AddObserverOfLoadedFepL(MCoeObserverOfLoadedFep &)
    CCoeEnv::AddResourceChangeObserverL(MCoeResourceChangeObserver &)
    CCoeEnv::AddResourceFileL(const TDesC &)
    CCoeEnv::AddStatic(CCoeStatic *)
    CCoeEnv::AllocReadResourceAsDes16L(TInt)const
    CCoeEnv::AllocReadResourceAsDes16LC(TInt)const
    CCoeEnv::AllocReadResourceAsDes8L(TInt)const
    CCoeEnv::AllocReadResourceAsDes8LC(TInt)const
    CCoeEnv::AllocReadResourceL(TInt)const
    CCoeEnv::AllocReadResourceLC(TInt)const
    CCoeEnv::AppStartupInstrumentationEventIdBase()
    CCoeEnv::AppUi()const
    CCoeEnv::AvailableFepsL(RArray< TUid > &,CDesCArray *)
    CCoeEnv::BringOwnerToFront()
    CCoeEnv::CCoeEnv()
    CCoeEnv::CoeEnvConstructorError()const
    CCoeEnv::ConstructL(TBool,TInt,TInt)
    CCoeEnv::ControlStateChange()
    CCoeEnv::CreateDeviceFontL(CGraphicsDevice *,const TFontSpec &)
    CCoeEnv::CreateGcL()
    CCoeEnv::CreateResourceReaderLC(TResourceReader &,TInt)const
    CCoeEnv::CreateScreenFontL(const TFontSpec &)
    CCoeEnv::DefaultFontProvider()const
    CCoeEnv::DefaultTextDrawer()const
    CCoeEnv::DeleteResourceFile(TInt)
    CCoeEnv::DestroyEnvironmentEnd()
    CCoeEnv::DestroyEnvironmentStatic()
    CCoeEnv::DisableExitChecks(TBool)
    CCoeEnv::DisableShutdownChecks()const
    CCoeEnv::DoCancel()
    CCoeEnv::DoFlush()
    CCoeEnv::EnsureCorrectFepIsLoadedL()
    CCoeEnv::EnsureSpecifiedFepIsLoadedL(TUid)
    CCoeEnv::ErrorContextText()
    CCoeEnv::ErrorText()
    CCoeEnv::Execute()
    CCoeEnv::ExecuteD()
    CCoeEnv::ExecuteFepSettingsDialogL(TUid)
    CCoeEnv::Fep()const
    CCoeEnv::FepUid()const
    CCoeEnv::FindStatic(TUid)
    CCoeEnv::Flush(TTimeIntervalMicroSeconds32)
    CCoeEnv::FocusObserverNotificationIdentifier()const
    CCoeEnv::FocusObserverNotificationIsStillPending(TInt)const
    CCoeEnv::ForEachFepObserverCall(TCoeFepObserverFunction)
    CCoeEnv::Format128(TDes &,TInt,...)
    CCoeEnv::Format256(TDes &,TInt,...)
    CCoeEnv::FsSession()const
    CCoeEnv::GetMessageNotifyingObserversLC(TUint32,TUid &,TPtr8 &,const TWsEvent &)
    CCoeEnv::InitViewServerSessionL(MVwsSessionWrapperObserver &)
    CCoeEnv::InputCapabilitiesChanged()
    CCoeEnv::InstallFepL(TUid)
    CCoeEnv::InstallFepL(TUid,const TBool)
    CCoeEnv::IsRedrawEventPending()const
    CCoeEnv::IsResourceAvailableL(TInt)const
    CCoeEnv::IsSchedulerRunning()const
    CCoeEnv::IsWservEventPending()const
    CCoeEnv::LastEvent()const
    CCoeEnv::LeaveWithErrorText(const TDesC &,const TDesC *)
    CCoeEnv::MopSupplyObject(TTypeUid)
    CCoeEnv::NormalFont()const
    CCoeEnv::NotifyFocusObserversOfDestructionOfFocusedItem()
    CCoeEnv::NotifyForegroundObserversOfGainingForeground()
    CCoeEnv::NotifyForegroundObserversOfLosingForeground()
    CCoeEnv::NotifyMessageMonitorObserversOfEvent(const TWsEvent &)
    CCoeEnv::NotifyResourceObserversOfChangeInResource()
    CCoeEnv::PrepareToExit()
    CCoeEnv::QueueNotificationToFocusObserversOfChangeInFocus()
    CCoeEnv::ReadDesC16ArrayResourceL(TInt)
    CCoeEnv::ReadDesC8ArrayResourceL(TInt)
    CCoeEnv::ReadDesCArrayResourceL(TInt)
    CCoeEnv::ReadResource(TDes &,TInt)const
    CCoeEnv::ReadResourceAsDes16(TDes16 &,TInt)const
    CCoeEnv::ReadResourceAsDes16L(TDes16 &,TInt)const
    CCoeEnv::ReadResourceAsDes8(TDes8 &,TInt)const
    CCoeEnv::ReadResourceAsDes8L(TDes8 &,TInt)const
    CCoeEnv::ReadResourceL(TDes &,TInt)const
    CCoeEnv::RefetchPixelMappingL()
    CCoeEnv::ReleaseScreenFont(CFont *)const
    CCoeEnv::RemoveFepObserver(MCoeFepObserver &)
    CCoeEnv::RemoveFocusObserver(MCoeFocusObserver &)
    CCoeEnv::RemoveForegroundObserver(MCoeForegroundObserver &)
    CCoeEnv::RemoveMessageMonitorObserver(MCoeMessageMonitorObserver &)
    CCoeEnv::RemoveMessageObserver(MCoeMessageObserver &)
    CCoeEnv::RemoveObserverOfLoadedFep(MCoeObserverOfLoadedFep &)
    CCoeEnv::RemoveResourceChangeObserver(MCoeResourceChangeObserver &)
    CCoeEnv::RootWin()const
    CCoeEnv::RootWin(TInt)const
    CCoeEnv::RunL()
    CCoeEnv::ScreenDevice()const
    CCoeEnv::ScreenDevice(TInt)const
    CCoeEnv::SetAppStartupInstrumentationEventIdBaseL(TInt)
    CCoeEnv::SetAppUi(CCoeAppUi *)
    CCoeEnv::SetZoomFactor(const TZoomFactor &)
    CCoeEnv::SimulateKeyEventL(const TKeyEvent &,TEventCode)
    CCoeEnv::Static(TUid)
    CCoeEnv::SupportedPointers()const
    CCoeEnv::SuppressNextFlush()
    CCoeEnv::SwapSystemGc(CWindowGc *)
    CCoeEnv::SyncNotifyFocusObserversOfChangeInFocus()
    CCoeEnv::SystemGc()const
    CCoeEnv::WsSession()const
    CCoeEnv::ZoomFactor()const
    CCoeEnv::~CCoeEnv()

    Detailed Description

    An environment for creating controls and utility functions for manipulating them.

    Every GUI application is provided with an instance of CEikonEnv by the framework, which can be accessed through either CEikonEnv::Static() or the iEikonEnv macro of CEikApplication.

    Member Enumeration Documentation

    Enum TErrorValidity

    EnumeratorValueDescription
    EErrorNumValid
    EErrorNumInvalid

    Constructor & Destructor Documentation

    CEikonEnv ( )

    IMPORT_CCEikonEnv()

    Default C++ constructor.

    Allocates memory for the new CEikonEnv object; invoke using new(ELeave). The second phase constructor should be called after the constructor for the environment to be correctly initialised.

    ~CEikonEnv ( )

    IMPORT_C~CEikonEnv()

    Destructor

    Frees any resources allocated by this CEikonEnv during construction.

    Member Function Documentation

    AddAlertDialogLikeControlToStackL ( CCoeControl * )

    IMPORT_C voidAddAlertDialogLikeControlToStackL(CCoeControl *aControl)

    Adds an alert dialog-like control (with a control stack priority of ECoeStackPriorityAlert) to the control stack.

    Alert dialogs are used to indicate errors to the user.

    It leaves with no alert if a control with a priority between ECoeStackPriorityAlert and ECoeStackPriorityFep is already being displayed by the appUi.

    ParameterDescription
    aControlThe control to add.

    AddAppUiFactoryL ( MEikAppUiFactory * )

    IMPORT_C voidAddAppUiFactoryL(MEikAppUiFactory *aAppUiFactory)

    AddAutoMenuTitleL ( CEikAutoMenuTitle * )

    IMPORT_C voidAddAutoMenuTitleL(CEikAutoMenuTitle *aTitle)

    Adds a menu title to the menu bar for all applications.

    Takes ownership of aTitle at the end of the function. Push the CEikAutoMenuTitle object on the cleanup stack before calling this method, and pop it after.

    ParameterDescription
    aTitleMenu title to add to all applications' menu bars.

    AddDialogLikeControlToStackL ( CCoeControl * )

    IMPORT_C voidAddDialogLikeControlToStackL(CCoeControl *aControl)

    Adds a dialog-like control (with a control stack priority of ECoeStackPriorityDialog) to the control stack.

    It leaves with no alert if a control with a priority between ECoeStackPriorityDialog and ECoeStackPriorityFep is already being displayed by the appUi.

    ParameterDescription
    aControlThe control to add.

    AddLibraryL ( TCreateByTypeFunction, TFileName * )

    IMPORT_C TIntAddLibraryL(TCreateByTypeFunctionaControlFactory,
    TFileName *aResourceFile
    )

    Adds the control factory and resource file to the Eikon Environment. This function does not add the control factory if it is NULL.

    ParameterDescription
    aControlFactoryControl factory that has to be added to the Eikon Environment.
    aResourceFileResource file that has to be added to the Eikon Environment.

    Returns: Zero, if the resource file is NULL otherwise the offset value defined for this resource file.

    AddLibraryL ( TCreateByTypeFunction )

    TInt AddLibraryL(TCreateByTypeFunctionaControlFactory)[inline]

    AddLibraryL ( TFileName * )

    TInt AddLibraryL(TFileName *aResourceFile)[inline]

    AddPictureFactoryL ( MEikPictureFactory & )

    IMPORT_C voidAddPictureFactoryL(MEikPictureFactory &aFactory)

    Adds the picture factory to the set of factories maintained by the Uikon environment.

    ParameterDescription
    aFactoryThe picture factory to add.

    AddSleepingAlertDialogToStackL ( CCoeControl * )

    IMPORT_C voidAddSleepingAlertDialogToStackL(CCoeControl *aControl)

    Adds a sleeping dialog to the control stack, with a control stack priority of ECoeStackPriorityAlert.

    Sleeping dialogs pre-allocate their resources - they are not initially visible.

    ParameterDescription
    aControlThe control to add.

    AddSleepingDialogToStackL ( CCoeControl * )

    IMPORT_C voidAddSleepingDialogToStackL(CCoeControl *aControl)

    Adds a sleeping dialog to the control stack, with a control stack priority of ECoeStackPriorityDialog.

    Sleeping dialogs pre-allocate their resources - they are not initially visible.

    ParameterDescription
    aControlThe control to add.

    AddWindowShadow ( CCoeControl * )

    IMPORT_C voidAddWindowShadow(CCoeControl *aWinArea)[static]

    Adds a window shadow of the standard height to a control.

    Alert ( )

    const MEikAlertWin *Alert()const [inline]

    AlertWin ( const TDesC & )

    IMPORT_C voidAlertWin(const TDesC &aMsg)

    Displays the environment's alert window containing a single line message.

    ParameterDescription
    aMsgMessage to be displayed in the alert window.

    AlertWin ( const TDesC &, const TDesC & )

    IMPORT_C voidAlertWin(const TDesC &aMsg1,
    const TDesC &aMsg2
    )

    Displays an alert window with a brief message.

    ParameterDescription
    aMsg1First line of the message.
    aMsg2Second line of the message.

    AllocInfoMsg ( )

    IMPORT_C voidAllocInfoMsg()

    Constructs an allocation information message.

    The message includes the total number of cells allocated on the current thread's heap and the total space allocated to them.

    AnnotationFont ( )

    IMPORT_C const CFont *AnnotationFont()const

    Gets the standard annotation font for this environment.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    Returns: Pointer to the annotation font.

    AppServer ( )

    IMPORT_C CEikAppServer *AppServer()const

    Gets required application server for running the application.

    Returns: Pointer to the application server which is derived from CEikAppServer.

    AppUiFactory ( )

    IMPORT_C MEikAppUiFactory *AppUiFactory()const

    Gets the application UI factory object.

    This object implements the MEikAppUiFactory interface.

    Returns: App UI factory interface or NULL.

    AppUiFactory ( const CEikAppUi & )

    IMPORT_C MEikAppUiFactory *AppUiFactory(const CEikAppUi &aAppUi)const

    Gets the application UI factory object for the specified app UI.

    If the specified app UI does not exist in this environment, the function returns NULL. Otherwise the function returns an object which implements the MEikAppUiFactory interface.

    ParameterDescription
    aAppUiThe app UI for this application.

    Returns: The app UI factory object, or NULL if aAppUi does't exist in this environment.

    ApplicationLanguage ( )

    TLanguage ApplicationLanguage()const

    AutoMenuTitleArray ( )

    CEikAutoMenuTitleArray *AutoMenuTitleArray()const [inline]

    Beep ( )

    IMPORT_C voidBeep()[static]

    Emits a beep.

    This method is deprecated.

    Deprecated

    Bitmap ( TUid )

    IMPORT_C const CFbsBitmap *Bitmap(TUidaUidBmp)const

    Gets the specified bitmap.

    This function returns a bitmap from the list of bitmaps by using the UID as an index.

    ParameterDescription
    aUidBmpThe UID of the bitmap to retrieve.

    Returns: Pointer to the bitmap.

    BringForwards ( TBool, TInt )

    IMPORT_C voidBringForwards(TBoolaForwards,
    TIntaPriority = ECoeWinPriorityAlwaysAtFront
    )

    Repositions the root window group in the stacking hierarchy, or pushes it to the back.

    Calls to this function are ignored if the autoforward flag is set to ETrue.

    ParameterDescription
    aForwardsETrue to reposition the root window group at aPriority. EFalse to push the root window group to the back.
    aPriorityIf aForwards is ETrue then this argument determines where the root window group is placed in the stacking hierarchy.

    BusyMsgCancel ( )

    IMPORT_C voidBusyMsgCancel()

    Cancels any existing busy message.

    BusyMsgL ( const TDesC & )

    IMPORT_C voidBusyMsgL(const TDesC &aDes)

    Displays a flashing busy message in the system default corner of the screen.

    ParameterDescription
    aDesMessage to display.

    BusyMsgL ( const TDesC &, TGulAlignment )

    IMPORT_C voidBusyMsgL(const TDesC &aDes,
    TGulAlignmentaCorner
    )

    Displays a flashing busy message in the specified corner of the screen.

    ParameterDescription
    aDesMessage to display.
    aCornerCorner of the screen in which to display the message.

    BusyMsgL ( TInt )

    IMPORT_C voidBusyMsgL(TIntaResourceId)

    Displays a flashing busy message in the system default corner of the screen.

    The message's text is read from resource.

    ParameterDescription
    aResourceIdID of the resource that specifies the text to display.

    BusyMsgL ( const TDesC &, TTimeIntervalMicroSeconds32 )

    IMPORT_C voidBusyMsgL(const TDesC &aDes,
    TTimeIntervalMicroSeconds32aInitialDelay
    )

    Displays a flashing busy message in the system default corner of the screen for a specific amount of time.

    ParameterDescription
    aDesMessage to display.
    aInitialDelayDelay in microseconds before the message is first shown.

    BusyMsgL ( const TDesC &, TGulAlignment, TTimeIntervalMicroSeconds32 )

    IMPORT_C voidBusyMsgL(const TDesC &aDes,
    TGulAlignmentaCorner,
    TTimeIntervalMicroSeconds32aInitialDelay
    )

    Displays a flashing busy message for a specific amount of time in the corner of the screen indicated by aCorner.

    ParameterDescription
    aDesMessage to display.
    aCornerCorner of the screen in which to display the message.
    aInitialDelayDelay in microseconds before the message is first shown.

    BusyMsgL ( TInt, TTimeIntervalMicroSeconds32 )

    IMPORT_C voidBusyMsgL(TIntaResourceId,
    TTimeIntervalMicroSeconds32aInitialDelay
    )

    Displays a flashing busy message in the system default corner of the screen for a specific amount of time.

    The message's text is read from resource.

    ParameterDescription
    aResourceIdThe ID of a text resource specifying the message text.
    aInitialDelayDelay in microseconds before the message is first shown.

    CDlgDialogFactory ( )

    MEikCDlgDialogFactory *CDlgDialogFactory()const [inline]

    ClockDllL ( )

    IMPORT_C RAnimDll &ClockDllL()

    Gets the animated DLL that is used to animate the toolbar clock of the application using this CEikonEnv.

    Returns: Reference to the RAnimDll.

    Color ( TLogicalColor )

    TRgb Color(TLogicalColoraLogicalColor)const [inline]

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

    ParameterDescription
    aLogicalColorA logical colour value.

    Returns: The physical colour which corresponds to aLogicalColor.

    ColorList ( )

    CColorList &ColorList()const [inline]

    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.

    Returns: The application's colour list

    ConfirmLossOfAllChangesL ( )

    IMPORT_C TBoolConfirmLossOfAllChangesL()const

    Displays a dialog asking the user to confirm that all changes will be lost to the current document, and returns the response.

    Returns: Whether the user wants to lose all changes.

    ConstructAppFromCommandLineL ( const TApaApplicationFactory &, const CApaCommandLine & )

    IMPORT_C voidConstructAppFromCommandLineL(const TApaApplicationFactory &aApplicationFactory,
    const CApaCommandLine &aCommandLine
    )

    Initialises an application

    Constructs a new application consisting of a CEikAppUi, a CEikApplication, and a CEikDocument. The new application starts with a new controlling process and runs in this Uikon environment. The new application is passed any command line file using the function CEikAppUi::ProcessCommandParametersL().

    See also: TApaApplicationFactory

    ParameterDescription
    aApplicationFactoryThe factory to use to create the application
    aCommandLineThe command line used to initialise the new application.

    ConstructL ( )

    IMPORT_C voidConstructL()

    Reimplemented from CCoeEnv::ConstructL()

    Second-phase constructor.

    This calls the next overload with ETrue as the parameter.

    ConstructL ( TBool )

    IMPORT_C voidConstructL(TBoolaInitialFocusState)

    Reimplemented from CCoeEnv::ConstructL(TBool)

    Second-phase constructor.

    Calls the next overload with a default window group ID which will be ignored.

    ParameterDescription
    aInitialFocusStateThe window group's initial focus state. If ETrue, keyboard focus is enabled, if EFalse, keyboard focus is disabled.

    ConstructL ( TBool, TInt )

    IMPORT_C voidConstructL(TBoolaInitialFocusState,
    TIntaWindowGroupID
    )

    Second-phase constructor.

    ParameterDescription
    aInitialFocusStateThe window group's initial focus state. If ETrue, keyboard focus is enabled, if EFalse, keyboard focus is disabled.
    aWindowGroupIDThe window group ID of the parent window

    ConstructorError ( )

    TInt ConstructorError()const

    ControlColor ( TLogicalColor, const CCoeControl & )

    IMPORT_C TRgbControlColor(TLogicalColoraLogicalColor,
    const CCoeControl &aControl
    )const

    Gets the physical (TRgb) colour which corresponds to the logical colour specified from the application's colour list.

    If the colour of the control specified in aControl has been overridden using CCoeControl::OverrideColorL(), this function will return the overridden colour.

    ParameterDescription
    aLogicalColorA logical colour value.
    aControlA pointer to the control itself.

    Returns: The physical colour which corresponds to aLogicalColor.

    ControlFactoryFuncArray ( )

    CArrayFix< TCreateByTypeFunction > *ControlFactoryFuncArray()const

    Returns control factory function array (pointer)

    ControlStackReadyL ( )

    IMPORT_C voidControlStackReadyL()

    Called by the framework to finish environment construction once the control stack has been created and is ready.

    CreateBitmapL ( const TDesC &, TInt )

    IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &aFileName,
    TIntaId
    )

    Loads, allocates and returns a pointer to a bitmap loaded from a multi-bitmap file (.mbm).

    If aFileName is an empty TDesC, then a default value of z:.mbm is used. If the default can't be found the alternative default location z:.mbm will be used. If a wildcard character ("*") is specified as the file name, the default application resource file will be used.

    If the function leaves it will also display an error dialog to the user.

    ParameterDescription
    aFileNameFile name specifying the bitmap file to load.
    aIdNumber of the bitmap in the file.

    Returns: Pointer to the loaded bitmap. Ownership is transferred to the caller.

    CreateBitmapL ( const TDesC &, TInt, TBool )

    IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &aFileName,
    TIntaId,
    TBoolaShowDlgIfErr
    )

    Loads, allocates and returns a pointer to a bitmap loaded from a multi-bitmap file (.mbm).

    If aFileName is an empty TDesC, then a default value of z:.mbm is used. If the default can't be found the alternative default location z:.mbm will be used. If a wildcard character ("*") is specified as the file name, the default application resource file will be used.

    ParameterDescription
    aFileNameFile name specifying the bitmap file to load.
    aIdNumber of the bitmap in the file.
    aShowDlgIfErrIf true then the function will also display an error dialog if it leaves.

    Returns: Pointer to the loaded bitmap. Ownership is transferred to the caller.

    CreateIconFromMaskedBitmapL ( const CApaMaskedBitmap & )

    IMPORT_C CGulIcon *CreateIconFromMaskedBitmapL(const CApaMaskedBitmap &aApaMaskedBitmap)[static]

    Creates an icon from a masked bitmap.

    The icon is created by copying the image bitmap and mask from the masked bitmap aApaMaskedBitmap. It returns a pointer to the icon and transfers ownership to the caller.

    ParameterDescription
    aApaMaskedBitmapThe masked bitmap from which the icon is created.

    Returns: Pointer to the icon.

    CreateIconL ( const TDesC &, TInt, TInt )

    IMPORT_C CGulIcon *CreateIconL(const TDesC &aFileName,
    TIntaBitmapId,
    TIntaMaskId =  KErrNotFound
    )

    Creates an icon.

    The icon is created by loading the image bitmap identified by aBitmapId and the mask identified by aMaskId from the resource file aFileName. It returns a pointer to the icon and transfers ownership.

    ParameterDescription
    aFileNameThe resource file name. If this is zero, the Uikon resource file will be used. If the wildcard character ('*') is specified, the default application resource file will be used.
    aBitmapIdThe bitmap ID.
    aMaskIdThe bitmap mask ID.

    Returns: Pointer to the created icon.

    CreateSystemColorListL ( )

    IMPORT_C CColorList *CreateSystemColorListL()

    Creates and returns a system colour list, which is a palette of standard colours used by the system.

    The list is read from a system colour scheme file. The function returns NULL if no such file can be found. In this case, clients are expected to create the list using some other means (typically from a resource file).

    Returns: Pointer to the system colour list, or NULL.

    CreateSystemColorListL ( const CColorList & )

    IMPORT_C CColorList *CreateSystemColorListL(const CColorList &aColorList)

    Creates and returns a system colour list, which is a palette of standard colours used by the system, and merges it with the colour list specified. CColorList::AddColorArrayL() should be called before this function.

    ParameterDescription
    aColorListThe color list to merge in.

    Returns: Pointer to the system colour list.

    CustomColorArray ( )

    CColorArray &CustomColorArray()const [inline]

    Gets the custom colour array.

    Returns: The custom colour array.

    DefaultDisplayMode ( )

    IMPORT_C TDisplayModeDefaultDisplayMode()const

    Gets the default display mode for the window server session with the maximum possible number of colours.

    Returns: Default display mode.

    DenseFont ( )

    IMPORT_C const CFont *DenseFont()const

    Gets the standard dense font for this environment.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    Returns: Pointer to the dense font.

    DestroyEnvironment ( )

    IMPORT_C voidDestroyEnvironment()[virtual]

    Framework function

    DismissTaskList ( )

    IMPORT_C voidDismissTaskList()

    Causes the task list, if displayed, to be closed.

    DisplayTaskList ( )

    IMPORT_C voidDisplayTaskList()

    Displays tasks present in the Task List.

    DoGetErrorText ( TDes &, TInt )

    IMPORT_C voidDoGetErrorText(TDes &aDes,
    TIntaError
    )const

    Exported for testing only.

    DoGetErrorTextAndTitle ( TDes &, TInt, TInt &, TUint &, TDes &, TBool )

    IMPORT_C TErrorValidityDoGetErrorTextAndTitle(TDes &aErrorText,
    TIntaError,
    TInt &aTextId,
    TUint &aFlags,
    TDes &aTitleText,
    TBoolaIsMemoryAllocatedByErrResolver = EFalse
    )const

    N.B. This method is also called from the CTextResolver::DoResolveErrorStringL() in the textresolver.cpp, located in the tools/s60_header_compat component, part of the CoreOS agreement.

    ParameterDescription
    aErrorTextOn return, contains the error text.
    aErrorError number.
    aTextIdOutput parameter - Error Text Resource Id.
    aFlagsOutput parameter - Error Resource Flag.
    aTitleTextOn return, contains the title text of the error.
    aIsMemoryAllocatedByErrResolveris mainly used by the CTextResolver::DoResolveErrorStringL() to indicate that memory for error text is unlimited, ie., the memory for the error text is allocated by the text resolver. By default it is EFalse.

    Returns: EErrorNumValid if the error code is valid, EErrorNumInvalid if the error code is invalid.

    DocNameIsAFile ( )

    IMPORT_C TBoolDocNameIsAFile()const

    Tests whether the document name is a file.

    Returns: ETrue if the document name is a file. EFalse otherwise.

    DrawCursor ( const CCoeControl *, const TPoint &, TInt )

    IMPORT_C voidDrawCursor(const CCoeControl *aControl,
    const TPoint &aPosition,
    TIntaWidth
    )

    Calls the other overload of DrawCursor() using the environment's standard screen font for the cursor's ascent and height.

    ParameterDescription
    aControlControl to draw in.
    aPositionPosition of the cursor's baseline in the control's co-ordinate space.
    aWidthCursor width.

    DrawCursor ( const CCoeControl *, const TPoint &, TInt, TInt, TInt )

    IMPORT_C voidDrawCursor(const CCoeControl *aControl,
    const TPoint &aPosition,
    TIntaWidth,
    TIntaAscent,
    TIntaHeight
    )

    Draws the text cursor into a control with the specified position and width.

    The cursor's height and ascent are by default suitable for this CEikonEnv's normal font. If aControl is not focused when this function is called, a panic is raised.

    ParameterDescription
    aControlControl to draw into.
    aPositionPosition of the cursor's baseline in the control's co-ordinate space.
    aWidthCursor width.
    aAscentCursor ascent.
    aHeightCursor height.

    EditableControlStandardHeight ( )

    TInt EditableControlStandardHeight()const [inline]

    EikAppUi ( )

    CEikAppUi *EikAppUi()const [inline]

    Gets the application UI of the application using this CEikonEnv.

    Returns: Pointer to the CEikAppUi.

    ExtendedPictureFactory ( TUid )

    IMPORT_C MEikPictureFactory *ExtendedPictureFactory(TUidaPictureType)const

    Gets a picture factory object in the environment which supports the specified picture type.

    If none exists, then the function returns NULL.

    ParameterDescription
    aPictureTypeThe picture type.

    Returns: A picture factory which supports the picture type aPictureType. NULL if no such factory exists in this environment.

    Extension ( )

    CBase *Extension()const [inline]

    DeprecatedWARNING: For internal use ONLY. Compatibility is not guaranteed in future releases.

    FileDialogFactory ( )

    MEikFileDialogFactory *FileDialogFactory()const [inline]

    Font ( const TLogicalFont & )

    IMPORT_C const CFont *Font(const TLogicalFont &aLogicalFont)const

    Gets the nearest match to the specified font.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    The return value is never NULL.

    ParameterDescription
    aLogicalFontThe font for which a match is sought.

    Returns: Pointer to the font that most closely matches aLogicalFont.

    FservAllocInfoMsg ( )

    IMPORT_C voidFservAllocInfoMsg()

    Creates a file server allocation information message from resource.

    The message indicates the number of resources currently open for the file server session.

    GetErrorText ( TDes &, TInt )

    IMPORT_C voidGetErrorText(TDes &aDes,
    TIntaError
    )const

    Gets the text for a standard error code.

    ParameterDescription
    aDesOn return, contains the error text.
    aErrorError code.

    GetErrorText ( TDes &, TInt, TUid )

    IMPORT_C TErrorValidityGetErrorText(TDes &aErrorText,
    TIntaError,
    TUidaAppUid
    )const

    Gets the text for an error code, in the specified application.

    It returns whether the error code is valid or not.

    ParameterDescription
    aErrorTextOn return, contains the error text.
    aErrorError number.
    aAppUidApplication UID.

    Returns: EErrorNumValid if the error code is valid, EErrorNumInvalid if the error code is invalid.

    GetErrorTextAndTitle ( TDes &, TInt, TDes & )

    IMPORT_C TErrorValidityGetErrorTextAndTitle(TDes &aErrorText,
    TIntaError,
    TDes &aTitleText
    )const

    Gets the text for an error code, in the specified application.

    It returns whether the error code is valid or not.

    ParameterDescription
    aErrorTextOn return, contains the error text.
    aErrorError number.
    aTitleTextOn return, contains the title text of the error.

    Returns: EErrorNumValid if the error code is valid, EErrorNumInvalid if the error code is invalid.

    GetPrinterNamesL ( CPrinterModelList *, CDesCArray & )

    IMPORT_C voidGetPrinterNamesL(CPrinterModelList *aModelNameList,
    CDesCArray &aPrinterNameList
    )[static]

    Gets the printer names from a CPrinterModelList.

    The printer names are returned through aPrinterNameList.

    ParameterDescription
    aModelNameListInput list of printer model information.
    aPrinterNameListOn return, contains all the printer names from aModelNameList.

    GrayBitmap ( )

    IMPORT_C const CFbsBitmap *GrayBitmap()const

    HandleError ( TInt )

    IMPORT_C voidHandleError(TIntaError)[virtual]

    Reimplemented from CCoeEnv::HandleError(TInt)

    Handles an error that has occurred in the application.

    It first offers the error to the app UI's HandleError() function. If that does not handle it, this function displays an alert window or an info message containing some appropriate text, read from a system resource file.

    ParameterDescription
    aErrorOne of the standard system error codes.

    HandleErrorWithContext ( TInt, TInt )

    IMPORT_C voidHandleErrorWithContext(TIntaError,
    TIntaContextResourceId
    )

    Handles the specified error.

    This function reads the error context text from the resource identified by aContextResourceId.

    ParameterDescription
    aErrorID of the error to handle.
    aContextResourceIdID of the resource from which the context is read.

    HideCursor ( const CCoeControl * )

    IMPORT_C voidHideCursor(const CCoeControl *aControl)

    Removes the text cursor from a control.

    In debug builds, a panic is raised when this function is called on a control which is not the cursor owner.

    ParameterDescription
    aControlControl owning the cursor.

    HighlightedOptionBitmap ( )

    IMPORT_C const CFbsBitmap *HighlightedOptionBitmap()const

    InfoDialog ( )

    IMPORT_C MEikInfoDialog *InfoDialog()const

    Gets the info dialog for this environment.

    Returns: The info dialog.

    InfoMsg ( const TDesC & )

    IMPORT_C voidInfoMsg(const TDesC &aDes)

    Displays a message in the system default corner of the screen.

    The message disappears after a few seconds.

    ParameterDescription
    aDesThe message to display.

    InfoMsg ( TInt, ... )

    IMPORT_C voidInfoMsg(TIntaResourceId,
    ...
    )

    Displays a message in the system default corner of the screen.

    A TBUF resource string is used to build the message at run-time from arbitrary data in a similar way to C's printf(). The message disappears after a few seconds.

    ParameterDescription
    aResourceIdID of a TBUF resource used to hold the string.

    InfoMsg ( TInt, VA_LIST )

    IMPORT_C voidInfoMsg(TIntaResourceId,
    VA_LISTaList
    )

    Displays a message in the system default corner of the screen.

    A TBUF resource string is used to build the message at run-time from arbitrary data in a similar way to C's printf(). The message disappears after a few seconds.

    ParameterDescription
    aResourceIdID of a TBUF resource used to hold the string.
    aListList of values to be formatted.

    InfoMsgCancel ( )

    IMPORT_C voidInfoMsgCancel()

    Cancels the currently displaying information message.

    InfoMsgWithAlignment ( TGulAlignment, const TDesC & )

    IMPORT_C voidInfoMsgWithAlignment(TGulAlignmentaCorner,
    const TDesC &aDes
    )

    Displays a message in the specified corner of the screen.

    The message disappears after a few seconds.

    ParameterDescription
    aCornerThe screen corner the message is displayed in.
    aDesThe message to display.

    InfoMsgWithAlignment ( TGulAlignment, TInt, ... )

    IMPORT_C voidInfoMsgWithAlignment(TGulAlignmentaCorner,
    TIntaResourceId,
    ...
    )

    Displays a message in the specified corner of the screen.

    The information message is built at run-time from a formatting string defined as a TBUF resource and a list of arbitrary data.

    ParameterDescription
    aCornerThe corner of the screen the message is displayed in.
    aResourceIdID of a TBUF resource used to hold the string.

    InfoMsgWithAlignment ( TGulAlignment, TInt, VA_LIST )

    IMPORT_C voidInfoMsgWithAlignment(TGulAlignmentaCorner,
    TIntaResourceId,
    VA_LISTaList
    )

    Displays a message in the specified corner of the screen.

    The information message is built at run-time from a formatting string defined as a TBUF resource and a list of arbitrary data.

    ParameterDescription
    aCornerThe corner of the screen the message is displayed in.
    aResourceIdID of a TBUF resource used to hold the string.
    aListList of values to be formatted.

    InfoMsgWithAlignmentAndDuration ( TGulAlignment, const TDesC &, TTimeIntervalMicroSeconds32 )

    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignmentaCorner,
    const TDesC &aDes,
    TTimeIntervalMicroSeconds32aDuration
    )

    Displays an info message with a specified alignment for a specified period.

    The text displayed is supplied in a descriptor argument, and aligned using the aCorner parameter.

    ParameterDescription
    aCornerThe screen corner the message is displayed in.
    aDesMessage to display.
    aDurationDuration of message.

    InfoMsgWithAlignmentAndDuration ( TGulAlignment, TInt, TTimeIntervalMicroSeconds32, ... )

    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignmentaCorner,
    TIntaResourceId,
    TTimeIntervalMicroSeconds32aDuration,
    ...
    )

    Displays an info message with a specified alignment for a specified period.

    The text displayed is supplied in a resource file, as a string with some formatting information for extra arguments. These extra arguments are supplied through the variable argument list which is also passed into this function. The text is aligned using the aCorner parameter.

    ParameterDescription
    aCornerThe screen corner the message is displayed in.
    aResourceIdID of a TBUF resource used to contain the string.
    aDurationDuration of message.

    InfoMsgWithAlignmentAndDuration ( TGulAlignment, TInt, TTimeIntervalMicroSeconds32, VA_LIST )

    IMPORT_C voidInfoMsgWithAlignmentAndDuration(TGulAlignmentaCorner,
    TIntaResourceId,
    TTimeIntervalMicroSeconds32aDuration,
    VA_LISTaList
    )

    Displays an info message with a specified alignment for a specified period.

    The text displayed is supplied in a resource file, as a string with some formatting information. Values for the formatting information are supplied as extra arguments. These extra arguments are packaged in a VA_LIST object which is also passed into this function. The text is aligned using the aCorner parameter.

    ParameterDescription
    aCornerThe screen corner the message is displayed in.
    aResourceIdID of a TBUF resource used to contain the string.
    aDurationDuration of message.
    aListList of values.

    InfoMsgWithDuration ( const TDesC &, TTimeIntervalMicroSeconds32 )

    IMPORT_C voidInfoMsgWithDuration(const TDesC &aDes,
    TTimeIntervalMicroSeconds32aDuration
    )

    Displays an info message for a specified period.

    ParameterDescription
    aDesMessage to display.
    aDurationDuration of message.

    InfoMsgWithDuration ( TInt, TTimeIntervalMicroSeconds32, ... )

    IMPORT_C voidInfoMsgWithDuration(TIntaResourceId,
    TTimeIntervalMicroSeconds32aDuration,
    ...
    )

    Displays an info message for a specified period.

    The text displayed is supplied in a resource file, as a string with some formatting information for extra arguments. These extra arguments are supplied through the variable argument list which is also passed into this function.

    ParameterDescription
    aResourceIdID of a TBUF resource used to hold the string.
    aDurationDuration of the message.

    InfoMsgWithDuration ( TInt, TTimeIntervalMicroSeconds32, VA_LIST )

    IMPORT_C voidInfoMsgWithDuration(TIntaResourceId,
    TTimeIntervalMicroSeconds32aDuration,
    VA_LISTaList
    )

    Displays an info message for a specified period.

    The text displayed is supplied in a resource file, as a string with some formatting information. Values for the formatting information are supplied as extra arguments. These extra arguments are packaged in a VA_LIST object which is also passed into this function.

    ParameterDescription
    aResourceIdID of a TBUF resource used to hold the string.
    aDurationDuration of message.
    aListList of values.

    InfoWinL ( const TDesC &, const TDesC & )

    IMPORT_C voidInfoWinL(const TDesC &aFirstLine,
    const TDesC &aSecondLine
    )[static]

    Displays a modal information dialog with the specified lines of text.

    ParameterDescription
    aFirstLineFirst line of dialog text.
    aSecondLineSecond line of dialog text.

    InfoWinL ( TInt, TInt )

    IMPORT_C voidInfoWinL(TIntaFirstLineId,
    TIntaSecondLineId = 0
    )const

    Displays a modal information dialog with a one or two-line info message read from the passed resources.

    ParameterDescription
    aFirstLineIdID of the resource describing the first line.
    aSecondLineIdID of the resource describing the second line.

    InitSystemBitmapsL ( )

    voidInitSystemBitmapsL()

    Creates and populates array of bitmaps.

    IrFactory ( )

    MEikIrFactory *IrFactory()const [inline]

    IsBusy ( )

    IMPORT_C TBoolIsBusy()const

    Tests whether the application is marked as busy.

    Returns: ETrue if the application is busy, EFalse otherwise.

    IsEiksrvThread ( )

    TBool IsEiksrvThread()const

    Returns: ETrue if threadname is EIKAPPUI_SERVER_THREAD_NAME

    IsSystem ( )

    IMPORT_C TBoolIsSystem()const

    Tests the value of the system attribute.

    Returns: ETrue if the system attribute is set, otherwise EFalse.

    KeyPressLabel ( TInt )

    IMPORT_C TPtrCKeyPressLabel(TIntaIndex)const

    Returns the indexed keypress label. A keypress label is the text that is displayed on some buttons to identify which key press activates them. Examples might include Esc, Enter, Tab. Keypress labels are read from a resource file and are UI-specific.

    ParameterDescription
    aIndexThe position of the element within the array of keypress labels.

    Returns: The keypress label.

    LafEnv ( )

    IMPORT_C MLafEnv &LafEnv()const

    LaunchPopupMenuL ( TInt, const TPoint &, TPopupTargetPosType, const CEikHotKeyTable * )

    IMPORT_C voidLaunchPopupMenuL(TIntaResourceId,
    const TPoint &aTargetPos,
    TPopupTargetPosTypeaTargetType = EPopupTargetTopLeft,
    const CEikHotKeyTable *aHotKeyTable = NULL
    )

    Allows an application to launch a popup menu, by calling the app UI's LaunchPopupMenuL() function.

    ParameterDescription
    aResourceIdID of the resource that defines the menu to be launched.
    aTargetPosPosition of the corner of the menu identified by aTargetType.
    aTargetTypeThe corner of the menu by which the menu will be positioned.
    aHotKeyTableOptional menu hotkey table.

    LeaveWithErrorContext ( TInt, const TDesC & )

    IMPORT_C voidLeaveWithErrorContext(TIntaError,
    const TDesC &aContextText
    )

    LeaveWithInfoMsg ( TInt, ... )

    IMPORT_C voidLeaveWithInfoMsg(TIntaResourceId,
    ...
    )

    Displays a formatted information message and then leaves.

    ParameterDescription
    aResourceIdID of a TBUF resource used to hold the string.

    LegendFont ( )

    IMPORT_C const CFont *LegendFont()const

    Gets the standard legend font for this environment.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    Returns: Pointer to the legend font.

    NewDefaultCharFormatLayerL ( )

    IMPORT_C CCharFormatLayer *NewDefaultCharFormatLayerL()[static]

    Creates a default character format layer.

    Returns: A new default CCharFormatLayer. The caller takes ownership.

    NewDefaultParaFormatLayerL ( )

    IMPORT_C CParaFormatLayer *NewDefaultParaFormatLayerL()[static]

    Creates a default paragraph format layer suitable for multiple lines of text.

    It uses the default inter line spacing, which is UI specific.

    Returns: A new CParaFormatLayer suitable for text that has more than one line. The caller takes ownership.

    NewDefaultPrintSetupL ( )

    IMPORT_C CPrintSetup *NewDefaultPrintSetupL()

    Creates and returns a pointer to a new default printer setup object.

    Returns: A default printer setup object.

    NewDefaultSingleLineParaFormatLayerL ( )

    IMPORT_C CParaFormatLayer *NewDefaultSingleLineParaFormatLayerL()[static]

    Creates a default paragraph format layer suitable for a single line of text.

    It has an inter line spacing of zero.

    Returns: A new CParaFormatLayer suitable for a single line of text. The caller takes ownership.

    NotifyIdleError ( TInt, TInt )

    IMPORT_C voidNotifyIdleError(TIntaError,
    TIntaContextResourceId
    )

    Notifies this environment of an idle error.

    This function reads the error context text from the resource identified by aContextResourceId. Calling this method will only trigger one error dialog per minute. Calling it any more frequent will result in no action.

    ParameterDescription
    aErrorID of the idle error.
    aContextResourceIdID of the resource from which the context text is read.

    NotifyIdleErrorWhileRedrawing ( TInt )

    IMPORT_C voidNotifyIdleErrorWhileRedrawing(TIntaError)

    Notifies this environment that an idle error occurred while redrawing was in progress.

    ParameterDescription
    aErrorID of the idle error.

    NudgeCharMinus ( )

    TChar NudgeCharMinus()const [inline]

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

    Returns: Minus nudge character.

    NudgeCharPlus ( )

    TChar NudgeCharPlus()const [inline]

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

    Returns: Plus nudge character.

    OptionBitmap ( )

    IMPORT_C const CFbsBitmap *OptionBitmap()const

    Gets the bitmap that is used by horizontal option buttons in this environment.

    Deprecated

    Returns: A pointer to the option bitmap.

    OptionMaskBitmap ( )

    IMPORT_C const CFbsBitmap *OptionMaskBitmap()const

    PictureFactory ( )

    IMPORT_C MPictureFactory *PictureFactory()const

    Gets the picture factory for this environment.

    Returns: The picture factory.

    PopulateColorArrayL ( )

    IMPORT_C CColorList *PopulateColorArrayL()

    Creates and populates a colour list, a palette of standard colours used by the system. If the first attempt fails a separate executable, Z:\SYS\BIN\UPDATESYSTEMCOLORLIST.EXE, is run to update system colours.

    Returns: populated colour list. Ownership is passed to caller.

    PostAppUiDestroy ( )

    voidPostAppUiDestroy()

    PostAppUiInitializeL ( )

    voidPostAppUiInitializeL()

    Calls (virtual) PostAppUiInitializeL on all loaded libraries.

    See also: CEikLibrary::PostAppUiInitializeL

    PrintDialogFactory ( )

    MEikPrintDialogFactory *PrintDialogFactory()const [inline]

    Process ( )

    CEikProcess *Process()const [inline]

    Gets the Uikon process that manages the files of applications started in this environment.

    Returns: The CEikProcess object.

    QueryDialog ( )

    IMPORT_C MEikInfoDialog *QueryDialog()const

    Gets the query dialog for this environment.

    Returns: The query dialog.

    QueryWinL ( const TDesC &, const TDesC & )

    IMPORT_C TBoolQueryWinL(const TDesC &aFirstLine,
    const TDesC &aSecondLine
    )[static]

    Requests a yes or no response from the user using a modal query dialog.

    ParameterDescription
    aFirstLineFirst line of query text.
    aSecondLineSecond line of query text.

    Returns: User's response.

    QueryWinL ( TInt, TInt )

    IMPORT_C TBoolQueryWinL(TIntaFirstLineId,
    TIntaSecondLineId = 0
    )const

    Requests a yes or no response from the user using a modal query dialog.

    The query text is read from the passed resource IDs.

    User input cannot continue outside a modal dialog until the dialog is dismissed, although applications can be switched.

    ParameterDescription
    aFirstLineIdID of resource describing the first line.
    aSecondLineIdID of resource describing the second line.

    Returns: User's response to the question, either ETrue or EFalse.

    RemoveAppUiFactory ( )

    IMPORT_C voidRemoveAppUiFactory()

    RemoveFromStack ( CCoeControl * )

    IMPORT_C voidRemoveFromStack(CCoeControl *aControl)

    Removes a control from the control stack.

    ParameterDescription
    aControlThe control to remove.

    RemoveLibrary ( TCreateByTypeFunction, TInt )

    IMPORT_C voidRemoveLibrary(TCreateByTypeFunctionaControlFactory,
    TIntaResourceFileOffset
    )

    RemoveLibrary ( TCreateByTypeFunction )

    voidRemoveLibrary(TCreateByTypeFunctionaControlFactory)[inline]

    RemoveLibrary ( TInt )

    voidRemoveLibrary(TIntaResourceFileOffset)[inline]

    RemovePictureFactory ( TUid )

    IMPORT_C voidRemovePictureFactory(TUidaFactoryId)

    Removes the specified picture factory, if it exists, from the set of picture factories owned by the Uikon environment.

    ParameterDescription
    aFactoryIdThe Id of the picture factory to be removed.

    ResolveError ( TInt, TUid )

    IMPORT_C voidResolveError(TIntaError,
    TUidaAppUid = KNullUid
    )const

    Displays an error message appropriate to the error code aError in an alert window. The message is read from a resource file and has a maximum of 256 characters.

    ParameterDescription
    aErrorError code.
    aAppUidApplication UID. By default, this is KNullUid. If a non null UID is specified and the error code is not known to UIKON, then the UID enables an application-specific error resource file to be scanned (if one exists) to try to resolve the error.

    RespondsToShutdownEvent ( )

    IMPORT_C TBoolRespondsToShutdownEvent()const

    Tests whether the application responds to shutdown events.

    Returns: ETrue if the application responds to shutdown events, EFalse otherwise.

    RespondsToSwitchFilesEvent ( )

    IMPORT_C TBoolRespondsToSwitchFilesEvent()const

    Tests whether an application responds to switch files events.

    Returns: ETrue if the application responds to switch files events, EFalse otherwise.

    RouseSleepingDialog ( CCoeControl *, TBool )

    IMPORT_C voidRouseSleepingDialog(CCoeControl *aControl,
    TBoolaRoused
    )

    Sets a sleeping dialog's state.

    ParameterDescription
    aControlThe sleeping dialog to rouse or put to sleep.
    aRousedETrue to rouse aControl, EFalse to put it to sleep.

    SendEventToEikonServer ( TInt, const TAny *, TInt )

    IMPORT_C voidSendEventToEikonServer(TIntaEvent,
    const TAny *aPtr,
    TIntaLength
    )

    Sends the event to the Eikon Server.

    ParameterDescription
    aEventEvent that has to be sent to Eikon Server.
    aPtrPointer to the message that has to be sent to Eikon Server.
    aLengthLength of the message that has to be sent to Eikon Server.

    SetAlertWin ( MEikAlertWin * )

    IMPORT_C voidSetAlertWin(MEikAlertWin *aAlertWin)

    Sets the enviroment's alert window.

    ParameterDescription
    aAlertWinA custom alert window.

    SetAppUiFactoryL ( MEikAppUiFactory * )

    IMPORT_C voidSetAppUiFactoryL(MEikAppUiFactory *aAppUiFactory)

    SetAutoForwarding ( TBool )

    IMPORT_C voidSetAutoForwarding(TBoolaAutoBringToForeground)

    Use this method to set whether the application's window group shall be automatically brought to the foreground when the user taps on it.

    SetBusy ( TBool )

    IMPORT_C voidSetBusy(TBoolaBusy)

    Sets the application's busy state.

    ParameterDescription
    aBusyETrue to set as busy, EFalse otherwise.

    SetCDlgDialogFactory ( MEikCDlgDialogFactory * )

    voidSetCDlgDialogFactory(MEikCDlgDialogFactory *aDialogFactory)[inline]

    SetColor ( TLogicalColor, TRgb )

    voidSetColor(TLogicalColoraLogicalColor,
    TRgbaColor
    )[inline]

    Sets a mapping in the application's colour list between the logical and physical colours specified.

    ParameterDescription
    aLogicalColorA logical colour value.
    aColorA physical colour value.

    SetDebugKeys ( MEikDebugKeys * )

    IMPORT_C voidSetDebugKeys(MEikDebugKeys *aDebugKeys)

    Sets a debug keys object. This function enables the default debug keys to be overridden with custom ones. The debug keys object only receives key events in debug builds or, in release builds, if the CEikDebugPreferences::EFlagDebugKeysOn flag has been set.

    Must be called before the environment object has been fully constructed, e.g. from a control (widget) library initialisation function, or it will have no effect. Must be called only once.

    ParameterDescription
    aDebugKeysA custom debug keys object.

    SetDocNameIsAFile ( TBool )

    IMPORT_C voidSetDocNameIsAFile(TBoolaDocNameIsAFile)

    Sets whether a document name is a file.

    ParameterDescription
    aDocNameIsAFileETrue to set the document name as a file, EFalse otherwise.

    SetExtension ( CBase * )

    IMPORT_C voidSetExtension(CBase *aExtension)

    Deprecated

    Use CCoeStatic instead

    SetFileDialogFactory ( MEikFileDialogFactory * )

    voidSetFileDialogFactory(MEikFileDialogFactory *aDialogFactory)[inline]

    SetInfoDialog ( MEikInfoDialog * )

    IMPORT_C voidSetInfoDialog(MEikInfoDialog *aInfoDialog)

    Sets the dialog.

    ParameterDescription
    aInfoDialogThe information dialog.

    SetIrFactory ( MEikIrFactory * )

    voidSetIrFactory(MEikIrFactory *aIrFactory)[inline]

    SetPrintDialogFactory ( MEikPrintDialogFactory * )

    voidSetPrintDialogFactory(MEikPrintDialogFactory *aDialogFactory)[inline]

    SetQueryDialog ( MEikInfoDialog * )

    IMPORT_C voidSetQueryDialog(MEikInfoDialog *aQueryDialog)

    Sets the query dialog.

    ParameterDescription
    aQueryDialogThe query dialog.

    SetRequestInfoDialogFunc ( TRequestDialogFunc )

    IMPORT_C voidSetRequestInfoDialogFunc(TRequestDialogFuncaInfoDialogFunc)

    Sets the request information dialog.

    ParameterDescription
    aInfoDialogFuncThe request information dialog.

    SetRequestQueryDialogFunc ( TRequestDialogFunc )

    IMPORT_C voidSetRequestQueryDialogFunc(TRequestDialogFuncaQueryDialogFunc)

    Sets the request query dialog.

    ParameterDescription
    aQueryDialogFuncRequest query dialog.

    SetRespondsToShutdownEvent ( TBool )

    IMPORT_C voidSetRespondsToShutdownEvent(TBoolaRespondsToShutdownEvent)

    Sets whether the application responds to shutdown events.

    ParameterDescription
    aRespondsToShutdownEventETrue if the application responds to shutdown events, EFalse otherwise.

    SetRespondsToSwitchFilesEvent ( TBool )

    IMPORT_C voidSetRespondsToSwitchFilesEvent(TBoolaRespondsToSwitchFilesEvent)

    Sets whether the application responds to switch files events.

    ParameterDescription
    aRespondsToSwitchFilesEventETrue if the application responds to switch files events, EFalse otherwise.

    SetStatusPaneCoreResId ( TInt )

    voidSetStatusPaneCoreResId(TIntaStatusPaneCoreResId)[inline]

    SetSystem ( TBool )

    IMPORT_C voidSetSystem(TBoolaSystem)

    Sets the application's system attribute.

    While the system attribute is set, the application cannot be closed down e.g. by using the TApaTask::EndTask function unless the requester has the capability PowerMgmt.

    ParameterDescription
    aSystemETrue to set the system attribute, EFalse to unset it.

    SetVerboseInfoReporting ( TBool )

    IMPORT_C voidSetVerboseInfoReporting(TBoolaVerbose)

    Sets the Verbose Information Reporting state.

    ParameterDescription
    aVerboseETrue to set Verbose Information Reporting, EFalse otherwise.

    StartedAsServerApp ( )

    IMPORT_C TBoolStartedAsServerApp()const

    Gets whether server is required or not.

    Returns: ETrue if application requires a server, EFalse otherwise.

    Static ( )

    CEikonEnv *Static()[static, inline]

    Reimplemented from CCoeEnv::Static()

    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.

    See also: CCoeEnv::Static()

    Returns: A static CEikonEnv.

    StatusPaneCoreResId ( )

    TInt StatusPaneCoreResId()const [inline]

    SymbolFont ( )

    IMPORT_C const CFont *SymbolFont()const

    Gets the standard symbol font for this environment.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    Returns: Pointer to the symbol font.

    SystemCharFormatLayerL ( )

    IMPORT_C CCharFormatLayer *SystemCharFormatLayerL()

    Gets the character format layer, if it exists.

    If it does not exist, it calls CEikonEnv::NewDefaultCharFormatLayerL() to create a new one.

    Returns: Character format layer.

    SystemParaFormatLayerL ( )

    IMPORT_C CParaFormatLayer *SystemParaFormatLayerL()

    Gets the paragraph format layer if it exists.

    If it does not exist, it calls CEikonEnv::NewDefaultParaFormatLayerL() to create a new one.

    Returns: Paragraph format layer.

    SystemSingleLineParaFormatLayerL ( )

    IMPORT_C CParaFormatLayer *SystemSingleLineParaFormatLayerL()

    Gets the single line paragraph format layer if it exists.

    If one does not exist, it calls CEikonEnv::NewDefaultSingleLineParaFormatLayerL() to create a new one.

    Returns: Single line paragraph format layer.

    TexturedBitmap ( )

    IMPORT_C const CFbsBitmap *TexturedBitmap()const

    TitleFont ( )

    IMPORT_C const CFont *TitleFont()const

    Gets the standard title font for this environment.

    It is highly recommended to use CCoeControl::ScreenFont() instead of this function.

    See also: CCoeControl::ScreenFont() CCoeFontProvider

    Returns: Pointer to the title font.

    UpdateColorListL ( )

    voidUpdateColorListL()

    UpdateSystemColorListL ( const CColorList & )

    IMPORT_C voidUpdateSystemColorListL(const CColorList &aColorList)

    Replaces the system colour list with the list specified.

    If no system colour list exists, one is created.

    capability
    WriteDeviceData To protect against tampering.
    ParameterDescription
    aColorListThe new colour list.

    UpdateSystemFontsL ( )

    IMPORT_C voidUpdateSystemFontsL()

    Calls Laf implementation of UpdateSystemFontsL() to update local array of system fonts

    UpdateTaskNameL ( )

    IMPORT_C voidUpdateTaskNameL()

    Updates the process and thread name from the caption.

    VerboseInfoMsg ( const TDesC & )

    IMPORT_C voidVerboseInfoMsg(const TDesC &aDes)

    Displays an information message if verbose information reporting has been set.

    The message is not displayed if verbose information reporting has not been set.

    ParameterDescription
    aDesMessage to display.

    Version ( )

    IMPORT_C TVersionVersion()[static]

    Reimplemented from CCoeEnv::Version()

    Gets the Uikon version that is currently running.

    Returns: The Uikon version.

    VirtualCursor ( )

    IMPORT_C TEikVirtualCursor &VirtualCursor()

    Gets the virtual cursor.

    Returns: Virtual cursor.

    WriteInternalStateOfStackedControlsL ( )

    IMPORT_C voidWriteInternalStateOfStackedControlsL()

    Writes the internal state of all CCoeControls on the control stack into a file c:\debuglog_::APPNAME#(NUMBER#) in the Symbian OS filing system. Works in debug mode only.

    WservAllocInfoMsg ( )

    IMPORT_C voidWservAllocInfoMsg()

    Creates a window server allocation information message from resource.

    The message indicates the number of resources currently open for the window server session.