epoc32/include/datastor.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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(__DATASTOR_H__)
williamr@2
    17
#define __DATASTOR_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(__S32FILE_H__)
williamr@2
    24
#include <s32file.h>
williamr@2
    25
#endif
williamr@2
    26
#if !defined(__APMSTD_H__)
williamr@2
    27
#include <apmstd.h>
williamr@2
    28
#endif
williamr@2
    29
williamr@2
    30
class RReadStream;
williamr@2
    31
class RWriteStream;
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
@internalComponent
williamr@2
    35
*/
williamr@2
    36
const TUid KUidDatastor = {0x1000071E};
williamr@2
    37
williamr@2
    38
/**
williamr@2
    39
@internalComponent
williamr@2
    40
*/
williamr@2
    41
const TUid KUidDatastorSettings = {0x10000790};
williamr@2
    42
williamr@2
    43
/**
williamr@2
    44
@internalComponent
williamr@2
    45
*/
williamr@2
    46
_LIT(KIniFileName,":\\private\\10003a3f\\Dtstor.ini");
williamr@2
    47
williamr@2
    48
/**
williamr@2
    49
@internalTechnology
williamr@2
    50
@released
williamr@2
    51
*/
williamr@2
    52
class TMappingDataTypeToApp
williamr@2
    53
	{
williamr@2
    54
public:
williamr@2
    55
	IMPORT_C TMappingDataTypeToApp();
williamr@2
    56
	IMPORT_C TMappingDataTypeToApp(const TDataType& aDataType, 
williamr@2
    57
		TDataTypePriority aPriority, TUid aAppUid);
williamr@2
    58
	IMPORT_C TMappingDataTypeToApp(const TDataType& aDataType, 
williamr@2
    59
		TDataTypePriority aPriority, TUid aAppUid, TUid aServiceUid);
williamr@2
    60
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2
    61
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@2
    62
public:
williamr@2
    63
	TDataType iDataType;
williamr@2
    64
	TDataTypePriority iPriority;
williamr@2
    65
	TUid iAppUid; // Uid [2] of the target application
williamr@2
    66
	TUid iServiceUid;
williamr@2
    67
	};
williamr@2
    68
williamr@2
    69
/** A store of mappings between data types, the UIDs of applications that 
williamr@2
    70
can handle them and the priority at which the application handles them.
williamr@2
    71
williamr@2
    72
@internalTechnology
williamr@2
    73
@released
williamr@2
    74
*/					   
williamr@2
    75
class CTypeStoreManager : public CBase
williamr@2
    76
	{
williamr@2
    77
public:
williamr@2
    78
	IMPORT_C static CTypeStoreManager* NewL(RFs& aFs);
williamr@2
    79
	IMPORT_C ~CTypeStoreManager();
williamr@2
    80
	// Persistence
williamr@2
    81
	IMPORT_C void StoreL();
williamr@2
    82
	IMPORT_C void RestoreL();
williamr@2
    83
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2
    84
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@2
    85
	// Enquiry
williamr@2
    86
	IMPORT_C void GetAppByDataType(const TDataType& aDataType, TUid& aUid) const;
williamr@2
    87
	IMPORT_C void GetAppByDataType(const TDataType& aDataType, 
williamr@2
    88
		TUid aServiceUid, TUid& aUid) const;
williamr@2
    89
	IMPORT_C void GetDataTypesByAppL(TUid aUid, CArrayFix<TDataType>* aTypeArray) const;
williamr@2
    90
	IMPORT_C const CArrayFixFlat<TMappingDataTypeToApp>& MappingArray() const;
williamr@2
    91
	// Management
williamr@2
    92
	IMPORT_C void InsertDataMappingL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid);
williamr@2
    93
	IMPORT_C void InsertDataMappingL(const TDataType& aDataType, 
williamr@2
    94
		TDataTypePriority aPriority, TUid aUid, TUid aServiceUid);
williamr@2
    95
	IMPORT_C TBool InsertIfHigherL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid);
williamr@2
    96
	IMPORT_C TBool InsertIfHigherL(const TDataType& aDataType, 
williamr@2
    97
		TDataTypePriority aPriority, TUid aUid, TUid aServiceUid);
williamr@2
    98
	IMPORT_C void DeleteDataMapping(const TDataType& aDataType);
williamr@2
    99
	IMPORT_C void DeleteDataMapping(const TDataType& aDataType, 
williamr@2
   100
		TUid aServiceUid);
williamr@2
   101
	inline TPtrC IniFileName() const;
williamr@2
   102
	IMPORT_C void InsertAndStoreDataMappingL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid, TUid aServiceUid);
williamr@2
   103
	IMPORT_C void InsertAndStoreDataMappingL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid);
williamr@2
   104
	IMPORT_C TBool InsertAndStoreIfHigherL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid);
williamr@2
   105
	IMPORT_C TBool InsertAndStoreIfHigherL(const TDataType& aDataType, TDataTypePriority aPriority, TUid aUid, TUid aServiceUid);
williamr@2
   106
	IMPORT_C void DeleteAndStoreDataMappingL(const TDataType& aDataType);
williamr@2
   107
	IMPORT_C void DeleteAndStoreDataMappingL(const TDataType& aDataType, TUid aServiceUid);
williamr@2
   108
    IMPORT_C TBool DeleteApplicationDataMappings(const TUid aAppUid);
williamr@2
   109
williamr@2
   110
private:
williamr@2
   111
	CDictionaryStore* OpenIniFileLC() const;
williamr@2
   112
	CTypeStoreManager(RFs& aFs);
williamr@2
   113
	TInt FindDataMapping(const TDataType& aDataType, const TUid& aServiceUid) const;
williamr@2
   114
    void ConstructL();	
williamr@2
   115
private:
williamr@2
   116
	CArrayFixFlat<TMappingDataTypeToApp> iAppMappings;
williamr@2
   117
	RFs& iFs;
williamr@2
   118
	RBuf iIniFileName;
williamr@2
   119
	};
williamr@2
   120
williamr@2
   121
inline TPtrC CTypeStoreManager::IniFileName() const
williamr@2
   122
	{
williamr@2
   123
	return iIniFileName;
williamr@2
   124
	}
williamr@2
   125
williamr@2
   126
#endif