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.

Destructor

Frees any resources allocated by this CEikonEnv during construction.

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.

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.

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.

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

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

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.

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.

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

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

Displays an alert window with a brief message.

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.

Gets the standard annotation font for this environment.

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

CCoeControl::ScreenFont() CCoeFontProvider

Gets required application server for running the application.

Gets the application UI factory object.

This object implements the MEikAppUiFactory interface.

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.

Emits a beep.

This method is deprecated.

Gets the specified bitmap.

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

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.

Cancels any existing busy message.

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

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

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

The message's text is read from resource.

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

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

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.

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

Deletes arrays of resource file offsets, Control Factory functions and libraries.

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

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.

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

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

TApaApplicationFactory

Second-phase constructor.

This calls the next overload with ETrue as the parameter.

Second-phase constructor.

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

Second-phase constructor.

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.

Returns control factory function array (pointer)

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

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.

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.

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.

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.

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

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.

Gets the custom colour array.

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

Gets the standard dense font for this environment.

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

CCoeControl::ScreenFont() CCoeFontProvider

Framework function

Framework function

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

Displays tasks present in the Task List.

Exported for testing only.

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.

Tests whether the document name is a file.

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

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.

Gets the application UI of the application using this CEikonEnv.

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

If none exists, then the function returns NULL.

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

Gets the nearest match to the specified font.

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

CCoeControl::ScreenFont() CCoeFontProviderThe return value is never NULL.

Creates a file server allocation information message from resource.

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

Gets the text for a standard error code.

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

It returns whether the error code is valid or not.

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

It returns whether the error code is valid or not.

Gets the printer names from a CPrinterModelList.

The printer names are returned through aPrinterNameList.

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.

Handles the specified error.

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

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.

Static callback function for use with Idle Object (iErrorIdler). Standard Symbian OS callback paradigm.

Gets the info dialog for this environment.

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

The message disappears after a few seconds.

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.

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.

Cancels the currently displaying information message.

Displays a message in the specified corner of the screen.

The message disappears after a few seconds.

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.

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.

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.

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.

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.

Displays an info message for a specified period.

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.

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.

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

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

Sets up query or info box text using IDs to read from resource file. Calls QueryWinL or InfoWinL according to final param CEikonEnv::QueryWinL(const TDesC& aFirstLine,const TDesC& aSecondLine) CEikonEnv::InfoWinL(const TDesC& aFirstLine,const TDesC& aSecondLine)

Creates and populates array of bitmaps.

Framework function. Creates array of system fonts.

Tests whether the application is marked as busy.

Tests the value of the system attribute.

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.

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

Displays a formatted information message and then leaves.

Gets the standard legend font for this environment.

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

CCoeControl::ScreenFont() CCoeFontProvider

This function forms part of the construction process (called by ConstructL) Creates and populates array of libaries. Loads ECOM plugins with interface UID KUikonLibraryUid Adds control factories to control factory array. Adds resource file offsets to resource file offset array

Creates a default character format layer.

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

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

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

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

It has an inter line spacing of zero.

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.

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

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

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

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

Gets the picture factory for this environment.

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.

Calls (virtual) PostAppUiInitializeL on all loaded libraries.

CEikLibrary::PostAppUiInitializeL

Sets up iBusyMsgWin (pointer to non-owned interface)

Handler for extended error codes. Passes aError to AppUi for handling first.

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

Gets the query dialog for this environment.

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

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.

Removes a control from the control stack.

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

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.

Framework function

Tests whether the application responds to shutdown events.

Tests whether an application responds to switch files events.

Sets a sleeping dialog's state.

Sends the event to the Eikon Server.

Sets the enviroment's alert window.

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

Sets the application's busy state.

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

For debugging purposes only. Set __UHEAP_SETFAIL using command line parameter

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.

Sets whether a document name is a file.

Use CCoeStatic instead

Sets the dialog.

Sets the query dialog.

Sets the request information dialog.

Sets the request query dialog.

Sets whether the application responds to shutdown events.

Sets whether the application responds to switch files events.

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.

Sets the Verbose Information Reporting state.

Gets whether server is required or not.

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.

CCoeEnv::Static()

Sets language in iEikEnvExtra and baflutils. Gets language from application if possible, device otherwise.

Gets the standard symbol font for this environment.

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

CCoeControl::ScreenFont() CCoeFontProvider

Gets the character format layer, if it exists.

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

Gets the paragraph format layer if it exists.

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

Gets the single line paragraph format layer if it exists.

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

Gets the standard title font for this environment.

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

CCoeControl::ScreenFont() CCoeFontProvider

Replaces the system colour list with the list specified.

If no system colour list exists, one is created.

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

Updates the process and thread name from the caption.

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

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

Gets the Uikon version that is currently running.

Gets the virtual cursor.

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.

Creates a window server allocation information message from resource.

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