<?xml version="1.0" encoding="utf-8"?>

<!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. -->

<!-- This component and the accompanying materials are made available under the terms of the License 

"Eclipse Public License v1.0" which accompanies this distribution, 

and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". -->

<!-- Initial Contributors:

    Nokia Corporation - initial contribution.

Contributors: 

-->

<!DOCTYPE concept

  PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">

<concept id="GUID-93EFC9E4-8779-415D-ABEB-2AC9991996DD" xml:lang="en"><title>Wait note</title><prolog><metadata><keywords/></metadata></prolog><conbody>

<p>Wait notes contain a wait graphic of indefinite duration. They are used

during operations that take a long time when it is not possible to estimate

the duration of the operation. Whenever possible, the user should be able

to stop the operation. For this, a softkey labeled for example,<uicontrol>Cancel</uicontrol> is

provided.</p>

<fig id="GUID-1D916CB1-020D-4BD6-A9DD-D22EFDB1ADC3">

<title>Wait note</title>

<image href="GUID-3C61E57D-BBBB-4E52-8C99-F359CB83D1BC_d0e59856_href.png" placement="inline"/>

</fig>

<section id="GUID-C5FFA38F-BBFD-44D7-979A-5B0A46420D17"> 

     <title>Using wait notes in applications</title>     <p>You can create

either a basic wait note that is displayed only when your application is in

the foreground or a global note that stays displayed even if the application

launching the note is not in the foreground. The related APIs are the <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html" scope="peer">Notes API</xref> (for basic notes) and the <xref format="html" href="specs/guides/Notifiers_API_Specification/Notifiers_API_Specification.html" scope="peer">Notifiers API</xref> (for global notes). </p><p>Wait notes are

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. For implementation information,

see <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.3" scope="peer">Creating a wait note</xref>.</p><p>To create a global wait note,

use the <xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita"><apiname>CAknGlobalNote</apiname></xref> class in the <xref format="html" href="specs/guides/Notifiers_API_Specification/Notifiers_API_Specification.html" scope="peer">Notifiers API</xref>. For implementation information, see <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.5" scope="peer">Using global notes</xref> and <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.6" scope="peer">Using global notes with user interaction</xref>.</p><p>For basic

notes, you can change the icon or text displayed in the note, use a different

kind of sound, or change the note duration using the setter methods in the <xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita"><apiname>CAknNoteDialog</apiname></xref> class: <ul>

<li><p><xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita#GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E/GUID-414C2EDC-E2D4-3B36-9436-588A6E7DB674"><apiname>CAknNoteDialog::SetIconL()</apiname></xref></p></li>

<li><p><xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita#GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E/GUID-3D9DDD5D-92CB-3CF9-A8E8-A551FDDD3398"><apiname>CAknNoteDialog::SetTextL()</apiname></xref></p></li>

<li><p><xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita#GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E/GUID-C512B481-10C3-343A-93C0-6661544815C0"><apiname>CAknNoteDialog::SetTone()</apiname></xref></p></li>

<li><p><xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita#GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E/GUID-5C457F5F-71DB-3C45-A175-0AB6EA188186"><apiname>CAknNoteDialog::SetTimeout()</apiname></xref></p></li>

</ul> </p><p>For information on customizing global notes, see <xref format="html" href="specs/guides/Notifiers_API_Specification/Notifiers_API_Specification.html#Notifiers_API_Specification.topic3.4" scope="peer">Enhancing global notes</xref>. You can change the graphic, animation,

tone, and softkeys using the methods in the <xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita"><apiname>CAknGlobalNote</apiname></xref> class: <ul>

<li><p><xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita#GUID-2FF927BE-12D6-35E9-8466-011C252E5A66/GUID-34F19A47-92FD-33B8-9691-4249000C4466"><apiname>CAknGlobalNote::SetGraphic()</apiname></xref></p></li>

<li><p><xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita#GUID-2FF927BE-12D6-35E9-8466-011C252E5A66/GUID-94D9D112-D50F-30F4-BF42-6D2B0096156E"><apiname>CAknGlobalNote::SetAnimation()</apiname></xref></p></li>

<li><p><xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita#GUID-2FF927BE-12D6-35E9-8466-011C252E5A66/GUID-D51CD0FE-5672-30D8-9DF0-39E94489FBB6"><apiname>CAknGlobalNote::SetTone()</apiname></xref></p></li>

<li><p><xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita#GUID-2FF927BE-12D6-35E9-8466-011C252E5A66/GUID-5BCD9086-4432-3D69-8194-D0131A1CD1FC"><apiname>CAknGlobalNote::SetSoftkeys()</apiname></xref></p></li>

</ul></p></section>

</conbody><related-links>

<link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation

note</linktext></link>

<link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information

note</linktext></link>

<link href="GUID-ED198434-94C0-4842-8353-B2FA319BA5C7.dita"><linktext>Warning note</linktext>

</link>

<link href="GUID-E9F203A6-D9E3-41B7-9FC4-24EDE20C4753.dita"><linktext>Error note</linktext>

</link>

<link href="GUID-11B69814-5B3E-42AE-844E-998A7A08E654.dita"><linktext>Permanent

note</linktext></link>

<link href="GUID-81E33E18-D390-4110-8D85-1FCDA9CC311E.dita"><linktext>Progress

note</linktext></link>