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