7 Nokia Corporation - initial contribution. |
7 Nokia Corporation - initial contribution. |
8 Contributors: |
8 Contributors: |
9 --> |
9 --> |
10 <!DOCTYPE concept |
10 <!DOCTYPE concept |
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
11 PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> |
12 <concept id="GUID-385BB488-5C32-58A7-8401-F3F0A0707DD9" xml:lang="en"><title>User |
12 <concept id="GUID-385BB488-5C32-58A7-8401-F3F0A0707DD9" xml:lang="en"><title>User Interface MTM implementation</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 Interface MTM implementation</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
13 <p> <b>Note:</b> This example is designed to work with Techview and |
14 <p> <b>Note:</b> This example is designed to work with Techview and there |
14 there is no guarantee that it will work on other interfaces </p> |
15 is no guarantee that it will work on other interfaces </p> |
15 <section id="GUID-F60E6B58-C75C-4C28-954B-770EE756E397"><title>Example |
16 <section id="GUID-F60E6B58-C75C-4C28-954B-770EE756E397"><title>Example Code</title> <p>Click on the following link to download |
16 Code</title> <p>Click on the following link to download the example:<xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-419758e4-b663-48d3-bf21-d9c4bb00da23.zip" scope="external">.TextMTM.zip</xref> </p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-419758e4-b663-48d3-bf21-d9c4bb00da23.html" scope="peer">browse</xref> to view the example code. </p> <p>The files |
17 the example:<xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/zips/guid-419758e4-b663-48d3-bf21-d9c4bb00da23.zip" scope="external">.TextMTM.zip</xref> </p><p>Click: <xref href="guid-6013a680-57f9-415b-8851-c4fa63356636/guid-419758e4-b663-48d3-bf21-d9c4bb00da23.html" scope="peer">browse</xref> to view the example code. </p> <p>The files reproduced |
17 reproduced here are the main files contained in the examples directory. |
18 here are the main files contained in the examples directory. Some extra files |
18 Some extra files may be needed to run the examples, and these will |
19 may be needed to run the examples, and these will be found in the appropriate |
19 be found in the appropriate examples directory. </p> </section> |
20 examples directory. </p> </section> |
20 <section id="GUID-EC764B46-F419-46B4-B99B-96EA0935277F"><title>Class |
21 <section id="GUID-EC764B46-F419-46B4-B99B-96EA0935277F"><title>Class summary</title><p> <xref href="GUID-A5982338-A057-3870-8832-F503AEAC470A.dita"><apiname>CBaseMtmUi</apiname></xref> <xref href="GUID-A4B1F874-27C0-3BB6-9D29-C35C75A5DB98.dita"><apiname> TMsvId</apiname></xref> <xref href="GUID-AF724192-6580-3DE3-9287-3A005C0AA932.dita"><apiname> CMsvOperation</apiname></xref> <xref href="GUID-ED81FC3E-2BDA-390D-A866-9651DF8CE51D.dita"><apiname> CEikFileSaveAsDialog </apiname></xref> <xref href="GUID-DC21E927-18B3-3BBF-9B67-496F2D158B03.dita"><apiname>CEikDialog</apiname></xref> </p></section> |
21 summary</title><ul> |
22 <section id="GUID-5FB87906-A38C-4BAB-92B3-75FF497E9E24"><title>Description</title> <p>The <filepath>txtu</filepath> project |
22 <li><p><xref href="GUID-A5982338-A057-3870-8832-F503AEAC470A.dita"><apiname>CBaseMtmUi</apiname></xref></p></li> |
23 demonstrates a User Interface MTM. The central class is <codeph>CTextMtmUi</codeph>, |
23 <li><p><xref href="GUID-A4B1F874-27C0-3BB6-9D29-C35C75A5DB98.dita"><apiname>TMsvId</apiname></xref></p></li> |
24 derived from the User Interface MTM base class <codeph>CBaseMtmUi</codeph>. </p> <p>Note |
24 <li><p><xref href="GUID-AF724192-6580-3DE3-9287-3A005C0AA932.dita"><apiname>CMsvOperation</apiname></xref></p></li> |
25 that the <filepath>txtu</filepath> project has dependencies on some GUI components |
25 <li><p><xref href="GUID-ED81FC3E-2BDA-390D-A866-9651DF8CE51D.dita"><apiname>CEikFileSaveAsDialog </apiname></xref></p></li> |
26 that might not be present on all SDKs. </p> <p> <filepath>txtu</filepath> implements |
26 <li><p><xref href="GUID-DC21E927-18B3-3BBF-9B67-496F2D158B03.dita"><apiname>CEikDialog</apiname></xref></p></li> |
27 the following MTM functionality: </p> </section> |
27 </ul></section> |
28 <section id="GUID-8F7FD0AC-86BE-486B-B999-43EC6914A457"><title>Basic functions for messages</title> <p> <codeph>Create()</codeph>: |
28 <section id="GUID-5FB87906-A38C-4BAB-92B3-75FF497E9E24"><title>Description</title> <p>The <filepath>txtu</filepath> project demonstrates a User Interface |
29 this creates a new local message in the <systemoutput>Draft</systemoutput> folder, |
29 MTM. The central class is <codeph>CTextMtmUi</codeph>, derived from |
30 with description field set to "New Text", and then invokes edit. </p> <p> <codeph>Edit()</codeph>: |
30 the User Interface MTM base class <codeph>CBaseMtmUi</codeph>. </p> <p>Note that the <filepath>txtu</filepath> project has dependencies |
31 no UI for editing and viewing text messages is implemented. A simple stub |
31 on some GUI components that might not be present on all SDKs. </p> <p> <filepath>txtu</filepath> implements the following MTM functionality: </p> </section> |
32 is provided that simply appends the text "Edited document" to the message |
32 <section id="GUID-8F7FD0AC-86BE-486B-B999-43EC6914A457"><title>Basic |
33 and puts up an information message. </p> <p>If an edit command is invoked |
33 functions for messages</title> <p> <codeph>Create()</codeph>: this |
34 on a remote message entry (an entry under a Text service entry), the MTM offers |
34 creates a new local message in the <systemoutput>Draft</systemoutput> folder, with description field set to "New Text", and then invokes |
35 to copy it to the local Inbox first. This is performed by class <codeph>CEditRemoteOperation</codeph>. |
35 edit. </p> <p> <codeph>Edit()</codeph>: no UI for editing and viewing |
36 and dialog resource <codeph>r_dialog_refuse_edit_remote_message</codeph>. </p> <p> <codeph>Open()</codeph> and <codeph>View()</codeph>: |
36 text messages is implemented. A simple stub is provided that simply |
37 these functions for a message context simply calls the edit function. </p> <p> <codeph>CopyToL()</codeph>, <codeph>MoveToL()</codeph>, <codeph>CopyFromL()</codeph>, <codeph>MoveFromL()</codeph> and <codeph>DeleteL()</codeph>: simple implementations |
37 appends the text "Edited document" to the message and puts up an information |
38 of these functions are provided that use the <codeph>CMsvEntry</codeph> copy, |
38 message. </p> <p>If an edit command is invoked on a remote message |
39 move and delete functions. These commands are passed to the Message Server, |
39 entry (an entry under a Text service entry), the MTM offers to copy |
40 which then passes them on to the Server-side Text MTM. </p> <p> <codeph>ReplyL()</codeph> and <codeph>ForwardL()</codeph>: |
40 it to the local Inbox first. This is performed by class <codeph>CEditRemoteOperation</codeph>. and dialog resource <codeph>r_dialog_refuse_edit_remote_message</codeph>. </p> <p> <codeph>Open()</codeph> and <codeph>View()</codeph>: these |
41 there is no UI support for message replies and forwarding. </p> </section> |
41 functions for a message context simply calls the edit function. </p> <p> <codeph>CopyToL()</codeph>, <codeph>MoveToL()</codeph>, <codeph>CopyFromL()</codeph>, <codeph>MoveFromL()</codeph> and <codeph>DeleteL()</codeph>: simple implementations of these functions are provided that use |
42 <section id="GUID-F1566C1D-A866-46F1-AE7B-34280C7A6FBB"><title>Basic functions for services</title> <p> <codeph>Create()</codeph> and <codeph>Edit()</codeph>: |
42 the <codeph>CMsvEntry</codeph> copy, move and delete functions. These |
43 when requested to create a new Text service entry, a dialog pops up allowing |
43 commands are passed to the Message Server, which then passes them |
44 the user to specify the folder associated with the service. This is performed |
44 on to the Server-side Text MTM. </p> <p> <codeph>ReplyL()</codeph> and <codeph>ForwardL()</codeph>: there is no UI support for message |
45 by class <codeph>CTextMtmEditServiceDialog</codeph> and resource <codeph>r_dialog_service_settings</codeph>. |
45 replies and forwarding. </p> </section> |
46 The service entry can then be edited later on, to change the folder. </p> <p>After |
46 <section id="GUID-F1566C1D-A866-46F1-AE7B-34280C7A6FBB"><title>Basic |
47 the service entry is created or changed, an automatic refresh will be triggered. </p> </section> |
47 functions for services</title> <p> <codeph>Create()</codeph> and <codeph>Edit()</codeph>: when requested to create a new Text service entry, |
48 <section id="GUID-1084490D-DA56-4F06-BCA2-BD4698CE633E"><title>MTM-specific operations</title> <p>The following MTM-specific |
48 a dialog pops up allowing the user to specify the folder associated |
49 operations are accepted: </p> <ul> |
49 with the service. This is performed by class <codeph>CTextMtmEditServiceDialog</codeph> and resource <codeph>r_dialog_service_settings</codeph>. The service |
50 <li id="GUID-94BF89D8-80D9-53CD-B3C3-40150B16EF6A"><p>Refresh: this command |
50 entry can then be edited later on, to change the folder. </p> <p>After |
51 refreshes the currently highlighted service entry. It calls the MTM-specific |
51 the service entry is created or changed, an automatic refresh will |
52 operations provided by the Client-side MTM to do this. </p> </li> |
52 be triggered. </p> </section> |
53 <li id="GUID-65E9CE09-3968-5CA0-90E4-5421B608080C"><p>Export text to file: |
53 <section id="GUID-1084490D-DA56-4F06-BCA2-BD4698CE633E"><title>MTM-specific |
54 exports the text contained in a text message to a file. This is performed |
54 operations</title> <p>The following MTM-specific operations are accepted: </p> <ul> |
55 by <codeph>DoExportTextFromMessageL()</codeph>. </p> </li> |
55 <li id="GUID-94BF89D8-80D9-53CD-B3C3-40150B16EF6A"><p>Refresh: this |
|
56 command refreshes the currently highlighted service entry. It calls |
|
57 the MTM-specific operations provided by the Client-side MTM to do |
|
58 this. </p> </li> |
|
59 <li id="GUID-65E9CE09-3968-5CA0-90E4-5421B608080C"><p>Export text |
|
60 to file: exports the text contained in a text message to a file. This |
|
61 is performed by <codeph>DoExportTextFromMessageL()</codeph>. </p> </li> |
56 </ul> </section> |
62 </ul> </section> |
57 </conbody></concept> |
63 </conbody></concept> |