epoc32/include/cdbover.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/cdbover.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,132 @@
     1.4 +// Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +
    1.20 +
    1.21 +/**
    1.22 + @file
    1.23 + @deprecated since v9.1. Functionality is replaced with commsdat.
    1.24 +*/
    1.25 +
    1.26 +#ifndef CDBOVER_H
    1.27 +#define CDBOVER_H
    1.28 +
    1.29 +#include <e32base.h>
    1.30 +#include <commdb.h>
    1.31 +#include <cdbpreftable.h>
    1.32 +
    1.33 +class CCommDbOverride;
    1.34 +class CCommDbLongDesOverride;
    1.35 +class TCommDbIapConnectionPrefOverride;
    1.36 +
    1.37 +class CCommDbOverrideSettings : public CBase
    1.38 +/** Repository of override settings for columns in tables.
    1.39 +@deprecated
    1.40 +	Overrides are deprecated from v9.1
    1.41 +
    1.42 +	Holds all information about CommDb overrides.
    1.43 +	Allows the client to store, retrieve and test the existence of overrides.
    1.44 +*/
    1.45 +	{
    1.46 +public:
    1.47 +	/** @deprecated v7.0
    1.48 +
    1.49 +	Override setting flags returned by PartialFull().
    1.50 +	The only use of TParamList is during the comparison of two override sets. */
    1.51 +	enum TParamList
    1.52 +		{
    1.53 +		/** The override settings are partial; the CCommDbOverrideSettings object maintains
    1.54 +		override values for only some of the columns. */
    1.55 +		EParamListPartial,
    1.56 +		/** The override settings are full; the CCommDbOverrideSettings object maintains
    1.57 +		override values for all columns */
    1.58 +		EParamListFull
    1.59 +		};
    1.60 +
    1.61 +	/** The value types that may be stored in as overrides
    1.62 +		@deprecated
    1.63 +			Overrides are deprecated from v9.1
    1.64 +		@internalComponent "Could just use TDbColType" */
    1.65 +	enum TValueType
    1.66 +		{
    1.67 +	/** a TUint32. */
    1.68 +		EIntValue,
    1.69 +	/** a TBool. */
    1.70 +		EBoolValue,
    1.71 +	/** a TDes8. */
    1.72 +		EDes8Value,
    1.73 +	/** a TDes16. */
    1.74 +		EDes16Value,
    1.75 +	/** a TDes. */
    1.76 +		ELongDesValue,
    1.77 +	/** Unkown type. */
    1.78 +		EUnknownType
    1.79 +		};
    1.80 +
    1.81 +public:
    1.82 +	IMPORT_C static CCommDbOverrideSettings* NewL(TParamList aParamList);
    1.83 +	IMPORT_C virtual ~CCommDbOverrideSettings();
    1.84 +
    1.85 +	// Setting override values in the override set
    1.86 +	IMPORT_C TInt SetIntOverride(const TDesC& aTableName, const TDesC& aColumnName, TUint32 aValue);
    1.87 +	IMPORT_C TInt SetBoolOverride(const TDesC& aTableName, const TDesC& aColumnName, TBool aValue);
    1.88 +	IMPORT_C TInt SetDesOverride(const TDesC& aTableName, const TDesC& aColumnName, const TDesC8& aValue);
    1.89 +	IMPORT_C TInt SetDesOverride(const TDesC& aTableName, const TDesC& aColumnName, const TDesC16& aValue);
    1.90 +	IMPORT_C TInt SetLongDesOverride(const TDesC& aTableName, const TDesC& aColumnName, const TDesC& aValue);
    1.91 +
    1.92 +	//  Getting override values from the override set. Returns `KErrNotFound` if the
    1.93 +	//	column has not been overriden.
    1.94 +	IMPORT_C TInt GetIntOverride(const TDesC& aTableName, const TDesC& aColumnName, TUint32& aValue);
    1.95 +	IMPORT_C TInt GetBoolOverride(const TDesC& aTableName, const TDesC& aColumnName, TBool& aValue);
    1.96 +	IMPORT_C TInt GetDesOverride(const TDesC& aTableName, const TDesC& aColumnName, TDes8& aValue);
    1.97 +	IMPORT_C TInt GetDesOverride(const TDesC& aTableName, const TDesC& aColumnName, TDes16& aValue);
    1.98 +	IMPORT_C TInt GetLongDesOverride(const TDesC& aTableName, const TDesC& aColumnName, TDes& aValue);
    1.99 +	IMPORT_C TInt GetLongDesOverrideLength(const TDesC& aTableName, const TDesC& aColumnName, TInt& aLength);
   1.100 +
   1.101 +	IMPORT_C TInt SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref& aPref);
   1.102 +
   1.103 +	IMPORT_C TInt GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIapConnectionPref& aPref);
   1.104 +
   1.105 +	IMPORT_C TBool Compare(CCommDbOverrideSettings* aOverrides) const;
   1.106 +
   1.107 +	IMPORT_C TBool IsOverridden(const TDesC& aTableName, const TDesC& aColumnName, TValueType aType);
   1.108 +
   1.109 +	inline TParamList PartialFull() const;
   1.110 +
   1.111 +	IMPORT_C static CCommDbOverrideSettings* NewL(TParamList aParamList, TCommDbDatabaseType aDbType);
   1.112 +
   1.113 +	IMPORT_C TInt GetConnectionPreferenceOverride(CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref& aPref);		// will be deprecated in 7.0
   1.114 +
   1.115 +	IMPORT_C TInt SetConnectionPreferenceOverride(const CCommsDbConnectionPrefTableView::TCommDbIspConnectionPref& aPref);	// will be deprecated in 7.0
   1.116 +
   1.117 +protected:
   1.118 +	CCommDbOverrideSettings(TParamList aParamList);
   1.119 +	virtual void ConstructL();
   1.120 +	TInt FindOverride(const TDesC& aTableName, const TDesC& aColumnName, TValueType aType) const;
   1.121 +	TBool IllegalOverride(const TDesC& aTableName,  const TDesC& aColumnName) const;
   1.122 +	void CheckL(const TDesC& aTableName, const TDesC& aColumnName, TValueType aType) const;
   1.123 +	static TBool MatchIapOverride(const TCommDbIapConnectionPrefOverride& aFirst,
   1.124 +								  const TCommDbIapConnectionPrefOverride& aSecond);
   1.125 +protected:
   1.126 +	TParamList iPartialFull;
   1.127 +	RPointerArray<CCommDbOverride> iOverrides;
   1.128 +	RArray<TCommDbIapConnectionPrefOverride> iIapOverrides;
   1.129 +	CCommsDatabase* iDb;
   1.130 +
   1.131 +	};
   1.132 +
   1.133 +#include <cdbover.inl>
   1.134 +
   1.135 +#endif