author | William Roberts <williamr@symbian.org> |
Tue, 16 Mar 2010 16:12:26 +0000 | |
branch | Symbian2 |
changeset 2 | 2fe1408b6811 |
parent 1 | 666f914201fb |
child 4 | 837f303aceeb |
permissions | -rw-r--r-- |
williamr@2 | 1 |
/* |
williamr@2 | 2 |
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies). |
williamr@2 | 3 |
* All rights reserved. |
williamr@2 | 4 |
* This component and the accompanying materials are made available |
williamr@2 | 5 |
* 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 | 6 |
* which accompanies this distribution, and is available |
williamr@2 | 7 |
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
williamr@2 | 8 |
* |
williamr@2 | 9 |
* Initial Contributors: |
williamr@2 | 10 |
* Nokia Corporation - initial contribution. |
williamr@2 | 11 |
* |
williamr@2 | 12 |
* Contributors: |
williamr@2 | 13 |
* |
williamr@2 | 14 |
* Description: |
williamr@2 | 15 |
* Interface classes for accessing Phonebook contact data. |
williamr@2 | 16 |
* |
williamr@2 | 17 |
*/ |
williamr@2 | 18 |
|
williamr@2 | 19 |
|
williamr@2 | 20 |
#ifndef __MPbkFieldData_H__ |
williamr@2 | 21 |
#define __MPbkFieldData_H__ |
williamr@2 | 22 |
|
williamr@2 | 23 |
// INCLUDES |
williamr@2 | 24 |
#include <cntdef.h> // TStorageType |
williamr@2 | 25 |
#include "PbkFields.hrh" // TPbkFieldId |
williamr@2 | 26 |
|
williamr@2 | 27 |
// FORWARD DECLARATIONS |
williamr@2 | 28 |
class MPbkFieldData; |
williamr@2 | 29 |
|
williamr@2 | 30 |
// CLASS DECLARATION |
williamr@2 | 31 |
|
williamr@2 | 32 |
/** |
williamr@2 | 33 |
* Array of MPbkFieldData objects. |
williamr@2 | 34 |
*/ |
williamr@2 | 35 |
class MPbkFieldDataArray |
williamr@2 | 36 |
{ |
williamr@2 | 37 |
public: // Destructor |
williamr@2 | 38 |
virtual ~MPbkFieldDataArray() {} |
williamr@2 | 39 |
|
williamr@2 | 40 |
public: // Abstract interface |
williamr@2 | 41 |
/** |
williamr@2 | 42 |
* Returns the number of field data objects in this array. |
williamr@2 | 43 |
* @return The number of field data objects in this array. |
williamr@2 | 44 |
*/ |
williamr@2 | 45 |
virtual TInt PbkFieldCount() const = 0; |
williamr@2 | 46 |
|
williamr@2 | 47 |
/** |
williamr@2 | 48 |
* Returns the field data object at aIndex. |
williamr@2 | 49 |
* @param aIndex The field to index. |
williamr@2 | 50 |
* @return The field data object at aIndex. |
williamr@2 | 51 |
*/ |
williamr@2 | 52 |
virtual MPbkFieldData& PbkFieldAt(TInt aIndex) = 0; |
williamr@2 | 53 |
|
williamr@2 | 54 |
/** |
williamr@2 | 55 |
* Returns the const field data object at aIndex. |
williamr@2 | 56 |
* @return The const field data object at aIndex. |
williamr@2 | 57 |
*/ |
williamr@2 | 58 |
virtual const MPbkFieldData& PbkFieldAt(TInt aIndex) const = 0; |
williamr@2 | 59 |
}; |
williamr@2 | 60 |
|
williamr@2 | 61 |
/** |
williamr@2 | 62 |
* Phonebook field data abstract interface. The interface is used as an |
williamr@2 | 63 |
* abstraction to handle phonebook contact item field data access. |
williamr@2 | 64 |
* The Phonebook contact item field abstraction TPbkContactItemField |
williamr@2 | 65 |
* implements this interface. |
williamr@2 | 66 |
*/ |
williamr@2 | 67 |
class MPbkFieldData |
williamr@2 | 68 |
{ |
williamr@2 | 69 |
public: // Destructor |
williamr@2 | 70 |
/** |
williamr@2 | 71 |
* Destructor. |
williamr@2 | 72 |
*/ |
williamr@2 | 73 |
virtual ~MPbkFieldData() {} |
williamr@2 | 74 |
|
williamr@2 | 75 |
public: // Interface |
williamr@2 | 76 |
/** |
williamr@2 | 77 |
* Returns the type of this field data. |
williamr@2 | 78 |
* @return KStrorageTypeText or KStoragetTypeDateTime. |
williamr@2 | 79 |
*/ |
williamr@2 | 80 |
virtual TStorageType PbkFieldType() const = 0; |
williamr@2 | 81 |
|
williamr@2 | 82 |
/** |
williamr@2 | 83 |
* Returns the field id of this field data. |
williamr@2 | 84 |
*/ |
williamr@2 | 85 |
virtual TPbkFieldId PbkFieldId() const = 0; |
williamr@2 | 86 |
|
williamr@2 | 87 |
/** |
williamr@2 | 88 |
* Returns the text value of this field data. |
williamr@2 | 89 |
* @precond PbkFieldType()==KStrorageTypeText. |
williamr@2 | 90 |
*/ |
williamr@2 | 91 |
virtual TPtrC PbkFieldText() const = 0; |
williamr@2 | 92 |
|
williamr@2 | 93 |
/** |
williamr@2 | 94 |
* Returns the Time value of this field data. |
williamr@2 | 95 |
* @precond PbkFieldType()==KStoragetTypeDateTime. |
williamr@2 | 96 |
*/ |
williamr@2 | 97 |
virtual TTime PbkFieldTime() const = 0; |
williamr@2 | 98 |
|
williamr@2 | 99 |
}; |
williamr@2 | 100 |
|
williamr@2 | 101 |
|
williamr@2 | 102 |
#endif // __MPbkFieldData_H__ |
williamr@2 | 103 |
|
williamr@2 | 104 |
// End of File |