CErrorUI Class Reference

API published in: S60 1st Ed

Link against: commonui.lib

Capability Information

Required Capabilities

None

#include <errorui.h>

Detailed Description

Utility class to display error notes by applications.

This is the default error display class to be used by applications. The features of the class are:

Usage (typically as instance variable) iErrorUI = CErrorUI::NewL(); // iCoeEnv can be given as argument, no need to that though ... some code causing an error ... if ( err != KErrNone ) iErrorUI->ShowGlobalErrorNoteL(err);


Public Member Functions
IMPORT_C  ~CErrorUI ()
  Destructor.
IMPORT_C TBool  ShowGlobalErrorNoteL (TInt aError, CTextResolver::TErrorContext aContext=CTextResolver::ECtxAutomatic)
  Shows a global error note which is created by resolving to a display text from the given error code.
CTextResolver &  TextResolver ()
  Offers a reference to internal TextResolver instance.
IMPORT_C TBool  ShowGlobalErrorQueryL (TInt aError, CTextResolver::TErrorContext aContext=CTextResolver::ECtxAutomatic)
  Shows a global error query with OK key, which is created by resolving to a display text from the given error code.

Static Public Member Functions
static IMPORT_C CErrorUI *  NewL ()
  This constructor method should be used by servers, does not put the created object into CleanupStack.
static IMPORT_C CErrorUI *  NewLC ()
  This constructor method should be used by servers, puts the created object into CleanupStack.
static IMPORT_C CErrorUI *  NewL (CCoeEnv &aEnv)
  This constructor method should be used by applications, does not put the created object into CleanupStack.
static IMPORT_C CErrorUI *  NewLC (CCoeEnv &aEnv)
  This constructor method should be used by applications, puts the created object into CleanupStack.

Constructor & Destructor Documentation

IMPORT_C CErrorUI::~CErrorUI (   ) 
 

Destructor.

Member Function Documentation

static IMPORT_C CErrorUI* CErrorUI::NewL (  CCoeEnv &  aEnv  )  [static]
 

This constructor method should be used by applications, does not put the created object into CleanupStack.

Parameters:
aEnv  Reference to caller's control environment
static IMPORT_C CErrorUI* CErrorUI::NewL (   )  [static]
 

This constructor method should be used by servers, does not put the created object into CleanupStack.

static IMPORT_C CErrorUI* CErrorUI::NewLC (  CCoeEnv &  aEnv  )  [static]
 

This constructor method should be used by applications, puts the created object into CleanupStack.

Parameters:
aEnv  Reference to caller's control environment
static IMPORT_C CErrorUI* CErrorUI::NewLC (   )  [static]
 

This constructor method should be used by servers, puts the created object into CleanupStack.

IMPORT_C TBool CErrorUI::ShowGlobalErrorNoteL (  TInt  aError,
CTextResolver::TErrorContext  aContext = CTextResolver::ECtxAutomatic
) 
 

Shows a global error note which is created by resolving to a display text from the given error code.

The is the default method to be called by applications to display error messages.

Parameters:
aError  Any error code, for example ETel error or Email error.
aContext  The context of the error, needed in special cases such as WAP errors, usually (and by default) ECtxAutomatic
Returns:
ETrue if error was displayed, EFalse otherwise.
IMPORT_C TBool CErrorUI::ShowGlobalErrorQueryL (  TInt  aError,
CTextResolver::TErrorContext  aContext = CTextResolver::ECtxAutomatic
) 
 

Shows a global error query with OK key, which is created by resolving to a display text from the given error code.

The is the default method to be called by applications to display error queries.

Parameters:
aError  Any error code, for example ETel error or Email error.
aContext  The context of the error, needed in special cases such as WAP errors, usually (and by default) ECtxAutomatic
Returns:
ETrue if error was displayed, EFalse otherwise.
CTextResolver& CErrorUI::TextResolver (   )  [inline]
 

Offers a reference to internal TextResolver instance.

Returns:
reference to ErrorUI's internal TextResolver instance
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top