uiservicetab/vimpststorage/tsrc/vimpststorage_ut/stubs/CVPbkContactFieldTextData_stub.h
branchRCL_3
changeset 28 3104fc151679
parent 27 2b7283837edb
child 29 9a48e301e94b
equal deleted inserted replaced
27:2b7283837edb 28:3104fc151679
     1 /*
       
     2 * Copyright (c) 2002-2007 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  
       
    15 :                
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef CVPBKCONTACTFIELDTEXTDATASTUB_H
       
    22 #define CVPBKCONTACTFIELDTEXTDATASTUB_H
       
    23 
       
    24 
       
    25 // INCLUDES
       
    26 #include <MVPbkContactFieldTextData.h>
       
    27 
       
    28 // CLASS DECLARATIONS
       
    29 
       
    30 /**
       
    31  * Virtual Phonebook Contact field text data.
       
    32  * This interface is used to manipulate text contact field data.
       
    33  */
       
    34 class CVPbkContactFieldTextData_stub : public MVPbkContactFieldTextData
       
    35     {
       
    36     public:  // Destructor
       
    37         /**
       
    38          * Destructor.
       
    39          */
       
    40         ~CVPbkContactFieldTextData_stub();
       
    41         CVPbkContactFieldTextData_stub();
       
    42 
       
    43 
       
    44     public:  // Interface
       
    45         
       
    46         /**
       
    47          * Returns the string data.
       
    48          * @return Pointer to the text data.
       
    49          */
       
    50         TPtrC Text() const;
       
    51 
       
    52         /**
       
    53          * Sets the string data.
       
    54          * @exception KErrOverflow if (aText.Length() > MaxLength())
       
    55          */
       
    56         void SetTextL( const TDesC& aText ) ;
       
    57 
       
    58         /**
       
    59          * Returns maximum length of the field.
       
    60          * @return Maximum length of the field or KVPbkUnlimitedFieldLength 
       
    61          *         if length is only limited by available memory.
       
    62          */
       
    63         TInt MaxLength() const ;
       
    64 
       
    65         
       
    66         /**
       
    67          * Returns the derived data type id.
       
    68          * @return Contact field storage type.
       
    69          */
       
    70         TVPbkFieldStorageType DataType() const;
       
    71 
       
    72         /**
       
    73          * Returns true if the storage is empty.
       
    74          * @return ETrue if the data field is empty.
       
    75          */
       
    76         TBool IsEmpty() const;
       
    77 
       
    78         /**
       
    79          * Copies data from given field data.
       
    80          * @param aFieldData    Data that is copied to this object.
       
    81          * @precond aFieldData.DataType() == this->DataType()
       
    82          */
       
    83         void CopyL(const MVPbkContactFieldData& aFieldData) ;
       
    84     };
       
    85 
       
    86 #endif  // CVPBKCONTACTFIELDTEXTDATASTUB_H
       
    87 
       
    88 // End of File