epoc32/include/mw/conlist.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#if !defined(__CONLIST_H__)
williamr@2
    17
#define __CONLIST_H__
williamr@2
    18
williamr@2
    19
#if !defined(__E32BASE_H__)
williamr@2
    20
#include <e32base.h>
williamr@2
    21
#endif
williamr@2
    22
williamr@2
    23
#if !defined(__F32FILE_H__)
williamr@2
    24
#include <f32file.h>
williamr@2
    25
#endif
williamr@2
    26
williamr@2
    27
#if !defined(__CONARC_H__)
williamr@2
    28
#include <conarc.h>
williamr@2
    29
#endif
williamr@2
    30
williamr@2
    31
#if !defined(__CONCNF_H__)
williamr@2
    32
#include <concnf.h>
williamr@2
    33
#endif
williamr@2
    34
williamr@2
    35
#if !defined(__IMPLEMENTATION_INFORMATION_H__)
williamr@2
    36
#include <ecom/implementationinformation.h>
williamr@2
    37
#endif
williamr@2
    38
#if !defined(__ECOM_H__)
williamr@2
    39
#include <ecom/ecom.h>
williamr@2
    40
#endif
williamr@2
    41
williamr@2
    42
williamr@2
    43
/** Creates a converter dll's factory interface object.
williamr@2
    44
williamr@2
    45
@publishedAll
williamr@2
    46
@deprecated
williamr@2
    47
*/
williamr@2
    48
typedef CConverterLibrary* (*CreateCConverterLibrary)(); 
williamr@2
    49
williamr@2
    50
struct SConverterInfo
williamr@2
    51
/** Describes a converter, as obtained from a converter list (CCnaConverterList).
williamr@2
    52
williamr@2
    53
@publishedAll
williamr@2
    54
@released
williamr@2
    55
@see CCnaConverterList */
williamr@2
    56
	{
williamr@2
    57
	/** Localised name of the data type. */
williamr@2
    58
	TTranslation iTranslation;
williamr@2
    59
	/** Converter UID. */
williamr@2
    60
	TUid iUid;
williamr@2
    61
	/** Position of the converter in the list. */
williamr@2
    62
	TInt iIndex;
williamr@2
    63
	};
williamr@2
    64
williamr@2
    65
class CCnaConverterList : public CBase
williamr@2
    66
/** Provides a list of available converters, allowing clients to search for and 
williamr@2
    67
obtain converters for specific source and target data types. 
williamr@2
    68
williamr@2
    69
@publishedAll
williamr@2
    70
@released */
williamr@2
    71
	{
williamr@2
    72
public:
williamr@2
    73
	IMPORT_C static CCnaConverterList* NewL();
williamr@2
    74
	IMPORT_C static CCnaConverterList* NewLC();
williamr@2
    75
	IMPORT_C void Release();
williamr@2
    76
	IMPORT_C ~CCnaConverterList();
williamr@2
    77
//
williamr@2
    78
	IMPORT_C TInt CountL();
williamr@2
    79
	inline TInt Count();
williamr@2
    80
	IMPORT_C CConverterBase* NewConverterL(TUid aUid);
williamr@2
    81
	IMPORT_C void UpdateL();
williamr@2
    82
	IMPORT_C TUid ConvFromL(const TDataType& aMimeType); // searches for a particular converter
williamr@2
    83
	IMPORT_C TUid ConvToL(const TDataType& aMimeType);
williamr@2
    84
	IMPORT_C TUid ConverterL(const TDataType& aFrom,const TDataType& aTo);
williamr@2
    85
	IMPORT_C void ConvFromListL(const TDataType& aMimeType,CArrayFix<SConverterInfo>* aSConverterInfoArray);
williamr@2
    86
	IMPORT_C void ConvToListL(const TDataType& aMimeType,CArrayFix<SConverterInfo>* aSConverterInfoArray);
williamr@2
    87
	IMPORT_C TInt MimeTypeFrom(TDataType& aDataType,const SConverterInfo& aConverterInfo) const;
williamr@2
    88
	IMPORT_C TInt MimeTypeTo(TDataType& aDataType,const SConverterInfo& aConverterInfo) const;
williamr@2
    89
private:
williamr@2
    90
	CCnaConverterList();
williamr@2
    91
	void ConstructL();
williamr@2
    92
	CConverterBase* LoadConverterL(TUid aImplUid);
williamr@2
    93
private:
williamr@2
    94
	TBool iDoneScan;
williamr@2
    95
	CArrayPtr<CCnaConverter>* iConverters;
williamr@2
    96
	RImplInfoPtrArray iImplementationArray;
williamr@2
    97
	};
williamr@2
    98
williamr@4
    99
#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@2
   100
class ConverterListUtil
williamr@2
   101
/** @internalComponent */
williamr@2
   102
	{
williamr@2
   103
public:
williamr@2
   104
	static CConverterBase* UtilityConverterL(TUid aUid);
williamr@2
   105
	static TInt CountUtilityConverters();
williamr@2
   106
	};
williamr@4
   107
#endif //SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@2
   108
williamr@2
   109
inline TInt CCnaConverterList::Count()
williamr@2
   110
/** @deprecated
williamr@2
   111
williamr@2
   112
Deprecated - Use CCnaConverterList::CountL instead. 
williamr@2
   113
Rescan of the disk to refresh the list of converters could leave. */
williamr@2
   114
	{
williamr@2
   115
	return CountL();
williamr@2
   116
	}
williamr@2
   117
williamr@2
   118
#endif