12 <concept id="GUID-81E33E18-D390-4110-8D85-1FCDA9CC311E" xml:lang="en"><title>Progress |
12 <concept id="GUID-81E33E18-D390-4110-8D85-1FCDA9CC311E" xml:lang="en"><title>Progress |
13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 note</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
14 <p>Progress notes contain a progress graphic of definite duration. They are |
14 <p>Progress notes contain a progress graphic of definite duration. They are |
15 used during operations that take a long time when it is possible to estimate |
15 used during operations that take a long time when it is possible to estimate |
16 the duration of the operation. Whenever possible, the user should be able |
16 the duration of the operation. Whenever possible, the user should be able |
17 to stop the operation. For this, a softkey labeled e.g. <uicontrol>Cancel</uicontrol> is |
17 to stop the operation. For this, a softkey labeled, example, <uicontrol>Cancel</uicontrol> is |
18 provided.</p> |
18 provided.</p> |
19 <fig id="GUID-12944F1C-48F3-4E80-804B-A585B911F0C8-GENID-1-8-1-6-1-1-5-1-13-1-1-9-1-2-2"> |
19 <fig id="GUID-560F8557-EDD7-48A4-9068-AF8E028A4721"> |
20 <title>Progress note</title> |
20 <title>Progress note</title> |
21 <image href="GUID-3F69590C-B1FB-4E73-B3D3-FD09C894BC60_d0e65436_href.png" scale="33" placement="inline"/> |
21 <image href="GUID-D74C4403-1516-4C8F-B457-98BA0F97718A_d0e59705_href.png" placement="inline"/> |
22 </fig> |
22 </fig> |
23 <section id="GUID-D8E36599-D305-4C3B-AB3D-4BF4CF1A70E7"><title>Using |
23 <section id="GUID-D8E36599-D305-4C3B-AB3D-4BF4CF1A70E7"><title>Using |
24 progress notes in C++ applications</title> <p>You can create either a |
24 progress notes in applications</title> <p>You can create either a basic |
25 basic wait note that is displayed only when your application is in the foreground |
25 wait note that is displayed only when your application is in the foreground |
26 or a global note that stays displayed even if the application launching the |
26 or a global note that stays displayed even if the application launching the |
27 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 |
27 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 |
28 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>Progress notes |
28 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>Progress notes |
29 are predefined notes that cannot be used just by instantiating a simple note |
29 are predefined notes that cannot be used just by instantiating a simple note |
30 class. These notes' lifetime is based on a background process, and client |
30 class. These notes' lifetime is based on a background process, and client |
31 code has to provide an interface to retrieve this information. For implementation |
31 code has to provide an interface to retrieve this information. For implementation |
32 information, see <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.4" scope="peer">Creating a progress note</xref>.</p> <p>To create |
32 information, see <xref format="html" href="specs/guides/Notes_API_Specification/Notes_API_Specification.html#Notes_API_Specification.topic3.4" scope="peer">Creating a progress note</xref>.</p> <p>To create a global progress |
33 a global progress note, use the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknGlobalProgressDialog.html" format="application/java-archive"><codeph>CAknGlobalProgressDialog</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 |
33 note, use the class <xref href="GUID-B73E968B-CDF5-3622-BC1D-CBA2161E75F4.dita"><apiname>CAknGlobalProgressDialog</apiname></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 |
34 notes, you can change the icon or text displayed in the note, use a different |
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 |
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 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, |
36 class <xref href="GUID-267BF374-66FD-3B7F-A56B-2A9689AEA35E.dita"><apiname>CAknNoteDialog</apiname></xref>: <ul> |
37 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> |
37 <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> |
|
38 <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> |
|
39 <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> |
|
40 <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> |
|
41 </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, |
|
42 tone, and softkeys using the methods in the class <xref href="GUID-2FF927BE-12D6-35E9-8466-011C252E5A66.dita"><apiname>CAknGlobalNote</apiname></xref>: <ul> |
|
43 <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> |
|
44 <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> |
|
45 <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> |
|
46 <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> |
|
47 </ul></p> </section> |
38 |
48 |
39 </conbody><related-links> |
49 </conbody><related-links> |
40 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
50 <link href="GUID-875D74D3-5663-42E3-A4B9-294F82FF5486.dita"><linktext>Confirmation |
41 note</linktext></link> |
51 note</linktext></link> |
42 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |
52 <link href="GUID-E449F309-F230-46F9-B777-EF64D0E3191D.dita"><linktext>Information |