Symbian3/SDK/Source/GUID-99AC84AE-C4C0-53AA-8984-51AE84EE7651.dita
changeset 0 89d6a7a84779
equal deleted inserted replaced
-1:000000000000 0:89d6a7a84779
       
     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-99AC84AE-C4C0-53AA-8984-51AE84EE7651" xml:lang="en"><title>Overview</title><prolog><metadata><keywords/></metadata></prolog><conbody>
       
    13 <section><title>Purpose</title><p>The File Converter Framework converts data
       
    14 from one format to another format. For example, HTML files can be converted
       
    15 to Symbian word documents. </p> </section>
       
    16 <section><title>Architecture</title><p>The File Converter Framework
       
    17 architecture provides a framework for ECOM plug-ins, called converters, that
       
    18 can convert data between different formats. When an application requests to
       
    19 convert data from one format to another format, the framework checks the list
       
    20 of available converters. If there is a converter that can do the conversion,
       
    21 then the framework assigns the request to that converter. </p> <p>The following
       
    22 diagram shows the File converter framework architecture. </p> <fig id="GUID-E4ECB2BD-53D8-53F7-B248-2D2EE5888F1E">
       
    23 <image href="GUID-C8938826-52F7-5040-B59C-3C06DAEB6F03_d0e119354_href.jpg" placement="inline"/>
       
    24 </fig> </section>
       
    25 <section><title>API summary</title> <table id="GUID-82B5BE7F-1DE7-5FBA-9770-05D9B8A74E2F">
       
    26 <tgroup cols="2"><colspec colname="col0"/><colspec colname="col1"/>
       
    27 <thead>
       
    28 <row>
       
    29 <entry>API</entry>
       
    30 <entry>Description</entry>
       
    31 </row>
       
    32 </thead>
       
    33 <tbody>
       
    34 <row>
       
    35 <entry><p> <xref href="GUID-D7356C00-8DFE-33D5-937D-59A90CC0412E.dita"><apiname>CCnaConverter</apiname></xref>  </p> </entry>
       
    36 <entry><p>A class that contains the properties of a converter. These are a
       
    37 UID and the data types that the converter supports. </p> </entry>
       
    38 </row>
       
    39 <row>
       
    40 <entry><p> <xref href="GUID-66797353-CD46-36C1-A719-4CF50A75250C.dita"><apiname>CConverterBase</apiname></xref>  </p> </entry>
       
    41 <entry><p>A class that provides an interface to access the converters. </p> </entry>
       
    42 </row>
       
    43 <row>
       
    44 <entry><p> <xref href="GUID-583F9530-59DD-3546-B2F9-94D130A3EDD1.dita"><apiname>CConverterBase2</apiname></xref>  </p> </entry>
       
    45 <entry><p>A base class for converters. </p> </entry>
       
    46 </row>
       
    47 <row>
       
    48 <entry><p> <xref href="GUID-6C51F1E2-7794-3830-9D52-CA98827C0156.dita"><apiname>CCnaConverterList</apiname></xref>  </p> </entry>
       
    49 <entry><p>A class that provides a list of available converters. It allows
       
    50 clients to search for and obtain converters for specific source and target
       
    51 data types. </p> </entry>
       
    52 </row>
       
    53 <row>
       
    54 <entry><p> <xref href="GUID-3C5F0946-1A4F-3ADA-A41A-BC408F9B9414.dita"><apiname>CCnaConvInfoFileReader2</apiname></xref>  </p> </entry>
       
    55 <entry><p>A class that encapsulates a collection of converter properties, <xref href="GUID-D7356C00-8DFE-33D5-937D-59A90CC0412E.dita"><apiname>CCnaConverter</apiname></xref>,
       
    56 read from a converter information <filepath>.rsc</filepath> file. </p> </entry>
       
    57 </row>
       
    58 <row>
       
    59 <entry><p> <xref href="GUID-6AF2AE70-9FA4-3B06-B01F-86DE3581AE10.dita"><apiname>CMimeInfo</apiname></xref>  </p> </entry>
       
    60 <entry><p>A class that contains the localized names for a data type. </p> </entry>
       
    61 </row>
       
    62 <row>
       
    63 <entry><p> <xref href="GUID-AC297E11-FD37-3572-9612-042F68324F6E.dita"><apiname>MConverterUiObserver</apiname></xref>  </p> </entry>
       
    64 <entry><p>An interface implemented by the client of a conversion operation
       
    65 to observe conversion progress. </p> </entry>
       
    66 </row>
       
    67 </tbody>
       
    68 </tgroup>
       
    69 </table> </section>
       
    70 <section><title>Typical uses</title> <p><b>Using a converter</b> </p> <p>File
       
    71 Converter Framework provides APIs to list and search for converters. It also
       
    72 provides an observer interface through which the progress and success or failure
       
    73 of the conversion can be reported. For more information, see <xref href="GUID-C1C0E7DF-6519-5648-AE5E-6D149AF1A89A.dita">Using
       
    74 a converter</xref>. </p> <p><b>Writing a converter</b> </p> <p>File Converter
       
    75 Framework specifies a plug-in interface for converters. For more information,
       
    76 see <xref href="GUID-46121F24-AB53-5B44-A082-EF13A72EB7FF.dita">Writing a Converter</xref>. </p> </section>
       
    77 </conbody><related-links>
       
    78 <link href="GUID-99ACBD00-2F61-5984-BE77-91D5EF547289.dita"><linktext>File Converter
       
    79 Tutorials</linktext></link>
       
    80 </related-links></concept>