|
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 --> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"><concept id="GUID-E9F203A6-D9E3-41B7-9FC4-24EDE20C4753" xml:lang="en"><title>Error |
|
10 note</title><prolog><metadata><keywords></keywords></metadata></prolog><conbody> |
|
11 <section id="GUID-650C271B-5D12-43B9-950B-8EF37140CD69"><p>Error |
|
12 notes are a warning to the user. They should only be used when the user has |
|
13 tried to do something that may cause a considerable problem.</p><fig id="GUID-D82577DB-4C11-4EDE-8C29-D8AE0AE8521D"> |
|
14 <title>Error note</title> |
|
15 <image href="GUID-1EB9BF25-DFF4-42CA-926C-D26409A2868E_d0e61050_href.png" scale="33" placement="inline"></image> |
|
16 </fig></section> |
|
17 <section id="GUID-A62B2AD0-BA1F-4112-9B61-25D29D3B1854"><title>Guidelines |
|
18 for using error notes</title> <p>Use an error note when:</p> <ul> |
|
19 <li> <p>The user does something that may cause considerable harm |
|
20 immediately or later. For example, the user gives a wrong PIN code. Repeating |
|
21 this couple of times would block the SIM card.</p> </li> |
|
22 </ul> <p>To keep error notes effective, they should be used very sparingly. |
|
23 In most ordinary error cases, an <xref href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita">information |
|
24 note</xref> should be used instead of an error note. It has a less aggressive |
|
25 sound and graphics.</p> <p>It should also be noted that if the information |
|
26 to be given is such that the user must see and acknowledge it, a confirmation |
|
27 query is a better component to use than a note. Then the user must press a |
|
28 key to dismiss the information, and there is time to read and think about |
|
29 the notification.</p> </section> |
|
30 <section id="GUID-247815E4-E5BD-456A-9AD0-C3B856C5E274"><title>Using |
|
31 error notes in C++ applications</title><p>You can create either a basic error |
|
32 note that is displayed only when your application is in the foreground or |
|
33 a global note that stays displayed even if the application launching the note |
|
34 is not in the foreground. The related APIs are the Notes |
|
35 API (for basic notes) and the Notifiers |
|
36 API (for global notes). </p><p>To use an error note with the default |
|
37 icon, text, sound, and duration, create an instance of the note class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknErrorNote.html" format="application/java-archive"><codeph>CAknErrorNote</codeph></xref>.</p><p>To |
|
38 create a global error 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 Notifiers |
|
39 API. For implementation information, see Using |
|
40 global notes and Using |
|
41 global notes with user interaction.</p><p>For basic notes, you can |
|
42 change the icon or text displayed in the note, use a different kind of sound, |
|
43 or change the note duration using the setter methods 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 |
|
44 global notes, see Enhancing |
|
45 global notes. You can change the graphic, animation, tone, and softkeys |
|
46 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> |
|
47 |
|
48 |
|
49 |
|
50 </conbody><related-links> |
|
51 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
|
52 note</linktext></link> |
|
53 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |
|
54 note</linktext></link> |
|
55 <link href="GUID-ED198434-94C0-4842-8353-B2FA319BA5C7.dita"><linktext>Warning note</linktext> |
|
56 </link> |
|
57 <link href="GUID-11B69814-5B3E-42AE-844E-998A7A08E654.dita"><linktext>Permanent |
|
58 note</linktext></link> |
|
59 <link href="GUID-93EFC9E4-8779-415D-ABEB-2AC9991996DD.dita"><linktext>Wait note</linktext> |
|
60 </link> |
|
61 <link href="GUID-81E33E18-D390-4110-8D85-1FCDA9CC311E.dita"><linktext>Progress |
|
62 note</linktext></link> |
|
63 </related-links></concept> |