Notes API: API description

It is important to inform the user about different states or result of operations. AVKON UI Notes provide method for displaying these short messages on the screen for a couple of seconds. User may dismiss them before the note's time expire. It is also possible to give a choice to the user: cancel a long process (e.g. a file upload), or answering a two-way question (e.g. Yes/No).

To use the basic AVKON UI Notes only an instance should be created from the appropriate note class (defined in avkonwrapper.h). These notes are the followings:

A note can be a modal control: when executed it prevents the application from doing any further processing until the note is dismissed. By default basic notes are non-waitings.

There are also predefined notes that cannot be used just by instantiating a simple note class. These notes' lifetime is based on a background process and client code has to provide an interface to retrieve this information. These notes are:

Global Notes are special notes, they are displayed even if the application launching the note is not in the foreground.

Confirmation note

A confirmation note informs the user about a successfully completed operation. By default it has a short duration and a subtle tone and should be used when the effect of the operation cannot be seen directly.

Figure 1: Confirmation note

Information note

Information note is used when an unexpected situation is encountered during usage of the device. This note has a longer duration and a more noticeable tone than the confirmation note. Information note should be used when an error that can be rectified occurs, for example "Name already exists" when user tries to add a duplicate name to Phonebook.

Figure 2: Information note

Warning note

Warning note is used when the user must be notified about something that may require action. The note is displayed for a fairly long time and the sound can be heard even when the user is not concentrating on the phone – this note is used for example a "Battery low" warning.

Figure 3: Warning note

Error note

Error notes should be used when user does something that may cause considerable harm immediately or later, for example entering a wrong PIN-code would block using the SIM card.

Figure 4: Error note

Wait note

Wait note is used to inform the user about an operation is taking place. However, it does not indicate the length of the operation.

Figure 5: Wait note

Progress note

Progress note is used for operations when the process length can be calculated; so the user might be informed about the time status of the operation.

Figure 6: Progress note

Global note

Global note is used to display an information which is not application specific, e.g. Alarm, Calendar notes or battery notes.

Figure 7: Global note

Use cases

The main use cases of AVKON UI Notes API are:

  1. Using a basic note
  2. Using a non-waiting basic note with self pointer
  3. Using the Wait Note
  4. Using the Progress Note
  5. Using Global Notes
  6. Using custom notes

API class structure

The base class for AVKON UI Notes is CAknNoteDialog. The following diagram shows the basic notes.

Figure 8: AVKON UI Basic Notes classes

Wait Note and Progress Note's design

Figure 9: AVKON UI Progress notes classes


Copyright © Nokia Corporation 2001-2008
Back to top