CErrorUI Class Reference

#include <mw/ErrorUI.h>

class CErrorUI : public CBase

Inherits from

  • CErrorUI
    Public Member Functions
    ~CErrorUI()
    IMPORT_C CErrorUI *NewL()
    IMPORT_C CErrorUI *NewL(CCoeEnv &)
    IMPORT_C CErrorUI *NewLC()
    IMPORT_C CErrorUI *NewLC(CCoeEnv &)
    IMPORT_C TBoolShowGlobalErrorNoteL(TInt, CTextResolver::TErrorContext)
    IMPORT_C TBoolShowGlobalErrorQueryL(TInt, CTextResolver::TErrorContext)
    CTextResolver &TextResolver()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    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:

    • maps given error to error text to be displayed

    • displays error note using timed, global note

    • does not display error if it is already "on"

    • offers a reference to internal TextResolver instance

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

    Constructor & Destructor Documentation

    ~CErrorUI ( )

    IMPORT_C~CErrorUI()

    Destructor

    Member Function Documentation

    NewL ( )

    IMPORT_C CErrorUI *NewL()[static]

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

    NewL ( CCoeEnv & )

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

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

    ParameterDescription
    aEnvReference to caller's control environment

    NewLC ( )

    IMPORT_C CErrorUI *NewLC()[static]

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

    NewLC ( CCoeEnv & )

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

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

    ParameterDescription
    aEnvReference to caller's control environment

    ShowGlobalErrorNoteL ( TInt, CTextResolver::TErrorContext )

    IMPORT_C TBoolShowGlobalErrorNoteL(TIntaError,
    CTextResolver::TErrorContextaContext = 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.

    ParameterDescription
    aErrorAny error code, for example ETel error or Email error.
    aContextThe 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.

    ShowGlobalErrorQueryL ( TInt, CTextResolver::TErrorContext )

    IMPORT_C TBoolShowGlobalErrorQueryL(TIntaError,
    CTextResolver::TErrorContextaContext = 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.

    ParameterDescription
    aErrorAny error code, for example ETel error or Email error.
    aContextThe 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.

    TextResolver ( )

    CTextResolver &TextResolver()[inline]

    Offers a reference to internal TextResolver instance

    Returns: reference to ErrorUI's internal TextResolver instance

    © Nokia 2011.