Default constructor.

Note - Construction of the CCoeEnv is not complete until ConstructL() has been called.

This function raises a CONE 2 panic if the application already owns a CCoeEnv .

Destructor.

This function deletes any resources owned by the CCoeEnv that were not deleted by DestroyEnvironment() .

Adds the specified MCoeFepObserver to the FEP observer list.

Adds the specified MCoeFocusObserver to the focus observer list.

Adds the specified MCoeForegroundObserver to the foreground observer list.

Adds the specified MCoeMessageMonitorObserver to the message observer list

Adds the specified MCoeMessageObserver to the message observer list.

RemoveMessageObserver()

Adds the specified MCoeObserverOfLoadedFep to the loaded FEP list.

This enables objects to be notified when a front-end processor is loaded.

Adds the specified MCoeResourceChangeObserver to the resource change observer list.

Adds the specified resource file to the list maintained by CCoeEnv .

Resource files are access counted so AddResourceFileL() can be called several times for the same resource file. However, care should be taken to call DeleteResourceFile() for each resource file added to the list.

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.

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.

RResourceFile::AllocReadL()

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.

RResourceFile::AllocReadL()

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.

RResourceFile::AllocReadL()

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.

RResourceFile::AllocReadL()

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.

RResourceFile::AllocReadLC()

Gets the application UI owned by this application.

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

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.

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

Completes construction of the CCoeEnv object.

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

Completes construction of the CCoeEnv .

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

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

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:

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

Return the status of the report control state change.

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.

CCoeEnv::CreateScreenFontL() CCoeControl::ScreenFont() CCoeFontProvider

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.

SystemGc()

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.

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.

CCoeControl::ScreenFont() CCoeFontProvider

This function returns the default font provider.

This function returns the default text drawer.

This function deletes the array of TScreenItems

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

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.

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() .

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.

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() .

CActive::Cancel

Flush WSERV's command buffer

Gets the current error context text.

Gets the current error message text.

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.

Launches the application and destroys the control environment.

Executes the settings dialog for the specified secure FEP.

The specified FEP does not need to be loaded.

Gets a pointer to the currently loaded FEP.

Gets the UID of the currently loaded FEP.

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.

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() .

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.

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.

Gets the file server session owned by this CCoeEnv .

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

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.

Initialises the system fonts.

This function is called by ConstructL() during the construction of a CCoeEnv . The default implementation creates only the normal control environment font, but this function may be overridden to create other fonts.

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

Loads the specified secure FEP into all running applications.

The currently loaded FEP, if any, is unloaded.

Loads the specified secure FEP into all running applications.

The currently loaded FEP, if any, is unloaded.

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

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.

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.

Triggers a dialog which will display the error message

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.

Gets the normal environment font.

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

InitSystemFontsL()

This function initializes an array of TScreenItems. Each SScreenItem object contains a pointer to a screen device and a window group The first entry in this array points to the default screen device and window group. The default screen device is the primary screen device in the system.

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.

Reads a resource into a 16 bit descriptor array.

Ownership of the array is transferred to the caller.

TResourceReader::ReadDesC16ArrayL()

Reads a resource into an 8 bit descriptor array.

TResourceReader::ReadDesC8ArrayL()

Reads a resource into a Unicode descriptor array.

TResourceReader::ReadDesCArrayL()

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.

Deprecated - Use CCoeEnv::ReadResourceL() instead.

RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk

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.

RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk

7.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.

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.

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::ReadResourceAsDes8L() instead.

RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk

7.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.

Reads a resource into a descriptor.

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

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() .

Removes the specified FEP observer.

AddFepObserverL()

Removes the specified focus observer.

AddFocusObserverL()

Removes the specified foreground observer.

AddForegroundObserverL()

Removes the specified MCoeMessageMonitorObserver .

Removes the specified MCoeMessageObserver from the message observer list.

AddMessageObserverL()

Removes the specified loaded FEP observer.

Removes the specified resource change observer.

Asks WSERV to give notification when an event is waiting

Gets the resource file version number.

The function is intended to be replaced in a derived class. It should return a defined constant which should correspond to the version number of resource files used by the application. It is implemented by the standard GUI framework.

AddResourceFileL() uses this function to verify that the application is not using an out of date resource file. An out of date resource file causes AddResourceFileL() to leave with error code KErrBaflWrongResourceFileSignature.

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.

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

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.

CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD

Gets the default screen device owned by this CCoeEnv .

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

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

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.

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

CCoeControl::SetZoomFactor()

Simulates a key event.

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

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);
        

Gets a pointer to the specified CCoeStatic derived class.

If no match is found it will return NULL.

This function might be used to allow a CCoeStatic derived class to get a handle on itself.

Note: ownership of the object remains with CCoeEnv in all cases.

Suppresses the next flush of the active scheduler queue.

It prevents the active scheduler automatically flushing its window server session the next time that a non-CCoeEnv object runs. After the active object has run, the active scheduler reverts back to its normal behaviour, flushing after each non-CCoeEnv RunL() .

Sets the new system graphics context.

The function returns a pointer to the old system graphics context.

Gets the system graphics context.

This is the graphics context typically used for drawing controls, but an alternative graphics context can be created if required using CreateGcL() .

Gets the version number of the UI Control Framework API.

Gets the window server session owned by the application.

This provides access to window server functions not directly accessible via the UI control framework.

Returns the zoom factor last set by calling CCoeEnv::SetZoomFactor() .