williamr@4: /*
williamr@4: * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: * All rights reserved.
williamr@4: * This component and the accompanying materials are made available
williamr@4: * under the terms of "Eclipse Public License v1.0"
williamr@4: * which accompanies this distribution, and is available
williamr@4: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: *
williamr@4: * Initial Contributors:
williamr@4: * Nokia Corporation - initial contribution.
williamr@4: *
williamr@4: * Contributors:
williamr@4: *
williamr@4: * Description:  Virtual Phonebook interface for text data of the contact field.
williamr@4: *
williamr@4: */
williamr@4: 
williamr@4: 
williamr@4: #ifndef MVPBKCONTACTFIELDTEXTDATA_H
williamr@4: #define MVPBKCONTACTFIELDTEXTDATA_H
williamr@4: 
williamr@4: 
williamr@4: // INCLUDES
williamr@4: #include <mvpbkcontactfielddata.h>
williamr@4: 
williamr@4: // CLASS DECLARATIONS
williamr@4: 
williamr@4: /**
williamr@4:  * Virtual Phonebook Contact field text data.
williamr@4:  * This interface is used to manipulate text contact field data.
williamr@4:  */
williamr@4: class MVPbkContactFieldTextData : public MVPbkContactFieldData
williamr@4:     {
williamr@4:     public:  // Destructor
williamr@4:         /**
williamr@4:          * Destructor.
williamr@4:          */
williamr@4:         virtual ~MVPbkContactFieldTextData() { }
williamr@4: 
williamr@4:     public:  // from MVPbkContactFieldData
williamr@4:         TVPbkFieldStorageType DataType() const
williamr@4:             {
williamr@4:             return EVPbkFieldStorageTypeText;
williamr@4:             }
williamr@4: 
williamr@4:     public:  // Interface
williamr@4:         /**
williamr@4:          * Casts MVPbkContactFieldData to this interface.
williamr@4:          *
williamr@4:          * @precond aFieldData.DataType() == EVPbkFieldStorageTypeText
williamr@4:          *          VPbkError::Panic(VPbkError::EFieldDataTypeMismatch)
williamr@4:          *          is raised if the precondition does not hold.
williamr@4:          * @param aFieldData    Data of the field.
williamr@4:          * @return Casted inteface for the text field data.
williamr@4:          */
williamr@4:         IMPORT_C static MVPbkContactFieldTextData& Cast(
williamr@4:                 MVPbkContactFieldData& aFieldData);
williamr@4: 
williamr@4:         /**
williamr@4:          * Casts const MVPbkContactFieldData to this interface.
williamr@4:          *
williamr@4:          * @precond aFieldData.DataType() == EVPbkFieldStorageTypeText
williamr@4:          *          VPbkError::Panic(VPbkError::EFieldDataTypeMismatch)
williamr@4:          *          is raised if the precondition does not hold.
williamr@4:          * @param aFieldData    Data of the field.
williamr@4:          * @return Casted inteface for the text field data.
williamr@4:          */
williamr@4:         IMPORT_C static const MVPbkContactFieldTextData& Cast(
williamr@4:                 const MVPbkContactFieldData& aFieldData);
williamr@4: 
williamr@4:         /**
williamr@4:          * Returns the string data.
williamr@4:          * @return Pointer to the text data.
williamr@4:          */
williamr@4:         virtual TPtrC Text() const = 0;
williamr@4: 
williamr@4:         /**
williamr@4:          * Sets the string data.
williamr@4:          * @exception KErrOverflow if (aText.Length() > MaxLength())
williamr@4:          */
williamr@4:         virtual void SetTextL( const TDesC& aText ) = 0;
williamr@4: 
williamr@4:         /**
williamr@4:          * Returns maximum length of the field.
williamr@4:          * @return Maximum length of the field or KVPbkUnlimitedFieldLength 
williamr@4:          *         if length is only limited by available memory.
williamr@4:          */
williamr@4:         virtual TInt MaxLength() const = 0;
williamr@4: 
williamr@4:         /**
williamr@4:          * Returns an extension point for this interface or NULL.
williamr@4:          * @param aExtensionUid Uid of extension.
williamr@4:          * @return Extension point or NULL.
williamr@4:          */
williamr@4:         virtual TAny* ContactFieldTextDataExtension(TUid /*aExtensionUid*/) { return NULL; }
williamr@4:     };
williamr@4: 
williamr@4: #endif  // MVPBKCONTACTFIELDTEXTDATA_H
williamr@4: 
williamr@4: // End of File