|
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-385BB488-5C32-58A7-8401-F3F0A0707DD9" xml:lang="en"><title>User |
|
13 Interface MTM implementation</title><prolog><metadata><keywords/></metadata></prolog><conbody> |
|
14 <p> <b>Note:</b> This example is designed to work with Techview and there |
|
15 is no guarantee that it will work on other interfaces </p> |
|
16 <section><title>Example Code</title> <p>Click on the following link to download |
|
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 |
|
18 files reproduced here are the main files contained in the examples directory. |
|
19 Some extra files may be needed to run the examples, and these will be found |
|
20 in the appropriate examples directory. </p> </section> |
|
21 <section><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> |
|
22 <section><title>Description</title> <p>The <filepath>txtu</filepath> project |
|
23 demonstrates a User Interface MTM. The central class is <codeph>CTextMtmUi</codeph>, |
|
24 derived from the User Interface MTM base class <codeph>CBaseMtmUi</codeph>. </p> <p>Note |
|
25 that the <filepath>txtu</filepath> project has dependencies on some GUI components |
|
26 that might not be present on all Symbian OS licensee SDKs. </p> <p> <filepath>txtu</filepath> implements |
|
27 the following MTM functionality: </p> </section> |
|
28 <section><title>Basic functions for messages</title> <p> <codeph>Create()</codeph>: |
|
29 this creates a new local message in the <systemoutput>Draft</systemoutput> folder, |
|
30 with description field set to "New Text", and then invokes edit. </p> <p> <codeph>Edit()</codeph>: |
|
31 no UI for editing and viewing text messages is implemented. A simple stub |
|
32 is provided that simply appends the text "Edited document" to the message |
|
33 and puts up an information message. </p> <p>If an edit command is invoked |
|
34 on a remote message entry (an entry under a Text service entry), the MTM offers |
|
35 to copy it to the local Inbox first. This is performed by class <codeph>CEditRemoteOperation</codeph>. |
|
36 and dialog resource <codeph>r_dialog_refuse_edit_remote_message</codeph>. </p> <p> <codeph>Open()</codeph> and <codeph>View()</codeph>: |
|
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 |
|
38 of these functions are provided that use the <codeph>CMsvEntry</codeph> copy, |
|
39 move and delete functions. These commands are passed to the Message Server, |
|
40 which then passes them on to the Server-side Text MTM. </p> <p> <codeph>ReplyL()</codeph> and <codeph>ForwardL()</codeph>: |
|
41 there is no UI support for message replies and forwarding. </p> </section> |
|
42 <section><title>Basic functions for services</title> <p> <codeph>Create()</codeph> and <codeph>Edit()</codeph>: |
|
43 when requested to create a new Text service entry, a dialog pops up allowing |
|
44 the user to specify the folder associated with the service. This is performed |
|
45 by class <codeph>CTextMtmEditServiceDialog</codeph> and resource <codeph>r_dialog_service_settings</codeph>. |
|
46 The service entry can then be edited later on, to change the folder. </p> <p>After |
|
47 the service entry is created or changed, an automatic refresh will be triggered. </p> </section> |
|
48 <section><title>MTM-specific operations</title> <p>The following MTM-specific |
|
49 operations are accepted: </p> <ul> |
|
50 <li id="GUID-94BF89D8-80D9-53CD-B3C3-40150B16EF6A"><p>Refresh: this command |
|
51 refreshes the currently highlighted service entry. It calls the MTM-specific |
|
52 operations provided by the Client-side MTM to do this. </p> </li> |
|
53 <li id="GUID-65E9CE09-3968-5CA0-90E4-5421B608080C"><p>Export text to file: |
|
54 exports the text contained in a text message to a file. This is performed |
|
55 by <codeph>DoExportTextFromMessageL()</codeph>. </p> </li> |
|
56 </ul> </section> |
|
57 </conbody></concept> |