Class CEikonEnv

class CEikonEnv : public CCoeEnv;

Description

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

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

Derivation

• MObjectProvider - An interface that allows an object to be part of a network of object providers
• CBase - Base class for all classes to be instantiated on the heap
• CActive - The core class of the active object abstraction
• CCoeEnv - Control environment
• CEikonEnv - An environment for creating controls and utility functions for manipulating them

Members

Defined in CEikonEnv:
AddAlertDialogLikeControlToStackL(), AddDialogLikeControlToStackL(), AddLibraryL(), AddLibraryL(), AddPictureFactoryL(), AddSleepingAlertDialogToStackL(), AddSleepingDialogToStackL(), AddWindowShadow(), Alert(), AlertWin(), AlertWin(), AllocInfoMsg(), AnnotationFont(), AppServer(), AppUiFactory(), AppUiFactory(), Beep(), Bitmap(), BringForwards(), BusyMsgCancel(), BusyMsgL(), BusyMsgL(), BusyMsgL(), BusyMsgL(), BusyMsgL(), BusyMsgL(), CEikonEnv(), CEikonEnv_Reserved_1(), CEikonEnv_Reserved_10(), CEikonEnv_Reserved_2(), CEikonEnv_Reserved_3(), CEikonEnv_Reserved_4(), CEikonEnv_Reserved_5(), CEikonEnv_Reserved_6(), CEikonEnv_Reserved_7(), CEikonEnv_Reserved_8(), CEikonEnv_Reserved_9(), ClockDllL(), Color(), ColorList(), ConfirmLossOfAllChangesL(), ConstructAppFromCommandLineL(), ConstructL(), ConstructL(), ConstructL(), ControlColor(), ControlStackReadyL(), CreateBitmapL(), CreateBitmapL(), CreateIconFromMaskedBitmapL(), CreateIconL(), CreateSystemColorListL(), CreateSystemColorListL(), CustomColorArray(), DefaultDisplayMode(), DenseFont(), DestroyEnvironment(), DismissTaskList(), DisplayTaskList(), DocNameIsAFile(), DrawCursor(), DrawCursor(), EErrorNumInvalid, EErrorNumValid, EikAppUi(), ExtendedPictureFactory(), Font(), FservAllocInfoMsg(), GetErrorText(), GetPrinterNamesL(), GrayBitmap(), HandleError(), HandleErrorWithContext(), HideCursor(), InfoDialog(), InfoMsg(), InfoMsg(), InfoMsg(), InfoMsgCancel(), InfoMsgWithAlignment(), InfoMsgWithAlignment(), InfoMsgWithAlignment(), InfoMsgWithAlignmentAndDuration(), InfoMsgWithAlignmentAndDuration(), InfoMsgWithAlignmentAndDuration(), InfoMsgWithDuration(), InfoMsgWithDuration(), InfoMsgWithDuration(), InfoWinL(), InfoWinL(), InitSystemFontsL(), IsBusy(), IsSystem(), LaunchPopupMenuL(), LeaveWithErrorContext(), LeaveWithInfoMsg(), LegendFont(), NewDefaultCharFormatLayerL(), NewDefaultParaFormatLayerL(), NewDefaultPrintSetupL(), NewDefaultSingleLineParaFormatLayerL(), NotifyIdleError(), NotifyIdleErrorWhileRedrawing(), NudgeCharMinus(), NudgeCharPlus(), OptionBitmap(), OptionMaskBitmap(), PictureFactory(), PopulateColorArrayL(), Process(), QueryDialog(), QueryWinL(), QueryWinL(), RemoveFromStack(), RemoveLibrary(), RemoveLibrary(), RemovePictureFactory(), Reserved_1(), Reserved_2(), ResolveError(), ResourceFileVersionNumber(), RespondsToShutdownEvent(), RespondsToSwitchFilesEvent(), RouseSleepingDialog(), SetAutoForwarding(), SetBusy(), SetColor(), SetDocNameIsAFile(), SetInfoDialog(), SetQueryDialog(), SetRequestInfoDialogFunc(), SetRequestQueryDialogFunc(), SetRespondsToShutdownEvent(), SetRespondsToSwitchFilesEvent(), SetSystem(), StartedAsServerApp(), Static(), SymbolFont(), SystemCharFormatLayerL(), SystemParaFormatLayerL(), SystemSingleLineParaFormatLayerL(), TErrorValidity, TexturedBitmap(), TitleFont(), UpdateSystemColorListL(), UpdateSystemFontsL(), UpdateTaskNameL(), VerboseInfoMsg(), Version(), VirtualCursor(), WservAllocInfoMsg(), ~CEikonEnv()

Inherited from CActive:
Cancel(), Deque(), EPriorityHigh, EPriorityIdle, EPriorityLow, EPriorityStandard, EPriorityUserInput, Extension_(), IsActive(), IsAdded(), Priority(), SetActive(), SetPriority(), TPriority, iStatus

Inherited from CBase:
Delete(), operator new()

Inherited from CCoeEnv:
AddFepObserverL(), AddFocusObserverL(), AddForegroundObserverL(), AddMessageMonitorObserverL(), AddMessageObserverL(), AddObserverOfLoadedFepL(), AddResourceChangeObserverL(), AddResourceFileL(), AllocReadResourceAsDes16L(), AllocReadResourceAsDes16LC(), AllocReadResourceAsDes8L(), AllocReadResourceAsDes8LC(), AllocReadResourceL(), AllocReadResourceLC(), AppUi(), AvailableFepsL(), BringOwnerToFront(), CreateDeviceFontL(), CreateGcL(), CreateResourceReaderLC(), CreateScreenFontL(), DefaultFontProvider(), DefaultTextDrawer(), DeleteResourceFile(), DestroyScreen(), DisableExitChecks(), DoCancel(), ErrorContextText(), ErrorText(), ExecuteD(), ExecuteFepSettingsDialogL(), Fep(), FepUid(), FindStatic(), Flush(), ForEachFepObserverCall(), Format128(), Format256(), FsSession(), InputCapabilitiesChanged(), InstallFepL(), IsRedrawEventPending(), IsResourceAvailableL(), IsSchedulerRunning(), IsWservEventPending(), LastEvent(), LeaveWithErrorText(), MopSupplyObject(), NormalFont(), PrepareToExit(), ReadDesC16ArrayResourceL(), ReadDesC8ArrayResourceL(), ReadDesCArrayResourceL(), ReadResource(), ReadResourceAsDes16(), ReadResourceAsDes16L(), ReadResourceAsDes8(), ReadResourceAsDes8L(), ReadResourceL(), ReleaseScreenFont(), RemoveFepObserver(), RemoveFocusObserver(), RemoveForegroundObserver(), RemoveMessageMonitorObserver(), RemoveMessageObserver(), RemoveObserverOfLoadedFep(), RemoveResourceChangeObserver(), RootWin(), RunError(), RunL(), ScreenDevice(), SetAppUi(), SimulateKeyEventL(), SuppressNextFlush(), SwapSystemGc(), SyncNotifyFocusObserversOfChangeInFocus(), SystemGc(), WsSession(), iAppUi, iFsSession, iLastEvent, iNormalFont, iResourceFileArray, iRootWin, iScreen, iSystemGc, iWsSession

Inherited from MObjectProvider:
MObjectProvider_Reserved1(), MObjectProvider_Reserved2(), MopGetObject(), MopGetObjectNoChaining(), MopNext()

IMPORT_C ~CEikonEnv();

Description

Destructor

Frees any resources allocated by this CEikonEnv during construction.

IMPORT_C CEikonEnv();

Description

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.

IMPORT_C void ConstructL();

Description

Second-phase constructor.

This calls the next overload with ETrue as the parameter.

IMPORT_C void ConstructL(TBool aInitialFocusState);

Description

Second-phase constructor.

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

Parameters

TBool aInitialFocusState The window group's initial focus state. If ETrue, keyboard focus is enabled, if EFalse, keyboard focus is disabled.

IMPORT_C void ConstructL(TBool aInitialFocusState, TInt aWindowGroupID);

Description

Second-phase constructor.

Parameters

TBool aInitialFocusState The window group's initial focus state. If ETrue, keyboard focus is enabled, if EFalse, keyboard focus is disabled. TInt aWindowGroupID The window group ID of the parent window

IMPORT_C void ConstructAppFromCommandLineL(const TApaApplicationFactory &aApplicationFactory, const CApaCommandLine &aCommandLine);

Description

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

Parameters

const TApaApplicationFactory &aApplicationFactory The factory to use to create the application const CApaCommandLine &aCommandLine The command line used to initialise the new application.

See also:

• TApaApplicationFactory

IMPORT_C void ControlStackReadyL();

Description

Initialises the control stack.

static IMPORT_C TVersion Version();

Description

Gets the Uikon version that is currently running.

Return value

TVersion The Uikon version.

static inline CEikonEnv *Static();

Description

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.

Return value

CEikonEnv * A static CEikonEnv.

See also:

• CCoeEnv::Static()

IMPORT_C const CFont *AnnotationFont() const;

Description

Gets the standard annotation font for this environment.

Return value

const CFont * Pointer to the annotation font.

IMPORT_C const CFont *TitleFont() const;

Description

Gets the standard title font for this environment.

Return value

const CFont * Pointer to the title font.

IMPORT_C const CFont *LegendFont() const;

Description

Gets the standard legend font for this environment.

Return value

const CFont * Pointer to the legend font.

IMPORT_C const CFont *SymbolFont() const;

Description

Gets the standard symbol font for this environment.

Return value

const CFont * Pointer to the symbol font.

IMPORT_C const CFont *DenseFont() const;

Description

Gets the standard dense font for this environment.

Return value

const CFont * Pointer to the dense font.

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

Description

Gets the nearest match to the specified font.

The return value is never NULL.

Parameters

const TLogicalFont &aLogicalFont The font for which a match is sought.

Return value

const CFont * Pointer to the font that most closely matches aLogicalFont.

Interface status:

deprecated

IMPORT_C const CFbsBitmap *TexturedBitmap() const;

Description

Return value

const CFbsBitmap *

Interface status:

deprecated

IMPORT_C const CFbsBitmap *GrayBitmap() const;

Description

Return value

const CFbsBitmap *

Interface status:

deprecated

IMPORT_C const CFbsBitmap *OptionBitmap() const;

Description

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

Return value

const CFbsBitmap * A pointer to the option bitmap.

Interface status:

deprecated

IMPORT_C const CFbsBitmap *OptionMaskBitmap() const;

Description

Return value

const CFbsBitmap *

IMPORT_C const CFbsBitmap *Bitmap(TUid aUidBmp) const;

Description

Gets the specified bitmap.

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

Parameters

TUid aUidBmp The UID of the bitmap to retrieve.

Return value

const CFbsBitmap * Pointer to the bitmap.

inline CEikProcess *Process() const;

Description

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

Return value

CEikProcess * The CEikProcess object.

inline const MEikAlertWin *Alert() const;

Description

Return value

const MEikAlertWin *

IMPORT_C MPictureFactory *PictureFactory() const;

Description

Gets the picture factory for this environment.

Return value

MPictureFactory * The picture factory.

IMPORT_C MEikPictureFactory *ExtendedPictureFactory(TUid aPictureType) const;

Description

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

If none exists, then the function returns NULL.

Parameters

TUid aPictureType The picture type.

Return value

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

IMPORT_C void AddPictureFactoryL(MEikPictureFactory &aFactory);

Description

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

Parameters

MEikPictureFactory &aFactory The picture factory to add.

IMPORT_C void RemovePictureFactory(TUid aFactoryId);

Description

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

Parameters

TUid aFactoryId The Id of the picture factory to be removed.

IMPORT_C void AlertWin(const TDesC &aMsg);

Description

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

Parameters

const TDesC &aMsg Message to be displayed in the alert window.

IMPORT_C void AlertWin(const TDesC &aMsg1, const TDesC &aMsg2);

Description

Displays an alert window with a brief message.

Parameters

const TDesC &aMsg1 First line of the message. const TDesC &aMsg2 Second line of the message.

IMPORT_C void LeaveWithInfoMsg(TInt aResourceId,...);

Description

Displays a formatted information message and then leaves.

Parameters

TInt aResourceId ID of a TBUF resource used to hold the string. ...

Interface status:

deprecated

IMPORT_C void LeaveWithErrorContext(TInt aError, const TDesC &aContextText);

Description

Parameters

TInt aError const TDesC &aContextText

IMPORT_C void GetErrorText(TDes &aDes, TInt aError) const;

Description

Gets the text for a standard error code.

Parameters

TDes &aDes On return, contains the error text. TInt aError Error code.

IMPORT_C void ResolveError(TInt aError, TUid aAppUid=TUid::Null()) const;

Description

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.

Parameters

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

IMPORT_C void InfoMsg(const TDesC &aDes);

Description

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

The message disappears after a few seconds.

Parameters

const TDesC &aDes The message to display.

IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, const TDesC &aDes);

Description

Displays a message in the specified corner of the screen.

The message disappears after a few seconds.

Parameters

TGulAlignment aCorner The screen corner the message is displayed in. const TDesC &aDes The message to display.

IMPORT_C void InfoMsg(TInt aResourceId,...);

Description

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.

Parameters

TInt aResourceId ID of a TBUF resource used to hold the string. ...

IMPORT_C void InfoMsg(TInt aResourceId, VA_LIST aList);

Description

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.

Parameters

TInt aResourceId ID of a TBUF resource used to hold the string. VA_LIST aList List of values to be formatted.

IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, TInt aResourceId,...);

Description

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.

Parameters

TGulAlignment aCorner The corner of the screen the message is displayed in. TInt aResourceId ID of a TBUF resource used to hold the string. ...

IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, TInt aResourceId, VA_LIST aList);

Description

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.

Parameters

TGulAlignment aCorner The corner of the screen the message is displayed in. TInt aResourceId ID of a TBUF resource used to hold the string. VA_LIST aList List of values to be formatted.

IMPORT_C void InfoMsgWithDuration(const TDesC &aDes, TTimeIntervalMicroSeconds32 aDuration);

Description

Displays an info message for a specified period.

Parameters

const TDesC &aDes Message to display. TTimeIntervalMicroSeconds32 aDuration Duration of message.

IMPORT_C void InfoMsgWithDuration(TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration,...);

Description

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.

Parameters

TInt aResourceId ID of a TBUF resource used to hold the string. TTimeIntervalMicroSeconds32 aDuration Duration of the message. ...

IMPORT_C void InfoMsgWithDuration(TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration, VA_LIST aList);

Description

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.

Parameters

TInt aResourceId ID of a TBUF resource used to hold the string. TTimeIntervalMicroSeconds32 aDuration Duration of message. VA_LIST aList List of values.

IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, const TDesC &aDes, TTimeIntervalMicroSeconds32 aDuration);

Description

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.

Parameters

TGulAlignment aCorner The screen corner the message is displayed in. const TDesC &aDes Message to display. TTimeIntervalMicroSeconds32 aDuration Duration of message.

IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration,...);

Description

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.

Parameters

TGulAlignment aCorner The screen corner the message is displayed in. TInt aResourceId ID of a TBUF resource used to contain the string. TTimeIntervalMicroSeconds32 aDuration Duration of message. ...

IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration, VA_LIST aList);

Description

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.

Parameters

TGulAlignment aCorner The screen corner the message is displayed in. TInt aResourceId ID of a TBUF resource used to contain the string. TTimeIntervalMicroSeconds32 aDuration Duration of message. VA_LIST aList List of values.

IMPORT_C void InfoMsgCancel();

Description

Cancels the currently displaying information message.

IMPORT_C void VerboseInfoMsg(const TDesC &aDes);

Description

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

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

Parameters

const TDesC &aDes Message to display.

IMPORT_C void BusyMsgL(const TDesC &aDes);

Description

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

Parameters

const TDesC &aDes Message to display.

IMPORT_C void BusyMsgL(const TDesC &aDes, TGulAlignment aCorner);

Description

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

Parameters

const TDesC &aDes Message to display. TGulAlignment aCorner Corner of the screen in which to display the message.

IMPORT_C void BusyMsgL(TInt aResourceId);

Description

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

The message's text is read from resource.

Parameters

TInt aResourceId ID of the resource that specifies the text to display.

IMPORT_C void BusyMsgL(const TDesC &aDes, TTimeIntervalMicroSeconds32 aInitialDelay);

Description

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

Parameters

const TDesC &aDes Message to display. TTimeIntervalMicroSeconds32 aInitialDelay Delay in microseconds before the message is first shown.

IMPORT_C void BusyMsgL(const TDesC &aDes, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aInitialDelay);

Description

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

Parameters

const TDesC &aDes Message to display. TGulAlignment aCorner Corner of the screen in which to display the message. TTimeIntervalMicroSeconds32 aInitialDelay Delay in microseconds before the message is first shown.

IMPORT_C void BusyMsgL(TInt aResourceId, TTimeIntervalMicroSeconds32 aInitialDelay);

Description

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.

Parameters

TInt aResourceId The ID of a text resource specifying the message text. TTimeIntervalMicroSeconds32 aInitialDelay Delay in microseconds before the message is first shown.

IMPORT_C void BusyMsgCancel();

Description

Cancels any existing busy message.

IMPORT_C TBool ConfirmLossOfAllChangesL() const;

Description

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

Return value

TBool Whether the user wants to lose all changes.

static IMPORT_C TBool QueryWinL(const TDesC &aFirstLine, const TDesC &aSecondLine);

Description

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

Parameters

const TDesC &aFirstLine First line of query text. const TDesC &aSecondLine Second line of query text.

Return value

TBool User's response.

IMPORT_C TBool QueryWinL(TInt aFirstLineId, TInt aSecondLineId=0) const;

Description

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.

Parameters

TInt aFirstLineId ID of resource describing the first line. TInt aSecondLineId ID of resource describing the second line.

Return value

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

static IMPORT_C void InfoWinL(const TDesC &aFirstLine, const TDesC &aSecondLine);

Description

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

Parameters

const TDesC &aFirstLine First line of dialog text. const TDesC &aSecondLine Second line of dialog text.

IMPORT_C void InfoWinL(TInt aFirstLineId, TInt aSecondLineId=0) const;

Description

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

Parameters

TInt aFirstLineId ID of the resource describing the first line. TInt aSecondLineId ID of the resource describing the second line.

IMPORT_C void SetQueryDialog(MEikInfoDialog *aQueryDialog);

Description

Sets the query dialog.

Parameters

MEikInfoDialog *aQueryDialog The query dialog.

IMPORT_C void SetInfoDialog(MEikInfoDialog *aInfoDialog);

Description

Sets the dialog.

Parameters

MEikInfoDialog *aInfoDialog The information dialog.

IMPORT_C void SetRequestQueryDialogFunc(TRequestDialogFunc aQueryDialogFunc);

Description

Sets the request query dialog.

Parameters

TRequestDialogFunc aQueryDialogFunc Request query dialog.

IMPORT_C void SetRequestInfoDialogFunc(TRequestDialogFunc aInfoDialogFunc);

Description

Sets the request information dialog.

Parameters

TRequestDialogFunc aInfoDialogFunc The request information dialog.

IMPORT_C void AllocInfoMsg();

Description

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.

IMPORT_C void WservAllocInfoMsg();

Description

Creates a window server allocation information message from resource.

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

IMPORT_C void FservAllocInfoMsg();

Description

Creates a file server allocation information message from resource.

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

Interface status:

deprecated

static IMPORT_C void Beep();

Description

Emits a beep.

This method is deprecated.

IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &aFileName, TInt aId);

Description

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.

Parameters

const TDesC &aFileName File name specifying the bitmap file to load. TInt aId Number of the bitmap in the file.

Return value

CWsBitmap * Pointer to the loaded bitmap. Ownership is transferred to the caller.

IMPORT_C CWsBitmap *CreateBitmapL(const TDesC &aFileName, TInt aId, TBool aShowDlgIfErr);

Description

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.

Parameters

const