epoc32/include/mw/tldlistdef.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
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@4
     1
// Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     2
// All rights reserved.
williamr@4
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@4
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     7
//
williamr@4
     8
// Initial Contributors:
williamr@4
     9
// Nokia Corporation - initial contribution.
williamr@4
    10
//
williamr@4
    11
// Contributors:
williamr@4
    12
//
williamr@4
    13
// Description:
williamr@4
    14
williamr@4
    15
williamr@4
    16
/** @file
williamr@4
    17
@publishedAll
williamr@4
    18
@released
williamr@4
    19
*/
williamr@4
    20
williamr@4
    21
#ifndef __TLDLISTDEF_H__
williamr@4
    22
#define __TLDLISTDEF_H__
williamr@4
    23
williamr@4
    24
#include <e32base.h>
williamr@4
    25
#include <ineturilistdef.h>
williamr@4
    26
williamr@4
    27
using namespace InetUriList;
williamr@4
    28
williamr@4
    29
#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
    30
williamr@4
    31
class TBase
williamr@4
    32
	{
williamr@4
    33
  friend class TPolicyQueryArgs;
williamr@4
    34
  friend class TQueryResults;
williamr@4
    35
williamr@4
    36
public:			
williamr@4
    37
	/**
williamr@4
    38
	Default constructor
williamr@4
    39
	*/
williamr@4
    40
	inline TBase ()
williamr@4
    41
		:iFlags ( 0 )
williamr@4
    42
		{}
williamr@4
    43
williamr@4
    44
private:
williamr@4
    45
	 /**
williamr@4
    46
	 Bit width of the type.	
williamr@4
    47
	 */
williamr@4
    48
	 enum 
williamr@4
    49
		{
williamr@4
    50
	    KBitsPerType = 3			
williamr@4
    51
		};
williamr@4
    52
		
williamr@4
    53
	 /**
williamr@4
    54
	 Maximum number of arguments. Currently set as 4.	
williamr@4
    55
	 */
williamr@4
    56
	 enum
williamr@4
    57
		{
williamr@4
    58
	    KMaxArguments = 4
williamr@4
    59
		};
williamr@4
    60
williamr@4
    61
protected:	
williamr@4
    62
	TInt iArgs [KMaxArguments];
williamr@4
    63
	TInt iFlags;
williamr@4
    64
	};
williamr@4
    65
williamr@4
    66
//-----------------------------------------------------------------
williamr@4
    67
class TPolicyQueryArgs:public TBase
williamr@4
    68
	{
williamr@4
    69
	public:
williamr@4
    70
		/**
williamr@4
    71
		The argument types.		
williamr@4
    72
		*/
williamr@4
    73
		enum TPolicyArgType
williamr@4
    74
			{
williamr@4
    75
			ETldUri = 1,
williamr@4
    76
			ETldListType,
williamr@4
    77
			ETldQueryType
williamr@4
    78
			};
williamr@4
    79
williamr@4
    80
		/**
williamr@4
    81
		Default constructor
williamr@4
    82
		*/
williamr@4
    83
		inline TPolicyQueryArgs ()
williamr@4
    84
			:TBase()
williamr@4
    85
			{}
williamr@4
    86
williamr@4
    87
		/**
williamr@4
    88
		A templated constructor that constructs the query argument.
williamr@4
    89
		It takes one argument.
williamr@4
    90
		*/
williamr@4
    91
		template < class T0 >
williamr@4
    92
		explicit inline TPolicyQueryArgs ( T0 a0 )
williamr@4
    93
			{
williamr@4
    94
			Assign ( a0 );
williamr@4
    95
			iFlags=(Type(a0)<<(( Type(a0))*KBitsPerType));
williamr@4
    96
			}
williamr@4
    97
williamr@4
    98
		/**
williamr@4
    99
		A templated constructor that constructs the query argument.
williamr@4
   100
		It takes two arguments.
williamr@4
   101
		*/
williamr@4
   102
		template < class T0, class T1 >
williamr@4
   103
		inline TPolicyQueryArgs ( T0 a0, T1 a1 )
williamr@4
   104
			{
williamr@4
   105
			Assign ( a0 );
williamr@4
   106
			Assign ( a1 );
williamr@4
   107
			iFlags=(Type(a0)<<(( Type(a0))*KBitsPerType)) |
williamr@4
   108
					(Type(a1)<<(( Type(a1))*KBitsPerType));
williamr@4
   109
			}
williamr@4
   110
williamr@4
   111
		/**
williamr@4
   112
		A templated constructor that constructs the query argument.
williamr@4
   113
		It takes three arguments.
williamr@4
   114
		*/
williamr@4
   115
		template < class T0, class T1, class T2 >
williamr@4
   116
		inline TPolicyQueryArgs ( T0 a0, T1 a1, T2 a2 )
williamr@4
   117
			{
williamr@4
   118
			Assign ( a0 );
williamr@4
   119
			Assign ( a1 );
williamr@4
   120
			Assign ( a2 );
williamr@4
   121
			iFlags=(Type(a0)<<(Type(a0)*KBitsPerType)) | 
williamr@4
   122
					(Type(a1)<<(Type(a1)*KBitsPerType)) |
williamr@4
   123
					(Type(a2)<<(Type(a2)*KBitsPerType));
williamr@4
   124
			}
williamr@4
   125
		/**
williamr@4
   126
		Returns the argument if set, otherwise returns KErrNotFound.	
williamr@4
   127
		*/		
williamr@4
   128
		TInt Get ( TPolicyArgType aType ) const
williamr@4
   129
			{
williamr@4
   130
			if ( IsSet ( aType ) )
williamr@4
   131
				return iArgs[aType - 1];
williamr@4
   132
			return KErrNotFound;			
williamr@4
   133
			}
williamr@4
   134
						
williamr@4
   135
	private:	   
williamr@4
   136
		/**
williamr@4
   137
		Checks whether the flag is set for the given argument type.		
williamr@4
   138
		*/
williamr@4
   139
		TBool IsSet ( TPolicyArgType aType ) const
williamr@4
   140
			{
williamr@4
   141
			TInt val = iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   142
			return iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   143
			}		
williamr@4
   144
		
williamr@4
   145
		TPolicyArgType Type ( const TDesC8* )
williamr@4
   146
			{
williamr@4
   147
			return ETldUri;				
williamr@4
   148
			}
williamr@4
   149
			
williamr@4
   150
		TPolicyArgType Type ( InetUriList::TListType )
williamr@4
   151
			{
williamr@4
   152
			return ETldListType;				
williamr@4
   153
			}
williamr@4
   154
williamr@4
   155
		TPolicyArgType Type ( InetUriList::TTLDQueryType )
williamr@4
   156
			{
williamr@4
   157
			return ETldQueryType;				
williamr@4
   158
			}
williamr@4
   159
		
williamr@4
   160
		void Assign ( const TDesC8* aValue )
williamr@4
   161
			{
williamr@4
   162
			iArgs[Type(aValue)-1] = (TInt)aValue;
williamr@4
   163
			}
williamr@4
   164
			
williamr@4
   165
		void Assign ( InetUriList::TListType aValue )
williamr@4
   166
			{
williamr@4
   167
			iArgs[Type(aValue)-1] = aValue;
williamr@4
   168
			}
williamr@4
   169
			
williamr@4
   170
		void Assign ( InetUriList::TTLDQueryType aValue )
williamr@4
   171
			{
williamr@4
   172
			iArgs[Type(aValue)-1] = aValue;
williamr@4
   173
			}
williamr@4
   174
			
williamr@4
   175
	
williamr@4
   176
	};
williamr@4
   177
williamr@4
   178
#else
williamr@4
   179
class TBase
williamr@4
   180
	{
williamr@4
   181
public:	
williamr@4
   182
	/**
williamr@4
   183
	Bit width of the type.
williamr@4
   184
	
williamr@4
   185
	@internalComponent
williamr@4
   186
	*/
williamr@4
   187
	enum 
williamr@4
   188
		{
williamr@4
   189
		KBitsPerType = 3			
williamr@4
   190
		};
williamr@4
   191
	
williamr@4
   192
	/**
williamr@4
   193
	Maximum number of arguments. Currently set as 4.
williamr@4
   194
williamr@4
   195
	@internalComponent
williamr@4
   196
	*/
williamr@4
   197
	enum
williamr@4
   198
		{
williamr@4
   199
		KMaxArguments = 4
williamr@4
   200
		};
williamr@4
   201
	
williamr@4
   202
	/**
williamr@4
   203
	Default constructor
williamr@4
   204
	*/
williamr@4
   205
	inline TBase ()
williamr@4
   206
		:iFlags ( 0 )
williamr@4
   207
		{}
williamr@4
   208
williamr@4
   209
protected:	
williamr@4
   210
	TInt iArgs [KMaxArguments];
williamr@4
   211
	TInt iFlags;
williamr@4
   212
	};
williamr@4
   213
williamr@4
   214
//-----------------------------------------------------------------
williamr@4
   215
class TPolicyQueryArgs:public TBase
williamr@4
   216
	{
williamr@4
   217
	public:
williamr@4
   218
		/**
williamr@4
   219
		The argument types.
williamr@4
   220
		
williamr@4
   221
		@internalComponent
williamr@4
   222
		*/
williamr@4
   223
		enum TPolicyArgType
williamr@4
   224
			{
williamr@4
   225
			ETldUri = 1,
williamr@4
   226
			ETldListType,
williamr@4
   227
			ETldQueryType
williamr@4
   228
			};
williamr@4
   229
williamr@4
   230
		/**
williamr@4
   231
		Default constructor
williamr@4
   232
		*/
williamr@4
   233
		inline TPolicyQueryArgs ()
williamr@4
   234
			:TBase()
williamr@4
   235
			{}
williamr@4
   236
williamr@4
   237
williamr@4
   238
		/**
williamr@4
   239
		A templated constructor that constructs the query argument.
williamr@4
   240
		It takes one argument.
williamr@4
   241
		*/
williamr@4
   242
		template < class T0 >
williamr@4
   243
		explicit inline TPolicyQueryArgs ( T0 a0 )
williamr@4
   244
			{
williamr@4
   245
			Assign ( a0 );
williamr@4
   246
			iFlags=(Type(a0)<<(( Type(a0))*KBitsPerType));
williamr@4
   247
			}
williamr@4
   248
williamr@4
   249
		/**
williamr@4
   250
		A templated constructor that constructs the query argument.
williamr@4
   251
		It takes two arguments.
williamr@4
   252
		*/
williamr@4
   253
		template < class T0, class T1 >
williamr@4
   254
		inline TPolicyQueryArgs ( T0 a0, T1 a1 )
williamr@4
   255
			{
williamr@4
   256
			Assign ( a0 );
williamr@4
   257
			Assign ( a1 );
williamr@4
   258
			iFlags=(Type(a0)<<(( Type(a0))*KBitsPerType)) |
williamr@4
   259
					(Type(a1)<<(( Type(a1))*KBitsPerType));
williamr@4
   260
			}
williamr@4
   261
williamr@4
   262
		/**
williamr@4
   263
		A templated constructor that constructs the query argument.
williamr@4
   264
		It takes three arguments.
williamr@4
   265
		*/
williamr@4
   266
		template < class T0, class T1, class T2 >
williamr@4
   267
		inline TPolicyQueryArgs ( T0 a0, T1 a1, T2 a2 )
williamr@4
   268
			{
williamr@4
   269
			Assign ( a0 );
williamr@4
   270
			Assign ( a1 );
williamr@4
   271
			Assign ( a2 );
williamr@4
   272
			iFlags=(Type(a0)<<(Type(a0)*KBitsPerType)) | 
williamr@4
   273
					(Type(a1)<<(Type(a1)*KBitsPerType)) |
williamr@4
   274
					(Type(a2)<<(Type(a2)*KBitsPerType));
williamr@4
   275
			}
williamr@4
   276
williamr@4
   277
		/**
williamr@4
   278
		Checks whether the flag is set for the given argument type.
williamr@4
   279
				
williamr@4
   280
		@internalComponent
williamr@4
   281
		*/
williamr@4
   282
		TBool IsSet ( TPolicyArgType aType ) const
williamr@4
   283
			{
williamr@4
   284
			TInt val = iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   285
			return iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   286
			}
williamr@4
   287
		
williamr@4
   288
		/**
williamr@4
   289
		Returns the argument if set, otherwise returns KErrNotFound.
williamr@4
   290
		
williamr@4
   291
		@internalComponent
williamr@4
   292
		*/		
williamr@4
   293
		TInt Get ( TPolicyArgType aType ) const
williamr@4
   294
			{
williamr@4
   295
			if ( IsSet ( aType ) )
williamr@4
   296
				return iArgs[aType - 1];
williamr@4
   297
			return KErrNotFound;			
williamr@4
   298
			}
williamr@4
   299
		
williamr@4
   300
				
williamr@4
   301
	private:
williamr@4
   302
williamr@4
   303
		/**
williamr@4
   304
		@internalComponent
williamr@4
   305
		*/			
williamr@4
   306
		TPolicyArgType Type ( const TDesC8* )
williamr@4
   307
			{
williamr@4
   308
			return ETldUri;				
williamr@4
   309
			}
williamr@4
   310
			
williamr@4
   311
		TPolicyArgType Type ( InetUriList::TListType )
williamr@4
   312
			{
williamr@4
   313
			return ETldListType;				
williamr@4
   314
			}
williamr@4
   315
williamr@4
   316
		TPolicyArgType Type ( InetUriList::TTLDQueryType )
williamr@4
   317
			{
williamr@4
   318
			return ETldQueryType;				
williamr@4
   319
			}
williamr@4
   320
		
williamr@4
   321
		void Assign ( const TDesC8* aValue )
williamr@4
   322
			{
williamr@4
   323
			iArgs[Type(aValue)-1] = (TInt)aValue;
williamr@4
   324
			}
williamr@4
   325
			
williamr@4
   326
		void Assign ( InetUriList::TListType aValue )
williamr@4
   327
			{
williamr@4
   328
			iArgs[Type(aValue)-1] = aValue;
williamr@4
   329
			}
williamr@4
   330
			
williamr@4
   331
		void Assign ( InetUriList::TTLDQueryType aValue )
williamr@4
   332
			{
williamr@4
   333
			iArgs[Type(aValue)-1] = aValue;
williamr@4
   334
			}
williamr@4
   335
			
williamr@4
   336
	
williamr@4
   337
	};
williamr@4
   338
williamr@4
   339
williamr@4
   340
#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   341
williamr@4
   342
	
williamr@4
   343
//------------------------------------------------------------------------
williamr@4
   344
class TQueryResults: public TBase
williamr@4
   345
	{
williamr@4
   346
	public:
williamr@4
   347
		/**
williamr@4
   348
		Default constructor
williamr@4
   349
		*/
williamr@4
   350
		inline TQueryResults ()
williamr@4
   351
			:TBase()
williamr@4
   352
			{}
williamr@4
   353
		
williamr@4
   354
		~TQueryResults ()
williamr@4
   355
			{
williamr@4
   356
			if ( IsSet( TQueryResults::ETldCharSet ) )
williamr@4
   357
				{
williamr@4
   358
				//Delete memory on Heap.
williamr@4
   359
				HBufC8* uriBuf = (reinterpret_cast<HBufC8*> ( Get ( TQueryResults::ETldCharSet ) ));
williamr@4
   360
				delete uriBuf;
williamr@4
   361
				}
williamr@4
   362
			}
williamr@4
   363
			
williamr@4
   364
		/**
williamr@4
   365
		returns a pointer to policydata
williamr@4
   366
		*/
williamr@4
   367
		HBufC8* CharsetL()
williamr@4
   368
			{
williamr@4
   369
			__ASSERT_ALWAYS( IsSet(TQueryResults::ETldCharSet), User::Panic( KTldInvalidRequest, KErrPolicyDataNotPresent ));
williamr@4
   370
			const TDesC8& uri = *( reinterpret_cast<TDesC8*> (Get ( TQueryResults::ETldCharSet ) ) );
williamr@4
   371
			return uri.AllocL();
williamr@4
   372
			}
williamr@4
   373
williamr@4
   374
		/**
williamr@4
   375
		returns a list type
williamr@4
   376
		*/
williamr@4
   377
		InetUriList::TListType ListType()
williamr@4
   378
			{
williamr@4
   379
			__ASSERT_ALWAYS( IsSet(TQueryResults::ETldListType), User::Panic( KTldInvalidRequest, KErrPolicyListTypeNotPresent ));
williamr@4
   380
			return (static_cast<InetUriList::TListType> (Get ( TQueryResults::ETldListType ) ));
williamr@4
   381
			}
williamr@4
   382
			
williamr@4
   383
		/**
williamr@4
   384
		A templated constructor that constructs the query argument.
williamr@4
   385
		It takes one argument. --Check this
williamr@4
   386
		*/
williamr@4
   387
		template < class T0 >
williamr@4
   388
		inline void Set ( T0 a0 )
williamr@4
   389
			{
williamr@4
   390
			Assign ( a0 );
williamr@4
   391
			iFlags=(Type(a0)<<(( Type(a0))*KBitsPerType));
williamr@4
   392
			}
williamr@4
   393
williamr@4
   394
	private:
williamr@4
   395
		#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   396
		/**
williamr@4
   397
		The argument types.	
williamr@4
   398
		*/
williamr@4
   399
		#else
williamr@4
   400
		/**
williamr@4
   401
		The argument types.
williamr@4
   402
		
williamr@4
   403
		@internalComponent
williamr@4
   404
		*/
williamr@4
   405
		#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   406
		enum TResultsArgType
williamr@4
   407
			{
williamr@4
   408
			ETldCharSet = 1,
williamr@4
   409
			ETldListType
williamr@4
   410
			};	
williamr@4
   411
		
williamr@4
   412
		#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   413
       /**
williamr@4
   414
		Checks whether the flag is set for the given argument type.		
williamr@4
   415
		*/
williamr@4
   416
		#else
williamr@4
   417
		/**
williamr@4
   418
		Checks whether the flag is set for the given argument type.
williamr@4
   419
				
williamr@4
   420
		@internalComponent
williamr@4
   421
		*/
williamr@4
   422
		#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   423
		TBool IsSet ( TResultsArgType aType ) const
williamr@4
   424
			{
williamr@4
   425
			TInt val = iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   426
			return iFlags & ( aType << ( aType  * KBitsPerType ) );
williamr@4
   427
			}
williamr@4
   428
williamr@4
   429
		#ifdef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   430
		/**
williamr@4
   431
		Returns the argument if set, otherwise returns KErrNotFound.		
williamr@4
   432
		*/	
williamr@4
   433
		#else
williamr@4
   434
		/**
williamr@4
   435
		Returns the argument if set, otherwise returns KErrNotFound.
williamr@4
   436
		
williamr@4
   437
		@internalComponent
williamr@4
   438
		*/		
williamr@4
   439
		#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   440
		TInt Get ( TResultsArgType aType ) const
williamr@4
   441
			{
williamr@4
   442
			if ( IsSet ( aType ) )
williamr@4
   443
				return iArgs[aType - 1];
williamr@4
   444
			return KErrNotFound;			
williamr@4
   445
			}		
williamr@4
   446
	
williamr@4
   447
	private:
williamr@4
   448
		#ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   449
		/**
williamr@4
   450
		@internalComponent
williamr@4
   451
		*/			
williamr@4
   452
		#endif	//SYMBIAN_ENABLE_SPLIT_HEADERS
williamr@4
   453
		
williamr@4
   454
		TResultsArgType Type ( const TDesC8* )
williamr@4
   455
			{
williamr@4
   456
			return ETldCharSet;				
williamr@4
   457
			}
williamr@4
   458
			
williamr@4
   459
		TResultsArgType Type ( InetUriList::TListType )
williamr@4
   460
			{
williamr@4
   461
			return ETldListType;				
williamr@4
   462
			}
williamr@4
   463
williamr@4
   464
		void Assign ( const TDesC8* aValue )
williamr@4
   465
			{
williamr@4
   466
			iArgs[Type(aValue)-1] = (TInt)aValue;
williamr@4
   467
			}
williamr@4
   468
			
williamr@4
   469
		void Assign ( InetUriList::TListType aValue )
williamr@4
   470
			{
williamr@4
   471
			iArgs[Type(aValue)-1] = aValue;
williamr@4
   472
			}
williamr@4
   473
	};
williamr@4
   474
williamr@4
   475
#endif // __TLDLISTDEF_H__
williamr@4
   476