Location: eikonenvironment.h

Namespace NEikonEnvironment

NEikonEnvironment

Description

Provides useful functions connected with the Eikon environment.

Defined in NEikonEnvironment:
EikAppUi(), EikEnv(), EikDocument(), AddToStackL(), aAddToStackL(), RemoveFromStack(), AppFullName(), ApplicationDriveAndPath(), AddPath(), MessageBox(), FlushWindowServer(), TheRFs(),


Eikon environment


EikAppUi()

static void EikAppUi();

Description

The appui.

Return value

TCEikAppUi&

A reference to the CEikAppUi.


EikEnv()

static CEikonEnv& EikEnv();

Description

The eikon environment.

Return value

CEikonEnv&

A reference to the CEikonEnv.


EikDocument()

static CEikDocument& EikDocument();

Description

The document.

Return value

CEikDocument&

A reference to CEikDocument.


AddToStackL()

static void AddToStackL(CCoeControl& aControl);

Description

Add a control to the control stack.

Parameters

CCoeControl& aControl

The control to add.


AddToStackL()

void AddToStackL(CCoeControl& aControl,TInt aPriority,TInt aStackingFlags)

Description

Add a control to the control stack given a priority and flags.

Parameters

CCoeControl& aControl

The control to add.

TInt aPriority

The priority.

TInt aStackingFlags

The flags.


RemoveFromStack()

void RemoveFromStack(CCoeControl& aControl);

Description

Remove a control from the control stack.

Parameters

CCoeControl& aControl

The control to remove.


AppFullName()

TFileName AppFullName();

Description

The full name of the application.

Return value

TFileName

The name.


ApplicationDriveAndPath()

TFileName ApplicationDriveAndPath();

Description

The drive and path of the application.

Return value

TFileName

The drive and path.


AddPath()

TFileName AddPath(const TDesC& aFileName);

Description

Convert a filename to a filename with the drive and path of the application added.

Parameters

const TDesC& aFileName

The file name to convert.

Return value

TFileName

The drive, path and filename.


MessageBox()

void MessageBox(const TDesC& aMessage);

Description

Display a message box

Parameters

const TDesC& aMessage

The message to display.


FlushWindowServer()

void FlushWindowServer();

Description

Flush the windows server to ensure all changes to the display are reflected on the screen.


TheRFs()

RFs& TheRFs();

Description

The eikon frameworks file server connection.

Return value

RFs&

A reference to the RFs.