|
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-93EFC9E4-8779-415D-ABEB-2AC9991996DD" xml:lang="en"><title>Wait |
|
13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p>Wait notes contain a wait graphic of indefinite duration. They are used |
|
15 during operations that take a long time when it is not possible to estimate |
|
16 the duration of the operation. Whenever possible, the user should be able |
|
17 to stop the operation. For this, a softkey labeled for example,<uicontrol>Cancel</uicontrol> is |
|
18 provided.</p> |
|
19 <fig id="GUID-12944F1C-48F3-4E80-804B-A585B911F0C8-GENID-1-8-1-6-1-1-5-1-13-1-1-8-1-2-2"> |
|
20 <title>Wait note</title> |
|
21 <image href="GUID-3637DBF8-BABF-4F84-9A7D-8FF66A118261_d0e65306_href.png" scale="33" placement="inline"/> |
|
22 </fig> |
|
23 <section id="GUID-C5FFA38F-BBFD-44D7-979A-5B0A46420D17"> |
|
24 <title>Using wait notes in C++ applications</title> <p>You can create |
|
25 either a basic wait note that is displayed only when your application is in |
|
26 the foreground or a global note that stays displayed even if the application |
|
27 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 |
|
28 predefined notes that cannot be used just by instantiating a simple note class. |
|
29 These notes' lifetime is based on a background process, and client code has |
|
30 to provide an interface to retrieve this information. For implementation information, |
|
31 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, |
|
32 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 |
|
33 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 |
|
34 notes, you can change the icon or text displayed in the note, use a different |
|
35 kind of sound, or change the note duration using the setter methods in the |
|
36 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 |
|
37 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, |
|
38 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> |
|
39 |
|
40 </conbody><related-links> |
|
41 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
|
42 note</linktext></link> |
|
43 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |
|
44 note</linktext></link> |
|
45 <link href="GUID-ED198434-94C0-4842-8353-B2FA319BA5C7.dita"><linktext>Warning note</linktext> |
|
46 </link> |
|
47 <link href="GUID-E9F203A6-D9E3-41B7-9FC4-24EDE20C4753.dita"><linktext>Error note</linktext> |
|
48 </link> |
|
49 <link href="GUID-11B69814-5B3E-42AE-844E-998A7A08E654.dita"><linktext>Permanent |
|
50 note</linktext></link> |
|
51 <link href="GUID-81E33E18-D390-4110-8D85-1FCDA9CC311E.dita"><linktext>Progress |
|
52 note</linktext></link> |
|
53 </related-links></concept> |