![[Index]](../../../../a_stock/images/btn_index.gif)
![[Previous]](../../../../a_stock/images/btn_prev_top.gif)
![[Next]](../../../../a_stock/images/btn_next_top.gif)
|
|
|
|
|
|
||
class CEikonEnv : public CCoeEnv;
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.
CCoeEnv - No description.
CEikonEnv - An environment for creating controls and utility functions for manipulating them...
Defined in CEikonEnv:
AddAlertDialogLikeControlToStackL(CCoeControl *)Adds an alert dialog-like control (with a control stack priority of ECoeStackPri...AddDialogLikeControlToStackL(CCoeControl *)Adds a dialog-like control (with a control stack priority of ECoeStackPriorityDi...AddLibraryL(TCreateByTypeFunction)AddLibraryL(TFileName *)AddPictureFactoryL(MEikPictureFactory &)Adds the picture factory to the set of factories maintained by the Uikon environ...AddSleepingAlertDialogToStackL(CCoeControl *)Adds a sleeping dialog to the control stack, with a control stack priority of EC...AddSleepingDialogToStackL(CCoeControl *)Adds a sleeping dialog to the control stack, with a control stack priority of EC...AddWindowShadow(CCoeControl *)Adds a window shadow of the standard height to a control. Alert()constAlertWin(const TDesC &)Displays the environment's alert window containing a single line message.AlertWin(const TDesC &,const TDesC &)Displays an alert window with a brief message.AllocInfoMsg()Constructs an allocation information message.AnnotationFont()constGets the standard annotation font for this environment.AppServer()constGets required application server for running the application.AppUiFactory()constGets the application UI factory object.AppUiFactory(const CEikAppUi &)constGets the application UI factory object for the specified app UI.Beep()Emits a beep.Bitmap(TUid)constGets the specified bitmap.BringForwards(TBool,TInt)Repositions the root window group in the stacking hierarchy, or pushes it to the...BusyMsgCancel()Cancels any existing busy message. BusyMsgL(TInt)Displays a flashing busy message in the system default corner of the screen.BusyMsgL(TInt,TTimeIntervalMicroSeconds32)Displays a flashing busy message in the system default corner of the screen for ...BusyMsgL(const TDesC &)Displays a flashing busy message in the system default corner of the screen.BusyMsgL(const TDesC &,TGulAlignment)Displays a flashing busy message in the specified corner of the screen.BusyMsgL(const TDesC &,TGulAlignment,TTimeIntervalMicroSeconds32)Displays a flashing busy message for a specific amount of time in the corner of ...BusyMsgL(const TDesC &,TTimeIntervalMicroSeconds32)Displays a flashing busy message in the system default corner of the screen for ...CEikonEnv()Default C++ constructor.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()Gets the animated DLL that is used to animate the toolbar clock of the applicati...Color(TLogicalColor)constGets the physical (TRgb) colour which corresponds to a logical colour.ColorList()constGets the application's colour list.ConfirmLossOfAllChangesL()constDisplays a dialog asking the user to confirm that all changes will be lost to th...ConstructAppFromCommandLineL(const TApaApplicationFactory &,const CApaCommandLine &)Initialises an applicationConstructL()Second-phase constructor.ConstructL(TBool)Second-phase constructor.ConstructL(TBool,TInt)Second-phase constructor.ControlColor(TLogicalColor,const CCoeControl &)constGets the physical (TRgb) colour which corresponds to the logical colour specifie...ControlStackReadyL()Called by the framework to finish environment construction once the control stac...CreateBitmapL(const TDesC &,TInt)Loads, allocates and returns a pointer to a bitmap loaded from a multi-bitmap fi...CreateBitmapL(const TDesC &,TInt,TBool)Loads, allocates and returns a pointer to a bitmap loaded from a multi-bitmap fi...CreateIconFromMaskedBitmapL(const CApaMaskedBitmap &)Creates an icon from a masked bitmap.CreateIconL(const TDesC &,TInt,TInt)Creates an icon.CreateSystemColorListL()Creates and returns a system colour list, which is a palette of standard colours...CreateSystemColorListL(const CColorList &)Creates and returns a system colour list, which is a palette of standard colours...CustomColorArray()constGets the custom colour array.DefaultDisplayMode()constGets the default display mode for the window server session with the maximum pos...DenseFont()constGets the standard dense font for this environment.DestroyEnvironment()Framework function DestroyScreen()Framework function DismissTaskList()Causes the task list, if displayed, to be closed. DisplayTaskList()Displays tasks present in the Task List. DocNameIsAFile()constTests whether the document name is a file.DrawCursor(const CCoeControl *,const TPoint &,TInt)Calls the other overload of CEikonEnv::DrawCursor(const CCoeControl *,const TPoi...DrawCursor(const CCoeControl *,const TPoint &,TInt,TInt,TInt)Draws the text cursor into a control with the specified position and width.EErrorNumInvalidEErrorNumValidEikAppUi()constGets the application UI of the application using this CEikonEnv.ExtendedPictureFactory(TUid)constGets a picture factory object in the environment which supports the specified pi...Font(const TLogicalFont &)constGets the nearest match to the specified font.FservAllocInfoMsg()Creates a file server allocation information message from resource.GetErrorText(TDes &,TInt)constGets the text for a standard error code.GetErrorText(TDes &,TInt,TUid)constGets the text for an error code, in the specified application.GetErrorTextAndTitle(TDes &,TInt,TDes &)constGets the text for an error code, in the specified application.GetPrinterNamesL(CPrinterModelList *,CDesCArray &)Gets the printer names from a CPrinterModelList.GrayBitmap()constHandleError(TInt)Handles an error that has occurred in the application.HandleErrorWithContext(TInt,TInt)Handles the specified error.HideCursor(const CCoeControl *)Removes the text cursor from a control.InfoDialog()constGets the info dialog for this environment.InfoMsg(TInt,...)Displays a message in the system default corner of the screen.InfoMsg(TInt,VA_LIST)Displays a message in the system default corner of the screen.InfoMsg(const TDesC &)Displays a message in the system default corner of the screen.InfoMsgCancel()Cancels the currently displaying information message. InfoMsgWithAlignment(TGulAlignment,TInt,...)Displays a message in the specified corner of the screen.InfoMsgWithAlignment(TGulAlignment,TInt,VA_LIST)Displays a message in the specified corner of the screen.InfoMsgWithAlignment(TGulAlignment,const TDesC &)Displays a message in the specified corner of the screen.InfoMsgWithAlignmentAndDuration(TGulAlignment,TInt,TTimeIntervalMicroSeconds32,...)Displays an info message with a specified alignment for a specified period.InfoMsgWithAlignmentAndDuration(TGulAlignment,TInt,TTimeIntervalMicroSeconds32,VA_LIST)Displays an info message with a specified alignment for a specified period.InfoMsgWithAlignmentAndDuration(TGulAlignment,const TDesC &,TTimeIntervalMicroSeconds32)Displays an info message with a specified alignment for a specified period.InfoMsgWithDuration(TInt,TTimeIntervalMicroSeconds32,...)Displays an info message for a specified period.InfoMsgWithDuration(TInt,TTimeIntervalMicroSeconds32,VA_LIST)Displays an info message for a specified period.InfoMsgWithDuration(const TDesC &,TTimeIntervalMicroSeconds32)Displays an info message for a specified period.InfoWinL(TInt,TInt)constDisplays a modal information dialog with a one or two-line info message read fro...InfoWinL(const TDesC &,const TDesC &)Displays a modal information dialog with the specified lines of text.InitSystemFontsL()Framework function. Creates array of system fonts. IsBusy()constTests whether the application is marked as busy.IsSystem()constTests the value of the system attribute.LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *)Allows an application to launch a popup menu, by calling the app UI's CEikonEnv:...LeaveWithErrorContext(TInt,const TDesC &)LeaveWithInfoMsg(TInt,...)Displays a formatted information message and then leaves.LegendFont()constGets the standard legend font for this environment.NewDefaultCharFormatLayerL()Creates a default character format layer.NewDefaultParaFormatLayerL()Creates a default paragraph format layer suitable for multiple lines of text.NewDefaultPrintSetupL()Creates and returns a pointer to a new default printer setup object.NewDefaultSingleLineParaFormatLayerL()Creates a default paragraph format layer suitable for a single line of text.NotifyIdleError(TInt,TInt)Notifies this environment of an idle error.NotifyIdleErrorWhileRedrawing(TInt)Notifies this environment that an idle error occurred while redrawing was in pro...NudgeCharMinus()constGets the minus nudge character, this could be the left arrow for example.NudgeCharPlus()constGets the plus nudge character, this could be the right arrow for example.OptionBitmap()constGets the bitmap that is used by horizontal option buttons in this environment.OptionMaskBitmap()constPictureFactory()constGets the picture factory for this environment.PopulateColorArrayL()Creates and populates a colour list, a palette of standard colours used by the s...Process()constGets the Uikon process that manages the files of applications started in this en...QueryDialog()constGets the query dialog for this environment.QueryWinL(TInt,TInt)constRequests a yes or no response from the user using a modal query dialog.QueryWinL(const TDesC &,const TDesC &)Requests a yes or no response from the user using a modal query dialog.RemoveFromStack(CCoeControl *)Removes a control from the control stack.RemoveLibrary(TCreateByTypeFunction)RemoveLibrary(TInt)RemovePictureFactory(TUid)Removes the specified picture factory, if it exists, from the set of picture fac...ResolveError(TInt,TUid)constDisplays an error message appropriate to the error code aError in an alert windo...ResourceFileVersionNumber()constFramework function RespondsToShutdownEvent()constTests whether the application responds to shutdown events.RespondsToSwitchFilesEvent()constTests whether an application responds to switch files events.RouseSleepingDialog(CCoeControl *,TBool)Sets a sleeping dialog's state.SetAutoForwarding(TBool)Use this method to set whether the application's window group shall be automatic...SetBusy(TBool)Sets the application's busy state.SetColor(TLogicalColor,TRgb)Sets a mapping in the application's colour list between the logical and physical...SetDocNameIsAFile(TBool)Sets whether a document name is a file.SetInfoDialog(MEikInfoDialog *)Sets the dialog.SetQueryDialog(MEikInfoDialog *)Sets the query dialog.SetRequestInfoDialogFunc(TRequestDialogFunc)Sets the request information dialog.SetRequestQueryDialogFunc(TRequestDialogFunc)Sets the request query dialog.SetRespondsToShutdownEvent(TBool)Sets whether the application responds to shutdown events.SetRespondsToSwitchFilesEvent(TBool)Sets whether the application responds to switch files events.SetSystem(TBool)Sets the application's system attribute.StartedAsServerApp()constGets whether server is required or not.Static()Gets the CEikonEnv maintained by the framework for the application.SymbolFont()constGets the standard symbol font for this environment.SystemCharFormatLayerL()Gets the character format layer, if it exists.SystemParaFormatLayerL()Gets the paragraph format layer if it exists.SystemSingleLineParaFormatLayerL()Gets the single line paragraph format layer if it exists.TErrorValidityTexturedBitmap()constTitleFont()constGets the standard title font for this environment.UpdateSystemColorListL(const CColorList &)Replaces the system colour list with the list specified.UpdateSystemFontsL()Calls Laf implementation of CEikonEnv::UpdateSystemFontsL() to update local arra...UpdateTaskNameL()Updates the process and thread name from the caption. VerboseInfoMsg(const TDesC &)Displays an information message if verbose information reporting has been set.Version()Gets the Uikon version that is currently running.VirtualCursor()Gets the virtual cursor.WservAllocInfoMsg()Creates a window server allocation information message from resource.~CEikonEnv()DestructorIMPORT_C ~CEikonEnv();
Destructor
Frees any resources allocated by this CEikonEnv during construction.
IMPORT_C CEikonEnv();
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();
Second-phase constructor.
This calls the next overload with ETrue as the parameter.
IMPORT_C void ConstructL(TBool aInitialFocusState);
Second-phase constructor.
Calls the next overload with a default window group ID which will be ignored.
|
IMPORT_C void ConstructL(TBool aInitialFocusState, TInt aWindowGroupID);
Second-phase constructor.
|
|
|
IMPORT_C static TVersion Version();
Gets the Uikon version that is currently running.
|
static inline CEikonEnv* Static();
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.
|
IMPORT_C void ConstructAppFromCommandLineL(const TApaApplicationFactory &aApplicationFactory, const CApaCommandLine &aCommandLine);
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(TApaCommand,TFileName &,const TDesC8 &).
|
![[Top]](../../../../a_stock/images/arrow_up_2.gif){kind=icon}
TApaApplicationFactoryEncapsulates the functionality of creating an application, whether it be via a f...IMPORT_C void ControlStackReadyL();
Called by the framework to finish environment construction once the control stack has been created and is ready.
inline CEikAppUi* EikAppUi() const;
Gets the application UI of the application using this CEikonEnv.
|
inline CEikProcess* Process() const;
Gets the Uikon process that manages the files of applications started in this environment.
|
IMPORT_C const CFont* AnnotationFont() const;
Gets the standard annotation font for this environment.
|
IMPORT_C const CFont* TitleFont() const;
Gets the standard title font for this environment.
|
IMPORT_C const CFont* LegendFont() const;
Gets the standard legend font for this environment.
|
IMPORT_C const CFont* SymbolFont() const;
Gets the standard symbol font for this environment.
|
IMPORT_C const CFont* DenseFont() const;
Gets the standard dense font for this environment.
|
IMPORT_C const CFont* Font(const TLogicalFont &aLogicalFont) const;
Gets the nearest match to the specified font.
The return value is never NULL.
|
|
IMPORT_C void UpdateSystemFontsL();
Calls Laf implementation of CEikonEnv::UpdateSystemFontsL() to update local array of system fonts
| Interface status: | deprecated |
IMPORT_C const CFbsBitmap* TexturedBitmap() const;
|
| Interface status: | deprecated |
IMPORT_C const CFbsBitmap* GrayBitmap() const;
|
| Interface status: | deprecated |
IMPORT_C const CFbsBitmap* OptionBitmap() const;
Gets the bitmap that is used by horizontal option buttons in this environment.
|
| Interface status: | deprecated |
IMPORT_C const CFbsBitmap* OptionMaskBitmap() const;
|
IMPORT_C const CFbsBitmap* Bitmap(TUid aUidBmp) const;
Gets the specified bitmap.
This function returns a bitmap from the list of bitmaps by using the UID as an index.
|
|
IMPORT_C TBool ConfirmLossOfAllChangesL() const;
Displays a dialog asking the user to confirm that all changes will be lost to the current document, and returns the response.
|
IMPORT_C MPictureFactory* PictureFactory() const;
Gets the picture factory for this environment.
|
IMPORT_C MEikPictureFactory* ExtendedPictureFactory(TUid aPictureType) const;
Gets a picture factory object in the environment which supports the specified picture type.
If none exists, then the function returns NULL.
|
|
IMPORT_C void AddPictureFactoryL(MEikPictureFactory &aFactory);
Adds the picture factory to the set of factories maintained by the Uikon environment.
|
IMPORT_C void RemovePictureFactory(TUid aFactoryId);
Removes the specified picture factory, if it exists, from the set of picture factories owned by the Uikon environment.
|
IMPORT_C void AlertWin(const TDesC &aMsg);
Displays the environment's alert window containing a single line message.
|
IMPORT_C void AlertWin(const TDesC &aMsg1, const TDesC &aMsg2);
Displays an alert window with a brief message.
|
IMPORT_C void LeaveWithInfoMsg(TInt aResourceId,...);
Displays a formatted information message and then leaves.
|
| Interface status: | deprecated |
IMPORT_C void LeaveWithErrorContext(TInt aError, const TDesC &aContextText);
|
IMPORT_C void GetErrorText(TDes &aDes, TInt aError) const;
Gets the text for a standard error code.
|
IMPORT_C TErrorValidity GetErrorText(TDes &aErrorText, TInt aError, TUid aAppUid) const;
Gets the text for an error code, in the specified application.
It returns whether the error code is valid or not.
|
|
IMPORT_C TErrorValidity GetErrorTextAndTitle(TDes &aErrorText, TInt aError, TDes &aTitleText) const;
Gets the text for an error code, in the specified application.
It returns whether the error code is valid or not.
|
|
IMPORT_C void ResolveError(TInt aError, TUid aAppUid=TUid::Null()) const;
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.
|
IMPORT_C void NotifyIdleErrorWhileRedrawing(TInt aError);
Notifies this environment that an idle error occurred while redrawing was in progress.
|
IMPORT_C void NotifyIdleError(TInt aError, TInt aContextResourceId);
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.
|
IMPORT_C void HandleErrorWithContext(TInt aError, TInt aContextResourceId);
Handles the specified error.
This function reads the error context text from the resource identified by aContextResourceId.
|
IMPORT_C void InfoMsg(const TDesC &aDes);
Displays a message in the system default corner of the screen.
The message disappears after a few seconds.
|
IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, const TDesC &aDes);
Displays a message in the specified corner of the screen.
The message disappears after a few seconds.
|
IMPORT_C void InfoMsg(TInt aResourceId,...);
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.
|
IMPORT_C void InfoMsg(TInt aResourceId, VA_LIST aList);
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.
|
IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, TInt aResourceId,...);
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.
|
IMPORT_C void InfoMsgWithAlignment(TGulAlignment aCorner, TInt aResourceId, VA_LIST aList);
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.
|
IMPORT_C void InfoMsgWithDuration(const TDesC &aDes, TTimeIntervalMicroSeconds32 aDuration);
Displays an info message for a specified period.
|
IMPORT_C void InfoMsgWithDuration(TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration,...);
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.
|
IMPORT_C void InfoMsgWithDuration(TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration, VA_LIST aList);
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.
|
IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, const TDesC &aDes, TTimeIntervalMicroSeconds32 aDuration);
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.
|
IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration,...);
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.
|
IMPORT_C void InfoMsgWithAlignmentAndDuration(TGulAlignment aCorner, TInt aResourceId, TTimeIntervalMicroSeconds32 aDuration,
VA_LIST aList);
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.
|
IMPORT_C void VerboseInfoMsg(const TDesC &aDes);
Displays an information message if verbose information reporting has been set.
The message is not displayed if verbose information reporting has not been set.
|
IMPORT_C void BusyMsgL(const TDesC &aDes);
Displays a flashing busy message in the system default corner of the screen.
|
IMPORT_C void BusyMsgL(const TDesC &aDes, TGulAlignment aCorner);
Displays a flashing busy message in the specified corner of the screen.
|
IMPORT_C void BusyMsgL(TInt aResourceId);
Displays a flashing busy message in the system default corner of the screen.
The message's text is read from resource.
|
IMPORT_C void BusyMsgL(const TDesC &aDes, TTimeIntervalMicroSeconds32 aInitialDelay);
Displays a flashing busy message in the system default corner of the screen for a specific amount of time.
|
IMPORT_C void BusyMsgL(const TDesC &aDes, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aInitialDelay);
Displays a flashing busy message for a specific amount of time in the corner of the screen indicated by aCorner.
|
IMPORT_C void BusyMsgL(TInt aResourceId, TTimeIntervalMicroSeconds32 aInitialDelay);
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.
|
IMPORT_C static TBool QueryWinL(const TDesC &aFirstLine, const TDesC &aSecondLine);
Requests a yes or no response from the user using a modal query dialog.
|
|
IMPORT_C TBool QueryWinL(TInt aFirstLineId, TInt aSecondLineId=0) const;
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.
|
|
IMPORT_C void SetQueryDialog(MEikInfoDialog *aQueryDialog);
Sets the query dialog.
|
IMPORT_C void SetRequestQueryDialogFunc(TRequestDialogFunc aQueryDialogFunc);
Sets the request query dialog.
|
IMPORT_C static void InfoWinL(const TDesC &aFirstLine, const TDesC &aSecondLine);
Displays a modal information dialog with the specified lines of text.
|
IMPORT_C void InfoWinL(TInt aFirstLineId, TInt aSecondLineId=0) const;
Displays a modal information dialog with a one or two-line info message read from the passed resources.
|
IMPORT_C void SetInfoDialog(MEikInfoDialog *aInfoDialog);
Sets the dialog.
|
IMPORT_C void SetRequestInfoDialogFunc(TRequestDialogFunc aInfoDialogFunc);
Sets the request information dialog.
|
IMPORT_C void AllocInfoMsg();
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();
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();
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 |
IMPORT_C static void Beep();
Emits a beep.
This method is deprecated.
IMPORT_C CWsBitmap* CreateBitmapL(const TDesC &aFileName, TInt aId);
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.
|
|
IMPORT_C CWsBitmap* CreateBitmapL(const TDesC &aFileName, TInt aId, TBool aShowDlgIfErr);
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.
|
|
IMPORT_C CGulIcon* CreateIconL(const TDesC &aFileName, TInt aBitmapId, TInt aMaskId=KErrNotFound);
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.
|
|
IMPORT_C static CGulIcon* CreateIconFromMaskedBitmapL(const CApaMaskedBitmap &aApaMaskedBitmap);
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.
|
|
IMPORT_C void LaunchPopupMenuL(TInt aResourceId, const TPoint &aTargetPos, TPopupTargetPosType aTargetType=EPopupTargetTopLeft,
const CEikHotKeyTable *aHotKeyTable=0);
Allows an application to launch a popup menu, by calling the app UI's CEikonEnv::LaunchPopupMenuL(TInt,const TPoint &,TPopupTargetPosType,const CEikHotKeyTable *) function.
|
IMPORT_C static void AddWindowShadow(CCoeControl *aWinArea);
Adds a window shadow of the standard height to a control.
|
IMPORT_C RAnimDll& ClockDllL();
Gets the animated DLL that is used to animate the toolbar clock of the application using this CEikonEnv.
|
IMPORT_C CParaFormatLayer* SystemSingleLineParaFormatLayerL();
Gets the single line paragraph format layer if it exists.
If one does not exist, it calls CEikonEnv::NewDefaultSingleLineParaFormatLayerL() to create a new one.
|
IMPORT_C CParaFormatLayer* SystemParaFormatLayerL();
Gets the paragraph format layer if it exists.
If it does not exist, it calls CEikonEnv::NewDefaultParaFormatLayerL() to create a new one.
|
IMPORT_C CCharFormatLayer* SystemCharFormatLayerL();
Gets the character format layer, if it exists.
If it does not exist, it calls CEikonEnv::NewDefaultCharFormatLayerL() to create a new one.
|
IMPORT_C static CParaFormatLayer* NewDefaultSingleLineParaFormatLayerL();
Creates a default paragraph format layer suitable for a single line of text.
It has an inter line spacing of zero.
|
IMPORT_C static CParaFormatLayer* NewDefaultParaFormatLayerL();
Creates a default paragraph format layer suitable for multiple lines of text.
It uses the default inter line spacing, which is UI specific.
|
IMPORT_C static CCharFormatLayer* NewDefaultCharFormatLayerL();
Creates a default character format layer.
|
IMPORT_C void AddDialogLikeControlToStackL(CCoeControl *aControl);
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.
|
IMPORT_C void AddAlertDialogLikeControlToStackL(CCoeControl *aControl);
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.
|
IMPORT_C void RemoveFromStack(CCoeControl *aControl);
Removes a control from the control stack.
|
IMPORT_C void AddSleepingDialogToStackL(CCoeControl *aControl);
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.
|
IMPORT_C void AddSleepingAlertDialogToStackL(CCoeControl *aControl);
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.
|
IMPORT_C void RouseSleepingDialog(CCoeControl *aControl, TBool aRoused);
Sets a sleeping dialog's state.
|
IMPORT_C void DrawCursor(const CCoeControl *aControl, const TPoint &aPosition, TInt aWidth);
Calls the other overload of CEikonEnv::DrawCursor(const CCoeControl *,const TPoint &,TInt) using the environment's standard screen font for the cursor's ascent and height.
|
IMPORT_C void DrawCursor(const CCoeControl *aControl, const TPoint &aPosition, TInt aWidth, TInt aAscent, TInt aHeight);
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.
|
IMPORT_C void HideCursor(const CCoeControl *aControl);
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.
|
IMPORT_C TEikVirtualCursor& VirtualCursor();
Gets the virtual cursor.
|
IMPORT_C void BringForwards(TBool aForwards, TInt aPriority=ECoeWinPriorityAlwaysAtFront);
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.
|
IMPORT_C void SetAutoForwarding(TBool aAutoBringToForeground);
Use this method to set whether the application's window group shall be automatically brought to the foreground when the user taps on it.
|
IMPORT_C CPrintSetup* NewDefaultPrintSetupL();
Creates and returns a pointer to a new default printer setup object.
|
IMPORT_C static void GetPrinterNamesL(CPrinterModelList *aModelNameList, CDesCArray &aPrinterNameList);
Gets the printer names from a CPrinterModelList.
The printer names are returned through aPrinterNameList.
|
IMPORT_C void SetBusy(TBool aBusy);
Sets the application's busy state.
|
IMPORT_C TBool IsBusy() const;
Tests whether the application is marked as busy.
|
IMPORT_C void SetSystem(TBool aSystem);
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.
|
IMPORT_C TBool IsSystem() const;
Tests the value of the system attribute.
|
IMPORT_C void SetDocNameIsAFile(TBool aDocNameIsAFile);
Sets whether a document name is a file.
|
IMPORT_C TBool DocNameIsAFile() const;
Tests whether the document name is a file.
|
IMPORT_C void SetRespondsToShutdownEvent(TBool aRespondsToShutdownEvent);
Sets whether the application responds to shutdown events.
|
IMPORT_C TBool RespondsToShutdownEvent() const;
Tests whether the application responds to shutdown events.
|
IMPORT_C void SetRespondsToSwitchFilesEvent(TBool aRespondsToSwitchFilesEvent);
Sets whether the application responds to switch files events.
|
IMPORT_C TBool RespondsToSwitchFilesEvent() const;
Tests whether an application responds to switch files events.
|
inline CColorList& ColorList() const;
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.
|
inline TRgb Color(TLogicalColor aLogicalColor) const;
Gets the physical (TRgb) colour which corresponds to a logical colour.
|
|
inline void SetColor(TLogicalColor aLogicalColor, TRgb aColor);
Sets a mapping in the application's colour list between the logical and physical colours specified.
|
IMPORT_C TRgb ControlColor(TLogicalColor aLogicalColor, const CCoeControl &aControl) const;
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(TInt,TRgb), this function will return the overridden colour.
|
|
inline CColorArray& CustomColorArray() const;
Gets the custom colour array.
|
IMPORT_C CColorList* CreateSystemColorListL();
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).
|
IMPORT_C CColorList* CreateSystemColorListL(const CColorList &aColorList);
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(TUid,CColorArray *) should be called before this function.
|
|
| Capability: | WriteDeviceData | To protect against tampering. |
IMPORT_C void UpdateSystemColorListL(const CColorList &aColorList);
Replaces the system colour list with the list specified.
If no system colour list exists, one is created.
|
IMPORT_C CColorList* PopulateColorArrayL();
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.
|
inline TInt AddLibraryL(TCreateByTypeFunction aControlFactory);
|
|
inline TInt AddLibraryL(TFileName *aResourceFile);
|
|
inline void RemoveLibrary(TCreateByTypeFunction aControlFactory);
|
inline void RemoveLibrary(TInt aResourceFileOffset);
|
inline TChar NudgeCharMinus() const;
Gets the minus nudge character, this could be the left arrow for example.
|
inline TChar NudgeCharPlus() const;
Gets the plus nudge character, this could be the right arrow for example.
|
IMPORT_C TDisplayMode DefaultDisplayMode() const;
Gets the default display mode for the window server session with the maximum possible number of colours.
|
IMPORT_C MEikAppUiFactory* AppUiFactory() const;
Gets the application UI factory object.
This object implements the MEikAppUiFactory interface.
|
IMPORT_C MEikAppUiFactory* AppUiFactory(const CEikAppUi &aAppUi) const;
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.
|
|
IMPORT_C virtual void HandleError(TInt aError);
Handles an error that has occurred in the application.
It first offers the error to the app UI's CEikonEnv::HandleError(TInt) 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.
|
private: IMPORT_C virtual void InitSystemFontsL();
Framework function. Creates array of system fonts.
private: IMPORT_C virtual TInt ResourceFileVersionNumber() const;
Framework function
|
IMPORT_C MEikInfoDialog* QueryDialog() const;
Gets the query dialog for this environment.
|
IMPORT_C MEikInfoDialog* InfoDialog() const;
Gets the info dialog for this environment.
|
IMPORT_C CEikAppServer* AppServer() const;
Gets required application server for running the application.
|
IMPORT_C TBool StartedAsServerApp() const;
Gets whether server is required or not.
|
|
|
|
Copyright © 2005-2009 Symbian Software Ltd. |
|
![[Previous]](../../../../a_stock/images/btn_prev.gif)
![[Top]](../../../../a_stock/images/btn_top.gif)
![[Next]](../../../../a_stock/images/btn_next.gif)