phoneengine/phonecntfinder2/inc/cphcntpbkcontactid.h
changeset 21 92ab7f8d0eab
equal deleted inserted replaced
4:c84cf270c54f 21:92ab7f8d0eab
       
     1 /*
       
     2 * Copyright (c) 2009 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 #ifndef CPHCNTPBKCONTACTID_H
       
    19 #define CPHCNTPBKCONTACTID_H
       
    20 
       
    21 #include "cphcntcontactid.h"
       
    22 
       
    23 /**
       
    24  *  Contact id used with contact engine.
       
    25  *
       
    26  *  @lib PhoneCntFinder
       
    27  *  @since S60 v3.1
       
    28  */
       
    29 NONSHARABLE_CLASS( CPhCntPbkContactId ): public CPhCntContactId
       
    30     {
       
    31 public:
       
    32 
       
    33     static CPhCntPbkContactId* NewL( TInt aContactId );
       
    34 
       
    35     static CPhCntPbkContactId* NewLC( TInt aContactId );
       
    36 
       
    37     virtual ~CPhCntPbkContactId();
       
    38 
       
    39     /**
       
    40      * Gives the contact id used with contact engine.
       
    41      *
       
    42      * @since S60 v3.1
       
    43      * @return Contact id.
       
    44      */
       
    45     TContactItemId ContactId() const;
       
    46 
       
    47 // from base class CPhCntContactId
       
    48 
       
    49     /**
       
    50      * From CPhCntContactId
       
    51      * Clones contact id.
       
    52      *
       
    53      * @since S60 v3.1
       
    54      * @return New cloned instance of this contact id.
       
    55      */
       
    56     CPhCntContactId* CloneL() const;
       
    57     
       
    58     /**
       
    59      * From CPhCntContactId
       
    60      * Invalidates this contact id.
       
    61      *
       
    62      * @since S60 v3.1
       
    63      */
       
    64     void Invalidate();
       
    65     
       
    66     /**
       
    67      * From CPhCntContactId
       
    68      * Determines if this contact id is valid contact id.
       
    69      *
       
    70      * @since S60 v3.1
       
    71      * @return ETrue if contact id is valid.
       
    72      */
       
    73     TBool IsValid() const;
       
    74     
       
    75     /**
       
    76      * From CPhCntContactId
       
    77      * Returns null.
       
    78      *
       
    79      * @since S60 v3.1
       
    80      * @return null.
       
    81      */
       
    82     HBufC8* PackLC() const;
       
    83     
       
    84 private:
       
    85 
       
    86     CPhCntPbkContactId( TInt aContactId );
       
    87 
       
    88 private: // data
       
    89 
       
    90     /**
       
    91      * Contact identifier.
       
    92      */
       
    93     TInt iContactId;
       
    94 
       
    95     };
       
    96 
       
    97 #endif // CPHCNTPBKCONTACTID_H