#include <mw/coemain.h>
| class CCoeEnv : public CActive |
| Protected Attributes | |
|---|---|
| CCoeAppUi * | iAppUi |
| RFs | iFsSession |
| TWsEvent | iLastEvent |
| const CFont * | iNormalFont |
| CArrayFix< RResourceFile > * | iResourceFileArray |
| RWindowGroup | iRootWin |
| CWsScreenDevice * | iScreen |
| CWindowGc * | iSystemGc |
| RWsSession | iWsSession |
| Protected Member Functions | |
|---|---|
| IMPORT_C TInt | CoeEnvConstructorError() |
| IMPORT_C void | DestroyEnvironmentEnd() |
| IMPORT_C void | DestroyEnvironmentStatic() |
| virtual IMPORT_C void | DestroyScreen() |
| TDes & | ErrorContextText() |
| TDes & | ErrorText() |
| IMPORT_C TTypeUid::Ptr | MopSupplyObject(TTypeUid) |
| IMPORT_C void | SetAppStartupInstrumentationEventIdBaseL(TInt) |
| Inherited Attributes | |
|---|---|
| CActive::iStatus | |
| Inherited Enumerations | |
|---|---|
| CActive:TPriority | |
Control environment.
CCoeEnv provides an active environment for creating controls. It implements active objects and an active scheduler, which provide access to the window server, simplifying the API for application programs. It also provides utility functions that are useful to many applications.
When a standard event occurs, the active scheduler calls CCoeEnv::RunL(). When a redraw event occurs, it calls CCoeRedrawer::RunL(). Priority key events must be accessed using the Window Server API directly.
Note: standard events are all events except redraw events and priority key events.
| IMPORT_C | CCoeEnv | ( | ) |
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.
| IMPORT_C | ~CCoeEnv | ( | ) |
Destructor.
This function deletes any resources owned by the CCoeEnv that were not deleted by DestroyEnvironment().
| IMPORT_C void | AddFepObserverL | ( | MCoeFepObserver & | aFepObserver | ) |
Adds the specified MCoeFepObserver to the FEP observer list.
| Parameter | Description |
|---|---|
| aFepObserver | The FEP observer to be added to the list. |
| IMPORT_C void | AddFocusObserverL | ( | MCoeFocusObserver & | aFocusObserver | ) |
Adds the specified MCoeFocusObserver to the focus observer list.
| Parameter | Description |
|---|---|
| aFocusObserver | The focus observer to be added to the list. |
| IMPORT_C void | AddForegroundObserverL | ( | MCoeForegroundObserver & | aForegroundObserver | ) |
Adds the specified MCoeForegroundObserver to the foreground observer list.
| Parameter | Description |
|---|---|
| aForegroundObserver | The foreground observer to be added to the list. |
| IMPORT_C void | AddMessageMonitorObserverL | ( | MCoeMessageMonitorObserver & | aMessageMonitorObserver | ) |
Adds the specified MCoeMessageMonitorObserver to the message observer list
| Parameter | Description |
|---|---|
| aMessageMonitorObserver | The visibility change observer to be added to the list. |
| IMPORT_C void | AddMessageObserverL | ( | MCoeMessageObserver & | aMessageObserver | ) |
Adds the specified MCoeMessageObserver to the message observer list.
See also: RemoveMessageObserver()
| Parameter | Description |
|---|---|
| aMessageObserver | The message observer to be added to the list. |
| IMPORT_C void | AddObserverOfLoadedFepL | ( | MCoeObserverOfLoadedFep & | aObserverOfLoadedFep | ) |
Adds the specified MCoeObserverOfLoadedFep to the loaded FEP list.
This enables objects to be notified when a front-end processor is loaded.
| Parameter | Description |
|---|---|
| aObserverOfLoadedFep | The loaded FEP observer to be added to the list. |
| IMPORT_C void | AddResourceChangeObserverL | ( | MCoeResourceChangeObserver & | aResourceChangeObserver | ) |
Adds the specified MCoeResourceChangeObserver to the resource change observer list.
| Parameter | Description |
|---|---|
| aResourceChangeObserver | The resource change observer to be added to the 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.
See also: RResourceFile::Offset() ResourceFileVersionNumber()
| Parameter | Description |
|---|---|
| aFileName | The resource file name. |
Returns: The offset value defined for this resource file.
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.
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
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.
See also: RResourceFile::AllocReadL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
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.
See also: RResourceFile::AllocReadL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
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.
See also: RResourceFile::AllocReadL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
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.
See also: RResourceFile::AllocReadL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
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.
See also: RResourceFile::AllocReadLC()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource data.
| CCoeAppUi * | AppUi | ( | ) | const [inline] |
Gets the application UI owned by this application.
Returns: Pointer to the app UI owned by the application.
| IMPORT_C void | AvailableFepsL | ( | RArray< TUid > & | aUids, |
| CDesCArray * | aDisplayNames | |||
| ) | ||||
Gets the UIDs, and optionally display names, of all the secure FEPs that are available.
| Parameter | Description |
|---|---|
| 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. |
| 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.
| IMPORT_C TInt | CoeEnvConstructorError | ( | ) | const [protected] |
Return an error code if something failed during early c'tor construction.
| IMPORT_C void | ConstructL | ( | ) |
Completes construction of the CCoeEnv object.
It calls the other ConstructL() overload specifying ETrue as the initial focus state.
| IMPORT_C void | ConstructL | ( | TBool | aInitialFocusState | ) |
Completes construction of the CCoeEnv.
It is called by the other overload, with aInitialFocusState set to ETrue.
| Parameter | Description |
|---|---|
| aInitialFocusState | Window group initial focus state. If ETrue, keyboard focus is enabled, otherwise keyboard focus is disabled. |
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
| Parameter | Description |
|---|---|
| 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. |
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.
| Parameter | Description |
|---|---|
| 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 |
| TBool | ControlStateChange | ( | ) |
Return the status of the report control state change.
| 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.
See also: CCoeEnv::CreateScreenFontL() CCoeControl::ScreenFont() CCoeFontProvider
| Parameter | Description |
|---|---|
| aDevice | The graphics device for which to create the font. |
| aFontSpec | The font specification. |
Returns: The new font.
| 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.
See also: SystemGc()
Returns: A new graphics context.
| 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.
| Parameter | Description |
|---|---|
| aReader | The resource reader. |
| aResourceId | The numeric ID of the resource to be read. |
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.
See also: CCoeControl::ScreenFont() CCoeFontProvider
| Parameter | Description |
|---|---|
| aFontSpec | The font specification. |
Returns: The new font.
| IMPORT_C const CCoeFontProvider & | DefaultFontProvider | ( | ) | const |
This function returns the default font provider.
Returns: The default font provider.
| IMPORT_C CCoeTextDrawerBase & | DefaultTextDrawer | ( | ) | const |
This function returns the default text drawer.
Returns: The default text drawer.
| 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.
| 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().
| IMPORT_C void | DisableExitChecks | ( | TBool | 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.
| Parameter | Description |
|---|---|
| aDisable | True to disable resource checking, false to enable it. |
| 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().
See also: CActive::Cancel
| TDes & | ErrorContextText | ( | ) | [protected, inline] |
Gets the current error context text.
Returns: The current error context text.
| TDes & | ErrorText | ( | ) | [protected, inline] |
Gets the current error message text.
Returns: The current error message text.
| 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.
| IMPORT_C void | ExecuteFepSettingsDialogL | ( | TUid | aFepUid | ) |
Executes the settings dialog for the specified secure FEP.
The specified FEP does not need to be loaded.
| Parameter | Description |
|---|---|
| aFepUid | The UID of the secure FEP for which the settings dialog is to be executed. |
| IMPORT_C CCoeFep * | Fep | ( | ) | const |
Gets a pointer to the currently loaded FEP.
Returns: The currently loaded FEP, or NULL if none is currently loaded.
| IMPORT_C TUid | FepUid | ( | ) | const |
Gets the UID of the currently loaded FEP.
Returns: The UID of the currently loaded FEP. Zero if none is currently loaded.
| IMPORT_C void | Flush | ( | TTimeIntervalMicroSeconds32 | 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.
| Parameter | Description |
|---|---|
| aDelay | Delay for which to sleep the current process after flushing the window server buffer. By default the delay is zero. |
| 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().
| Parameter | Description |
|---|---|
| aFepObserverFunction | The function to be called. |
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.
| Parameter | Description |
|---|---|
| aDes | On return, contains the formatted resource data. |
| aResourceId | The numeric ID of the resource to be read. |
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.
| Parameter | Description |
|---|---|
| aDes | On return, contains the formatted resource data. |
| aResourceId | The numeric ID of the resource to be read. |
| IMPORT_C void | HandleError | ( | TInt | 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.
| CVwsSessionWrapper * | InitViewServerSessionL | ( | MVwsSessionWrapperObserver & | aObserver | ) |
| IMPORT_C void | InputCapabilitiesChanged | ( | ) |
Notifies all focus observers (FEPs) that a change has been made to the input capabilities of the focused control.
| IMPORT_C void | InstallFepL | ( | TUid | aFepUid | ) |
Loads the specified secure FEP into all running applications.
The currently loaded FEP, if any, is unloaded.
| Parameter | Description |
|---|---|
| aFepUid | The UID of the secure FEP to be loaded. |
Loads the specified secure FEP into all running applications.
The currently loaded FEP, if any, is unloaded.
| Parameter | Description |
|---|---|
| aFepUid | The UID of the secure FEP to be loaded. |
| aLeave | No longer used. |
| IMPORT_C TBool | IsRedrawEventPending | ( | ) | const |
Tests if there is a redraw event waiting to be processed.
Returns: ETrue if a redraw event is pending. EFalse if no redraw event is pending.
| 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.
Returns: ETrue if a standard event is pending. EFalse if no standard event is pending.
| 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.
Returns: The last event.
| IMPORT_C TTypeUid::Ptr | MopSupplyObject | ( | TTypeUid | aId | ) | [protected] |
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.
| Parameter | Description |
|---|---|
| aId | An encapsulated object type ID. |
Returns: Encapsulates the pointer to the object provided. Note that the encapsulated pointer may be NULL.
| const CFont * | NormalFont | ( | ) | const [inline] |
Gets the normal environment font.
This is the font created during construction of the control environment.
See also: InitSystemFontsL()
Returns: Pointer to the normal environment font.
| void | NotifyFocusObserversOfDestructionOfFocusedItem | ( | ) |
| void | NotifyMessageMonitorObserversOfEvent | ( | const TWsEvent & | aEvent | ) |
| 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.
| void | QueueNotificationToFocusObserversOfChangeInFocus | ( | ) |
| IMPORT_C CDesC16ArrayFlat * | ReadDesC16ArrayResourceL | ( | TInt | aResourceId | ) |
Reads a resource into a 16 bit descriptor array.
Ownership of the array is transferred to the caller.
See also: TResourceReader::ReadDesC16ArrayL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: A pointer to the descriptor array containing the resource data.
| IMPORT_C CDesC8ArrayFlat * | ReadDesC8ArrayResourceL | ( | TInt | aResourceId | ) |
Reads a resource into an 8 bit descriptor array.
See also: TResourceReader::ReadDesC8ArrayL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: A pointer to the descriptor array containing the resource data.
| CDesCArrayFlat * | ReadDesCArrayResourceL | ( | TInt | aResourceId | ) | [inline] |
Reads a resource into a Unicode descriptor array.
See also: TResourceReader::ReadDesCArrayL()
| Parameter | Description |
|---|---|
| aResourceId | The numeric ID of the resource to be read. |
Returns: A pointer to the descriptor array containing the resource data.
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.
See also: RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk
| Parameter | Description |
|---|---|
| aDes | On return, contains the resource data. |
| aResourceId | The numeric ID of the resource to be read. |
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.
See also: RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk
| Parameter | Description |
|---|---|
| aDes | On return, contains the read resource. |
| aResourceId | The numeric ID of the resource to be read. |
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.
| Parameter | Description |
|---|---|
| aDes | On return, contains the read resource. |
| aResourceId | The numeric ID of the resource to be read. |
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.
See also: RResourceFile::ReadL() KErrCoeFailedToReadFromProgDisk
| Parameter | Description |
|---|---|
| aDes | On return, contains the read resource. |
| aResourceId | The numeric ID of the resource to be read. |
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.
| Parameter | Description |
|---|---|
| aDes | On return, contains the read resource. |
| aResourceId | The numeric ID of the resource to be read. |
Reads a resource into a descriptor.
The descriptor must be long enough to contain the entire resource. No memory is allocated by this function.
| Parameter | Description |
|---|---|
| aDes | On return, contains the resource data. |
| aResourceId | The numeric ID of the resource to be read. |
Returns: Pointer to a heap descriptor containing the resource.
| 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().
| Parameter | Description |
|---|---|
| aFont | The font to be released. |
| IMPORT_C void | RemoveFepObserver | ( | MCoeFepObserver & | aFepObserver | ) |
Removes the specified FEP observer.
See also: AddFepObserverL()
| Parameter | Description |
|---|---|
| aFepObserver | The FEP observer to be removed. |
| IMPORT_C void | RemoveFocusObserver | ( | MCoeFocusObserver & | aFocusObserver | ) |
Removes the specified focus observer.
See also: AddFocusObserverL()
| Parameter | Description |
|---|---|
| aFocusObserver | The focus observer to be removed. |
| IMPORT_C void | RemoveForegroundObserver | ( | MCoeForegroundObserver & | aForegroundObserver | ) |
Removes the specified foreground observer.
See also: AddForegroundObserverL()
| Parameter | Description |
|---|---|
| aForegroundObserver | The foreground observer to be removed. |
| IMPORT_C void | RemoveMessageMonitorObserver | ( | MCoeMessageMonitorObserver & | aMessageMonitorObserver | ) |
Removes the specified MCoeMessageMonitorObserver.
| Parameter | Description |
|---|---|
| aMessageMonitorObserver | The visibility change observer to be removed. |
| IMPORT_C void | RemoveMessageObserver | ( | MCoeMessageObserver & | aMessageObserver | ) |
Removes the specified MCoeMessageObserver from the message observer list.
See also: AddMessageObserverL()
| Parameter | Description |
|---|---|
| aMessageObserver | The message observer to be removed from the list. |
| IMPORT_C void | RemoveObserverOfLoadedFep | ( | MCoeObserverOfLoadedFep & | aObserverOfLoadedFep | ) |
Removes the specified loaded FEP observer.
| Parameter | Description |
|---|---|
| aObserverOfLoadedFep | The FEP observer to be removed. |
| IMPORT_C void | RemoveResourceChangeObserver | ( | MCoeResourceChangeObserver & | aResourceChangeObserver | ) |
Removes the specified resource change observer.
| Parameter | Description |
|---|---|
| aResourceChangeObserver | The resource change observer to be removed. |
| 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.
Returns: The application's window group.
| IMPORT_C RWindowGroup * | RootWin | ( | TInt | aScreenNumber | ) | const |
This function returns the window group associated with the screen device that bears this particular screen number.
Returns: the window group associated with the screen device that bears this particular screen number.
| 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.
See also: CActiveScheduler::Start CActiveScheduler::Error CActiveScheduler::WaitForAnyRequest TRAPD
| 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.
Returns: The default screen device owned by this CCoeEnv.
| IMPORT_C CWsScreenDevice * | ScreenDevice | ( | TInt | aScreenNumber | ) | const |
This function returns the screen device with this particular screen number.
Returns: the screen device with this particular screen number.
| IMPORT_C void | SetAppStartupInstrumentationEventIdBaseL | ( | TInt | aAppStartupInstrumentationEventIdBase | ) | [protected] |
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.
| Parameter | Description |
|---|---|
| aAppUi | The app UI for this application. |
Returns: The app UI previously owned by this application, or NULL if this is the first time its app UI has been set.
| IMPORT_C void | SetZoomFactor | ( | const TZoomFactor & | aZoomFactor | ) |
Sets the zoom factor of all controls currently on the control stack.
See also: CCoeControl::SetZoomFactor()
| 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.
| Parameter | Description |
|---|---|
| aKeyEvent | The key event. |
| aType | The event type. |
| 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);
Returns: The pointer for accessing CCoeEnv's functions.
| IMPORT_C CCoeStatic * | Static | ( | TUid | aUid | ) | [static] |
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.
| Parameter | Description |
|---|---|
| aUid | The UID of the CCoeStatic derived class. |
Returns: A pointer to the CCoeStatic derived object. NULL if no match is found.
| IMPORT_C void | SuppressNextFlush | ( | ) |
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().
| CWindowGc & | SystemGc | ( | ) | const [inline] |
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().
Returns: The system graphics context.
| IMPORT_C TVersion | Version | ( | ) | [static] |
Gets the version number of the UI Control Framework API.
Returns: The version number, comprising major, minor and build numbers.
| RWsSession & | WsSession | ( | ) | const [inline] |
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 window server session opened by the application.
| IMPORT_C TZoomFactor | ZoomFactor | ( | ) | const |
Returns the zoom factor last set by calling CCoeEnv::SetZoomFactor().