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

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

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

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

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

     6 <!-- Initial Contributors:

     7     Nokia Corporation - initial contribution.

     8 Contributors: 

     9 -->

    10 <!DOCTYPE concept

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

    12 <concept id="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486" xml:lang="en"><title>Confirmation

    13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody>

    14 <p>Confirmation notes inform the user about a successfully completed operation.

    15 They have a short duration and a subtle tone (they should not be used after

    16 every kind of successful action).</p>

    17 <fig id="GUID-E4323AE0-295E-42C0-8B7F-248F43CA33D6">

    18 <title>Confirmation note</title>

    19 <image href="GUID-C4805C18-9BE7-47BA-9E50-D5F9CAAD36B7_d0e64639_href.png" placement="inline"/>

    20 </fig>

    21 <section id="GUID-8204F49B-E601-4CBB-8778-33912E4EF76F"><title>Guidelines

    22 for using confirmation notes</title><p>Use a confirmation note when:</p><ul>

    23 <li>         <p>The effect of the operation cannot be seen directly by some

    24 other means. For example, <uicontrol>Message sent</uicontrol>.</p>       </li>

    25 <li>         <p>There is some relevant information to be communicated by it.

    26 For example, <uicontrol>Last call duration</uicontrol>.</p>       </li>

    27 </ul><p>Confirmation notes should not be used after every completed operation,

    28 as this would easily start to annoy users. Confirmation notes should not be

    29 used when:</p><ul>

    30 <li>         <p>There is already another dialogue in the procedure, for example <uicontrol>Do

    31 you want to remove this message? Y/N</uicontrol>.</p>       </li>

    32 <li>         <p>A progress indication is visible during the procedure.</p> 

    33      </li>

    34 <li>         <p>The user can see the result of the operation when it is performed.

    35 For example, when adding or removing objects in a list.</p>       </li>

    36 <li>         <p>A setting has been changed. The new value of the setting is

    37 visible in the setting item.</p>       </li>

    38 <li>         <p>The operation can be considered minor or so frequent that

    39 a note would be annoying. For example, Copy-Paste actions.</p>       </li>

    40 </ul></section>

    41 <section id="GUID-6EFD99CB-F754-4398-9526-7E51E16013A5"><title>Using

    42 confirmation notes in C++ applications</title><p>You can create either a basic

    43 confirmation note that is displayed only when your application is in the foreground

    44 or a global note that stays displayed even if the application launching the

    45 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

    46 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>To use a confirmation

    47 note with the default icon, text, sound, and duration, create an instance

    48 of the note class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknConfirmationNote.html" format="application/java-archive"><codeph>CAknConfirmationNote</codeph></xref>. For implementation information, see <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.1" scope="peer">Creating a waiting confirmation (basic) note</xref>. </p><p>To

    49 create a global confirmation note, use the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html" format="application/java-archive"><codeph>CAknGlobalNote</codeph></xref> in the <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html" scope="peer">Notes 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

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

    51 different kind of sound, or change the note duration using the setter methods

    52 in the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNoteDialog.html" format="application/java-archive"><codeph>CAknNoteDialog</codeph></xref>: <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNoteDialog.html#bfce8dc1591cae822feca43a093a11a9" format="application/java-archive"><codeph>SetIconL()</codeph></xref>, <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNoteDialog.html#ae7db1ca3d39de28ae4793b4e7cf79cb" format="application/java-archive"><codeph>SetTextL()</codeph></xref>, <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNoteDialog.html#5f887d8738ed0f061a1c9e82cf3a14a5" format="application/java-archive"><codeph>SetTone()</codeph></xref>, and <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknNoteDialog.html#8778e804a7709588a4cd23134f79674c" format="application/java-archive"><codeph>SetTimeout()</codeph></xref>.</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,

    53 tone, and softkeys using the methods in the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html" format="application/java-archive"><codeph>CAknGlobalNote</codeph></xref>: <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html#cee323af0704e07d3f1887a4a13c1639" format="application/java-archive"><codeph>SetGraphic()</codeph></xref>, <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html#d23699273b28a39c0817bc575be767ab" format="application/java-archive"><codeph>SetAnimation()</codeph></xref>, <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html#a8748ee0b3342c24a11b8ed0ea9121bc" format="application/java-archive"><codeph>SetTone()</codeph></xref>, and <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalNote.html#f31895e5838994b1c70300cfd3d7d127" format="application/java-archive"><codeph>SetSoftkeys()</codeph></xref>.</p></section>

    54 

    55 

    56 

    57 </conbody><related-links>

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

    59 note</linktext></link>

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

    61 </link>

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

    63 </link>

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

    65 note</linktext></link>

    66 <link href="GUID-93EFC9E4-8779-415D-ABEB-2AC9991996DD.dita"><linktext>Wait note</linktext>

    67 </link>

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

    69 note</linktext></link>

    70 </related-links></concept>