CCoeEnv Class Reference

aResourceId

)

const

Reads a resource into a 16 bit heap buffer, allocating the buffer.

The calling program must destroy the heap descriptor when it is no longer needed.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource data.

AllocReadResourceAsDes16LC ( TInt )

IMPORT_C HBufC16 *

AllocReadResourceAsDes16LC

(

aResourceId

)

const

Reads a resource into a 16 bit heap buffer, allocating the buffer and pushing it onto the cleanup stack.

The calling program must destroy the heap descriptor when it is no longer needed.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource data.

AllocReadResourceAsDes8L ( TInt )

IMPORT_C HBufC8 *

AllocReadResourceAsDes8L

(

aResourceId

)

const

Reads a resource into an 8 bit heap buffer, allocating the buffer.

The calling program must destroy the heap descriptor when it is no longer needed.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource data.

AllocReadResourceAsDes8LC ( TInt )

IMPORT_C HBufC8 *

AllocReadResourceAsDes8LC

(

aResourceId

)

const

Reads a resource into an 8 bit heap buffer, allocating the buffer and pushing it onto the cleanup stack.

The calling program must destroy the heap descriptor when it is no longer needed.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource data.

AllocReadResourceL ( TInt )

HBufC *

AllocReadResourceL

(

aResourceId

)

const [inline]

Reads a resource into a heap descriptor, allocating memory for it.

Note: the calling program must destroy the heap descriptor when it is no longer needed.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource data.

AllocReadResourceLC ( TInt )

HBufC *

AllocReadResourceLC

(

aResourceId

)

const [inline]

Reads a specified resource into a heap descriptor, allocating memory for it, and pushing the descriptor onto the cleanup stack.

The calling program should pop and destroy the heap descriptor when it is no longer needed.

AppStartupInstrumentationEventIdBase ( )

TInt

AppStartupInstrumentationEventIdBase

(

)

AppUi ( )

CCoeAppUi *

AppUi

(

)

const [inline]

Gets the application UI owned by this application.

Return Value: Pointer to the app UI owned by the application.

AvailableFepsL ( RArray< TUid > &, CDesCArray * )

IMPORT_C void	AvailableFepsL	(	RArray< TUid > &	aUids,
			CDesCArray *	aDisplayNames
		)

Gets the UIDs, and optionally display names, of all the secure FEPs that are available.

Parameters
aUids	The array of FEP UIDs to be filled.
aDisplayNames	The array of FEP display names to be filled. May be passed as NULL if display names are not required.

BringOwnerToFront ( )

IMPORT_C void

BringOwnerToFront

(

)

Brings the application's owning window group to the front of the screen and gives it keyboard focus.

This is done by giving the owning window group an ordinal position of zero.

CoeEnvConstructorError ( )

IMPORT_C TInt

CoeEnvConstructorError

(

)

const [protected]

Return an error code if something failed during early c'tor construction.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

Completes construction of the CCoeEnv object.

It calls the other ConstructL() overload specifying ETrue as the initial focus state.

ConstructL ( TBool )

IMPORT_C void

ConstructL

(

aInitialFocusState

)

Completes construction of the CCoeEnv.

It is called by the other overload, with aInitialFocusState set to ETrue.

Parameters
aInitialFocusState	Window group initial focus state. If ETrue, keyboard focus is enabled, otherwise keyboard focus is disabled.

ConstructL ( TBool, TInt )

IMPORT_C void	ConstructL	(	TBool	aInitialFocusState,
			TInt	aDefaultScreenNumber
		)

Completes construction of the CCoeEnv. It can be called by the previous overload. It calls the next overload, setting the default window group ID to 0 which is not a valid ID

Parameters
aInitialFocusState	Window group initial focus state. If ETrue, keyboard focus is enabled, otherwise keyboard focus is disabled.
aDefaultScreenNumber	The default screen number should be zero.

ConstructL ( TBool, TInt, TInt )

IMPORT_C void	ConstructL	(	TBool	aInitialFocusState,
			TInt	aDefaultScreenNumber,
			TInt	aWindowGroupID
		)

Completes construction of the CCoeEnv.

All of the previous ConstructL() overloads end up at this method.

This function creates an active scheduler, and adds active objects to it for standard and redraw events. The active scheduler is not started, however, and no events are received, until ExecuteD() is called. It also does the following:

creates a connection to the window server.

creates a connection to the file server so that the control environment can access resource files

creates a screen device, the application's window group, a standard font, and a graphics context (the system GC).

The window group is constructed with the initial focus state aInitialFocusState, which automatically takes keyboard focus when it is created.

Parameters
aInitialFocusState	Window group initial focus state. If ETrue, keyboard focus is enabled, otherwise keyboard focus is disabled.
aDefaultScreenNumber	The default screen number
aWindowGroupID	The window group ID which will be set as the parent

ControlStateChange ( )

ControlStateChange

(

)

Return the status of the report control state change.

CreateDeviceFontL ( CGraphicsDevice *, const TFontSpec & )

IMPORT_C CFbsFont *	CreateDeviceFontL	(	CGraphicsDevice *	aDevice,
			const TFontSpec &	aFontSpec
		)

Creates a font for the specified graphics device.

If you wish to use the default screen device as the graphics device, use CreateScreenFontL() instead of this function.

This function calls GetNearestFontToMaxHeightInTwips() on the graphics device given by aDevice, passing it the font defined by aFontSpec.

All fonts created by this function should be released using MGraphicsDeviceMap::ReleaseFont(), when they are no longer required.

Note that the font will not be scaled automatically when the control's zoom factor is changed using CCoeControl::SetZoomFactor(). This is also the case for NormalFont(), CEikonEnv::LegendFont(), CEikonEnv::TitleFont(), CEikonEnv::AnnotationFont(), CEikonEnv::DenseFont().

To avoid this problem, and also make resource management much easier, it is highly recommended to use CCoeControl::ScreenFont() instead.

Parameters
aDevice	The graphics device for which to create the font.
aFontSpec	The font specification.

Return Value: The new font.

CreateGcL ( )

IMPORT_C CWindowGc *

CreateGcL

(

)

Fully constructs a new graphics context.

CCoeEnv calls this function during construction to create the system graphics context, which can be accessed using SystemGc(). Hence the system graphics context is always available.

CreateResourceReaderLC ( TResourceReader &, TInt )

IMPORT_C void	CreateResourceReaderLC	(	TResourceReader &	aReader,
			TInt	aResourceId
		)	const

Reads a resource from a resource file and sets its resource reader.

The resource reader can subsequently be used to read resource data from the resource. The resource reader is also placed on the cleanup stack.

Note: the GUI framework passes a resource reader as an argument to CCoeControl::ConstructFromResourceL(), with the resource reader's buffer already set to contain the relevant resource for that control.

Parameters
aReader	The resource reader.
aResourceId	The numeric ID of the resource to be read.

CreateScreenFontL ( const TFontSpec & )

IMPORT_C CFbsFont *

CreateScreenFontL

(

const TFontSpec &

aFontSpec

)

Creates a font for the default graphics device, based on the specified TFontSpec.

All fonts created using this function should be released using ReleaseScreenFont() when they are no longer required.

Note that the font will not be scaled automatically when the zoom factor is changed using CCoeControl::SetZoomFactor(). This is also the case for NormalFont(), CEikonEnv::LegendFont(), CEikonEnv::TitleFont(), CEikonEnv::AnnotationFont(), CEikonEnv::DenseFont().

To avoid this problem, and also make resource management much easier, it is highly recommended to use CCoeControl::ScreenFont() instead.

Parameters
aFontSpec	The font specification.

Return Value: The new font.

DefaultFontProvider ( )

IMPORT_C const CCoeFontProvider &

DefaultFontProvider

(

)

const

This function returns the default font provider.

Return Value: The default font provider.

DefaultTextDrawer ( )

IMPORT_C CCoeTextDrawerBase &

DefaultTextDrawer

(

)

const

This function returns the default text drawer.

Return Value: The default text drawer.

DeleteResourceFile ( TInt )

IMPORT_C void

DeleteResourceFile

(

aOffset

)

Deletes the specified resource file from the list maintained by CCoeEnv.

Parameters
aOffset	The offset value defined for the resource file to delete.

Panic Codes
CONE	13 The specified resource file does not exist in the list.

DestroyEnvironment ( )

IMPORT_C void

DestroyEnvironment

(

)

[virtual]

Deletes several resources owned by the CCoeEnv object.

This includes; the app UI, the system graphics context, and the active object which receives redraw events. It also closes the window group, the connection to the window server, and the connection to the file server.

The function is called from ExecuteD() when the active scheduler's wait loop terminates.

DestroyEnvironmentEnd ( )

IMPORT_C void

DestroyEnvironmentEnd

(

)

[protected]

DestroyEnvironmentStatic ( )

IMPORT_C void

DestroyEnvironmentStatic

(

)

[protected]

DestroyScreen ( )

IMPORT_C void

DestroyScreen

(

)

[protected, virtual]

Destroys the screen device.

By default this function simply deletes the screen device owned by this CCoeEnv. However, this function may be overridden by subclasses.

This function is called by DestroyEnvironment().

DisableExitChecks ( TBool )

IMPORT_C void

DisableExitChecks

(

aDisable

)

Disables exit checks on kernel resources. Affects debug builds only.

CCoeEnv checks for kernel resources on exit (e.g. open file handles). These checks may be too strict for some applications, such as a web browser, so this function is provided to disable them.

CCoeEnv also checks on heap allocation and window server resources on exit.

Parameters
aDisable	True to disable resource checking, false to enable it.

DisableShutdownChecks ( )

IMPORT_C TBool

DisableShutdownChecks

(

)

const

DoCancel ( )

IMPORT_C void

DoCancel

(

)

[virtual]

Reimplemented from CActive::DoCancel()

Implements cancellation of an outstanding request.

This function is called as part of the active object's Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

DoCancel() must not wait for event completion; this is handled by Cancel().

DoFlush ( )

void

DoFlush

(

)

Flush WSERV's command buffer

EnableEventData ( )

void

EnableEventData

(

)

[inline]

Enables the event data.

EnsureCorrectFepIsLoadedL ( )

void

EnsureCorrectFepIsLoadedL

(

)

EnsureSpecifiedFepIsLoadedL ( TUid )

void

EnsureSpecifiedFepIsLoadedL

(

aFepUid

)

ErrorContextText ( )

TDes &

ErrorContextText

(

)

[protected, inline]

Gets the current error context text.

Return Value: The current error context text.

ErrorText ( )

TDes &

ErrorText

(

)

[protected, inline]

Gets the current error message text.

Return Value: The current error message text.

EventDataEnabled ( )

EventDataEnabled

(

)

const [inline]

Checks if the event data is enabled.

Return Value: ETrue if the event data is enabled, EFalse otherwise.

EventManager ( )

CCoeEventManager &

EventManager

(

)

Returns the event manager.

Return Value: The event manager.

Execute ( )

IMPORT_C void

Execute

(

)

Launches the application without destroying the control environment.

This function starts the active scheduler owned by the CCoeEnv, enabling the application to start receiving events from the window server. It forms the outer loop of all Control Environment applications.

ExecuteD ( )

IMPORT_C void

ExecuteD

(

)

Launches the application and destroys the control environment.

ExecuteFepSettingsDialogL ( TUid )

IMPORT_C void

ExecuteFepSettingsDialogL

(

aFepUid

)

Executes the settings dialog for the specified secure FEP.

The specified FEP does not need to be loaded.

Parameters
aFepUid	The UID of the secure FEP for which the settings dialog is to be executed.

Fep ( )

IMPORT_C CCoeFep *

Fep

(

)

const

Gets a pointer to the currently loaded FEP.

Return Value: The currently loaded FEP, or NULL if none is currently loaded.

FepUid ( )

IMPORT_C TUid

FepUid

(

)

const

Gets the UID of the currently loaded FEP.

Return Value: The UID of the currently loaded FEP. Zero if none is currently loaded.

FindStatic ( TUid )

IMPORT_C CCoeStatic *

FindStatic

(

TTimeIntervalMicroSeconds32

aUid

)

Flush ( TTimeIntervalMicroSeconds32 )

IMPORT_C void

Flush

(

aDelay = 0

)

Flushes the client-side window server buffer.

The function does this by first calling RWsSession::Flush(), and then User::After(aDelay), which puts the current process in a sleep state for the time interval given by aDelay.

Parameters
aDelay	Delay for which to sleep the current process after flushing the window server buffer. By default the delay is zero.

FocusObserverNotificationIdentifier ( )

TInt

FocusObserverNotificationIdentifier

(

)

const

FocusObserverNotificationIsStillPending ( TInt )

FocusObserverNotificationIsStillPending

(

aFocusObserverNotificationIdentifier

)

const

ForEachFepObserverCall ( TCoeFepObserverFunction )

IMPORT_C void

ForEachFepObserverCall

(

TCoeFepObserverFunction

aFepObserverFunction

)

Calls the specified function for each FEP observer.

This function is called for each MCoeFepObserver object that has been registered. FEP observers are registered by calling CCoeEnv::AddFepObserverL().

Parameters
aFepObserverFunction	The function to be called.

Format128 ( TDes &, TInt, ... )

IMPORT_C void	Format128	(	TDes &	aDes,
			TInt	aResourceId,
			...
		)

Reads a 128 byte resource into a formatted string.

The format of the string is given by the variable argument list. The unformatted resource data must not be longer than 128 bytes. If it is, you should use Format256() instead.

Parameters
aDes	On return, contains the formatted resource data.
aResourceId	The numeric ID of the resource to be read.

Format256 ( TDes &, TInt, ... )

IMPORT_C void	Format256	(	TDes &	aDes,
			TInt	aResourceId,
			...
		)

Reads a 256 byte resource into a formatted string.

The format of the string is given by the variable argument list. The unformatted resource data must not be longer than 256 bytes.

Parameters
aDes	On return, contains the formatted resource data.
aResourceId	The numeric ID of the resource to be read.

FsSession ( )

RFs &

FsSession

(

)

const [inline]

Gets the file server session owned by this CCoeEnv.

This session is normally only used for accessing the application's resource file.

Return Value: The file server session owned by this CCoeEnv.

GetMessageNotifyingObserversLC ( TUint32, TUid &, TPtr8 &, const TWsEvent & )

IMPORT_C void	GetMessageNotifyingObserversLC	(	TUint32	aClientHandleOfTargetWindowGroup,
			TUid &	aMessageUid,
			TPtr8 &	aMessageParameters,
			const TWsEvent &	aMessageEvent
		)

HandleError ( TInt )

IMPORT_C void

HandleError

(

aError

)

[virtual]

Handles an application-defined error message.

This function allows application-defined error messages to be called from functions within the control framework's active scheduler. It has an empty default implementation.

It is called when a leave occurs in CCoeEnv::RunL(), and also when ReadResource() fails.

InitViewServerSessionL ( MVwsSessionWrapperObserver & )

CVwsSessionWrapper *

InitViewServerSessionL

(

MVwsSessionWrapperObserver &

aObserver

)

InputCapabilitiesChanged ( )

IMPORT_C void

InputCapabilitiesChanged

(

)

Notifies all focus observers (FEPs) that a change has been made to the input capabilities of the focused control.

InstallFepL ( TUid )

IMPORT_C void

InstallFepL

(

aFepUid

)

Loads the specified secure FEP into all running applications.

The currently loaded FEP, if any, is unloaded.

Parameters
aFepUid	The UID of the secure FEP to be loaded.

Capability
WriteDeviceData	To protect against installation of insecure FEP.

InstallFepL ( TUid, const TBool )

IMPORT_C void	InstallFepL	(	TUid	aFepUid,
			const TBool	aLeave
		)

Loads the specified secure FEP into all running applications.

The currently loaded FEP, if any, is unloaded.

Parameters
aFepUid	The UID of the secure FEP to be loaded.
aLeave	No longer used.

Capability
WriteDeviceData	To protect against installation of insecure FEP.

IsRedrawEventPending ( )

IMPORT_C TBool

IsRedrawEventPending

(

)

const

Tests if there is a redraw event waiting to be processed.

Return Value: ETrue if a redraw event is pending. EFalse if no redraw event is pending.

IsResourceAvailableL ( TInt )

IMPORT_C TBool

IsResourceAvailableL

(

aResourceId

)

const

Checks if the given resource is owned by one of the resource files in the list maintained by CCoeEnv.

Since: 9.0

Parameters
aResourceId	The ID of the resource.

Return Value: ETrue if resource is available, EFalse otherwise.

IsSchedulerRunning ( )

IsSchedulerRunning

(

)

const [inline]

Tests if the Active Scheduler has been started in the CCoeEnv::ExecuteD.

Return Value: ETrue if Active Scheduler was started in CCoeEnv::ExecuteD(), EFalse if Active Scheduler was not started in CCoeEnv::ExecuteD().

IsWservEventPending ( )

IMPORT_C TBool

IsWservEventPending

(

)

const

Tests if there is a standard event waiting to be processed.

Note: standard events are all window server events except redraw and priority key events.

Return Value: ETrue if a standard event is pending. EFalse if no standard event is pending.

LastEvent ( )

const TWsEvent &

LastEvent

(

)

const [inline]

Gets the most recent standard event that was received by the application.

Note: standard events are all events except redraw events and priority key events.

Return Value: The last event.

LeaveWithErrorText ( const TDesC &, const TDesC * )

IMPORT_C void	LeaveWithErrorText	(	const TDesC &	aMsg,
			const TDesC *	aContextText = NULL
		)

Triggers a dialog which will display the error message

Parameters
aMsg	The error message.
aContextText	The error context text.

MopSupplyObject ( TTypeUid )

IMPORT_C TTypeUid::Ptr

MopSupplyObject

(

TTypeUid

aId

)

[protected, virtual]

Reimplemented from MObjectProvider::MopSupplyObject(TTypeUid)

Retrieves an object of the same type as that encapsulated in aId.

This function is used to allow to ask owners for access to other objects that they own.

Other than in the case where NULL is returned, the object returned must be of the same object type - that is, the ETypeId member of the object pointed to by the pointer returned by this function must be equal to the iUid member of aId.

Parameters
aId	An encapsulated object type ID.

Return Value: Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.

NormalFont ( )

const CFont *

NormalFont

(

)

const [inline]

Gets the normal environment font.

This is the font created during construction of the control environment.

NotifyFocusObserversOfDestructionOfFocusedItem ( )

void

NotifyFocusObserversOfDestructionOfFocusedItem

(

)

NotifyForegroundObserversOfGainingForeground ( )

void

NotifyForegroundObserversOfGainingForeground

(

)

NotifyForegroundObserversOfLosingForeground ( )

void

NotifyForegroundObserversOfLosingForeground

(

)

NotifyMessageMonitorObserversOfEvent ( const TWsEvent & )

void

NotifyMessageMonitorObserversOfEvent

(

const TWsEvent &

aEvent

)

NotifyResourceObserversOfChangeInResource ( )

void

NotifyResourceObserversOfChangeInResource

(

)

PrepareToExit ( )

IMPORT_C void

PrepareToExit

(

)

Prepares for exiting the application.

The function is called from ExecuteD() after the active scheduler's wait loop terminates, but before the environment is destroyed.

QueueNotificationToFocusObserversOfChangeInFocus ( )

void

QueueNotificationToFocusObserversOfChangeInFocus

(

)

ReadDesC16ArrayResourceL ( TInt )

IMPORT_C CDesC16ArrayFlat *

ReadDesC16ArrayResourceL

(

aResourceId

)

Reads a resource into a 16 bit descriptor array.

Ownership of the array is transferred to the caller.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: A pointer to the descriptor array containing the resource data.

ReadDesC8ArrayResourceL ( TInt )

IMPORT_C CDesC8ArrayFlat *

ReadDesC8ArrayResourceL

(

aResourceId

)

Reads a resource into an 8 bit descriptor array.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: A pointer to the descriptor array containing the resource data.

ReadDesCArrayResourceL ( TInt )

CDesCArrayFlat *

ReadDesCArrayResourceL

(

MCoeMessageMonitorObserver &

aResourceId

)

[inline]

Reads a resource into a Unicode descriptor array.

Parameters
aResourceId	The numeric ID of the resource to be read.

Return Value: A pointer to the descriptor array containing the resource data.

ReadResource ( TDes &, TInt )

void	ReadResource	(	TDes &	aDes,
			TInt	aResourceId
		)	const [inline]

Reads a resource into a descriptor.

The descriptor must be long enough to contain the entire resource. No memory is allocated by this function. If the read fails, the function sets an error condition and performs any cleanup required. The error condition causes the GUI to launch an alert window.

DeprecatedUse CCoeEnv::ReadResourceL() instead.

Parameters
aDes	On return, contains the resource data.
aResourceId	The numeric ID of the resource to be read.

ReadResourceAsDes16 ( TDes16 &, TInt )

IMPORT_C void	ReadResourceAsDes16	(	TDes16 &	aDes,
			TInt	aResourceId
		)	const

Reads a resource into a 16 bit descriptor.

The descriptor must be long enough to contain the entire resource. No memory is allocated by this function.

If the read fails the function sets an error condition and performs any cleanup required. The error condition causes the GUI to launch an alert window. Deprecated: use CCoeEnv::ReadResourceAsDes16L() instead.

Deprecated

Parameters
aDes	On return, contains the read resource.
aResourceId	The numeric ID of the resource to be read.

ReadResourceAsDes16L ( TDes16 &, TInt )

IMPORT_C void	ReadResourceAsDes16L	(	TDes16 &	aDes,
			TInt	aResourceId
		)	const

Deprecated7.0

Reads a resource into a 16 bit descriptor.

The descriptor must be long enough to contain the entire resource. The method leaves if an error occurs when reading from the resource file.

Parameters
aDes	On return, contains the read resource.
aResourceId	The numeric ID of the resource to be read.

ReadResourceAsDes8 ( TDes8 &, TInt )

IMPORT_C void	ReadResourceAsDes8	(	TDes8 &	aDes,
			TInt	aResourceId
		)	const

Reads a resource into an 8 bit descriptor.

The descriptor must be long enough to contain the entire resource. No memory is allocated by this function.

Deprecated

Parameters
aDes	On return, contains the read resource.
aResourceId	The numeric ID of the resource to be read.

ReadResourceAsDes8L ( TDes8 &, TInt )

IMPORT_C void	ReadResourceAsDes8L	(	TDes8 &	aDes,
			TInt	aResourceId
		)	const

Deprecated7.0

Reads a resource into an 8 bit descriptor.

The descriptor must be long enough to contain the entire resource. The method leaves if an error occurs when reading from the resource file.

Parameters
aDes	On return, contains the read resource.
aResourceId	The numeric ID of the resource to be read.

ReadResourceL ( TDes &, TInt )

void	ReadResourceL	(	TDes &	aDes,
			TInt	aResourceId
		)	const [inline]

Reads a resource into a descriptor.

The descriptor must be long enough to contain the entire resource. No memory is allocated by this function.

Parameters
aDes	On return, contains the resource data.
aResourceId	The numeric ID of the resource to be read.

Return Value: Pointer to a heap descriptor containing the resource.

RefetchPixelMappingL ( )

void

RefetchPixelMappingL

(

)

ReleaseScreenFont ( CFont * )

IMPORT_C void

ReleaseScreenFont

(

CFont *

aFont

)

const

Frees all resources used by the font.

This function should be used to release a font when the font is no longer required. Fonts are created using CreateScreenFontL().

Parameters
aFont	The font to be released.

RemoveFepObserver ( MCoeFepObserver & )

IMPORT_C void

RemoveFepObserver

(

MCoeFepObserver &

aFepObserver

)

Removes the specified FEP observer.

RemoveFocusObserver ( MCoeFocusObserver & )

IMPORT_C void

RemoveFocusObserver

(

MCoeFocusObserver &

aFocusObserver

)

Removes the specified focus observer.

RemoveForegroundObserver ( MCoeForegroundObserver & )

IMPORT_C void

RemoveForegroundObserver

(

MCoeForegroundObserver &

aForegroundObserver

)

Removes the specified foreground observer.

RemoveMessageMonitorObserver ( MCoeMessageMonitorObserver & )

IMPORT_C void

RemoveMessageMonitorObserver

(

aMessageMonitorObserver

)

Removes the specified MCoeMessageMonitorObserver.

Parameters
aMessageMonitorObserver	The visibility change observer to be removed.

RemoveMessageObserver ( MCoeMessageObserver & )

IMPORT_C void

RemoveMessageObserver

(

MCoeMessageObserver &

aMessageObserver

)

Removes the specified MCoeMessageObserver from the message observer list.

RemoveObserverOfLoadedFep ( MCoeObserverOfLoadedFep & )

IMPORT_C void

RemoveObserverOfLoadedFep

(

MCoeObserverOfLoadedFep &

aObserverOfLoadedFep

)

Removes the specified loaded FEP observer.

Parameters
aObserverOfLoadedFep	The FEP observer to be removed.

RemoveResourceChangeObserver ( MCoeResourceChangeObserver & )

IMPORT_C void

RemoveResourceChangeObserver

(

MCoeResourceChangeObserver &

aResourceChangeObserver

)

Removes the specified resource change observer.

Parameters
aResourceChangeObserver	The resource change observer to be removed.

RootWin ( )

RWindowGroup &

RootWin

(

)

const [inline]

Gets the application's window group.

Note: a window group is an invisible window which acts as the parent window for all other windows in an application. Typically, each application has one window group. In the window server, window groups are also the unit of keyboard focus.

Return Value: The application's window group.

RootWin ( TInt )

IMPORT_C RWindowGroup *

RootWin

(

aScreenNumber

)

const

This function returns the window group associated with the screen device that bears this particular screen number.

Return Value: the window group associated with the screen device that bears this particular screen number.

RunL ( )

IMPORT_C void

RunL

(

)

[virtual]

Reimplemented from CActive::RunL()

Handles an active object's request completion event.

A derived class must provide an implementation to handle the completed request. If appropriate, it may issue another request.

The function is called by the active scheduler when a request completion event occurs, i.e. after the active scheduler's WaitForAnyRequest() function completes.

Before calling this active object's RunL() function, the active scheduler has:

1. decided that this is the highest priority active object with a completed request

2. marked this active object's request as complete (i.e. the request is no longer outstanding)

RunL() runs under a trap harness in the active scheduler. If it leaves, then the active scheduler calls RunError() to handle the leave.

Note that once the active scheduler's Start() function has been called, all user code is run under one of the program's active object's RunL() or RunError() functions.

ScreenDevice ( )

CWsScreenDevice *

ScreenDevice

(

)

const [inline]

Gets the default screen device owned by this CCoeEnv.

This is typically used as the standard screen device for the CCoeEnv's application.

Return Value: The default screen device owned by this CCoeEnv.

ScreenDevice ( TInt )

IMPORT_C CWsScreenDevice *

ScreenDevice

(

aScreenNumber

)

const

This function returns the screen device with this particular screen number.

Return Value: the screen device with this particular screen number.

SetAppStartupInstrumentationEventIdBaseL ( TInt )

IMPORT_C void

SetAppStartupInstrumentationEventIdBaseL

(

aAppStartupInstrumentationEventIdBase

)

[protected]

SetAppUi ( CCoeAppUi * )

IMPORT_C CCoeAppUi *

SetAppUi

(

CCoeAppUi *

aAppUi

)

Sets the application's user interface object.

Standard GUI applications do not need to call this function, as the framework sets the app UI, during start up, to be the CEikAppUi-derived object created by the application.

Parameters
aAppUi	The app UI for this application.

Return Value: The app UI previously owned by this application, or NULL if this is the first time its app UI has been set.

SetZoomFactor ( const TZoomFactor & )

IMPORT_C void

SetZoomFactor

(

const TZoomFactor &

aZoomFactor

)

Sets the zoom factor of all controls currently on the control stack.

SimulateKeyEventL ( const TKeyEvent &, TEventCode )

IMPORT_C void	SimulateKeyEventL	(	const TKeyEvent &	aKeyEvent,
			TEventCode	aType
		)

Simulates a key event.

This function calls CCoeAppUi::HandleWsEventL() to process the event as if it had arrived from the window server.

Parameters
aKeyEvent	The key event.
aType	The event type.

Static ( )

IMPORT_C CCoeEnv *

Static

(

)

[static]

Gets a pointer to a CCoeEnv which can be used to access CCoeEnv's functions.

It allows application code to access CCoeEnv's functions even where there is no direct access to a CCoeEnv object.

For example:

CCoeEnv::Static()->CreateResourceReaderLC(aReader, aResourceId);

Return Value: The pointer for accessing CCoeEnv's functions.

Static ( TUid )

IMPORT_C CCoeStatic *

Static

(