11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
12 <concept id="GUID-E9F203A6-D9E3-41B7-9FC4-24EDE20C4753" xml:lang="en"><title>Error |
12 <concept id="GUID-E9F203A6-D9E3-41B7-9FC4-24EDE20C4753" xml:lang="en"><title>Error |
13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
14 <p>Error notes are a warning to the user. They should only be used when the |
14 <p>Error notes are a warning to the user. They should only be used when the |
15 user has tried to do something that may cause a considerable problem.</p> |
15 user has tried to do something that may cause a considerable problem.</p> |
16 <fig id="GUID-D82577DB-4C11-4EDE-8C29-D8AE0AE8521D"> |
16 <fig id="GUID-2265C3F3-86BA-4520-9C5A-BF522D6E3C9C"> |
17 <title>Error note</title> |
17 <title>Error note</title> |
18 <image href="GUID-1EB9BF25-DFF4-42CA-926C-D26409A2868E_d0e65079_href.png" scale="33" placement="inline"/> |
18 <image href="GUID-DAB7AB0C-8B32-4472-8EDC-AA8A5A01205C_d0e59307_href.png" placement="inline"/> |
19 </fig> |
19 </fig> |
20 <section id="GUID-A62B2AD0-BA1F-4112-9B61-25D29D3B1854"><title>Guidelines |
20 <section id="GUID-A62B2AD0-BA1F-4112-9B61-25D29D3B1854"><title>Guidelines |
21 for using error notes</title> <p>Use an error note when the user does |
21 for using error notes</title> <p>Use an error note when the user does |
22 something that may cause considerable harm immediately or later. For example, |
22 something that may cause considerable harm immediately or later. For example, |
23 the user gives a wrong PIN code. Repeating this couple of times would block |
23 the user gives a wrong PIN code. Repeating this couple of times would block |
28 to be given is such that the user must see and acknowledge it, a confirmation |
28 to be given is such that the user must see and acknowledge it, a confirmation |
29 query is a better component to use than a note. Then the user must press a |
29 query is a better component to use than a note. Then the user must press a |
30 key to dismiss the information, and there is time to read and think about |
30 key to dismiss the information, and there is time to read and think about |
31 the notification.</p> </section> |
31 the notification.</p> </section> |
32 <section id="GUID-247815E4-E5BD-456A-9AD0-C3B856C5E274"><title>Using |
32 <section id="GUID-247815E4-E5BD-456A-9AD0-C3B856C5E274"><title>Using |
33 error notes in C++ applications</title><p>You can create either a basic error |
33 error notes in applications</title><p>You can create either a basic error |
34 note that is displayed only when your application is in the foreground or |
34 note that is displayed only when your application is in the foreground or |
35 a global note that stays displayed even if the application launching the note |
35 a global note that stays displayed even if the application launching the note |
36 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>To use an error |
36 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>To use an error |
37 note with the default icon, text, sound, and duration, create an instance |
37 note with the default icon, text, sound, and duration, create an instance |
38 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 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 <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 |
38 of the note <xref href="GUID-2261A396-8AF8-3914-B78A-993DDE0B58A8.dita"><apiname>CAknErrorNote</apiname></xref> class.</p><p>To create a global |
|
39 error 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 |
39 notes, you can change the icon or text displayed in the note, use a different |
40 notes, you can change the icon or text displayed in the note, use a different |
40 kind of sound, or change the note duration using the setter methods in the |
41 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> |
41 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, |
42 <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> |
42 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> |
43 <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> |
|
44 <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> |
|
45 <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> |
|
46 </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, |
|
47 tone, and softkeys using the methods in the <xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita"><apiname>CAknGlobalNote</apiname></xref> class:<ul> |
|
48 <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> |
|
49 <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> |
|
50 <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> |
|
51 <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> |
|
52 </ul> </p></section> |
43 |
53 |
44 </conbody><related-links> |
54 </conbody><related-links> |
45 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
55 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
46 note</linktext></link> |
56 note</linktext></link> |
47 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |
57 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |