phoneengine/PhoneCntFinder/ContactService/inc/tphcntcontactstorestate.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:  Holds state of a contact store.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TPHCNTCONTACTSTORESTATE_H
       
    20 #define TPHCNTCONTACTSTORESTATE_H
       
    21 
       
    22 #include <e32std.h>
       
    23 #include <TVPbkContactStoreUriPtr.h>
       
    24 
       
    25 /**
       
    26  *  Holds contact store state.
       
    27  *
       
    28  *  @lib PhoneCntFinder.lib
       
    29  *  @since S60 v3.2
       
    30  */
       
    31 class TPhCntContactStoreState
       
    32     {
       
    33 public:
       
    34 
       
    35     /**
       
    36      * Constructor.
       
    37      *
       
    38      * @since S60 v3.2
       
    39      * @param aContactStoreUri Uri of the contact store.
       
    40      */
       
    41     TPhCntContactStoreState( TVPbkContactStoreUriPtr aContactStoreUri );
       
    42 
       
    43     /**
       
    44      * Determines if contact store is available.
       
    45      *
       
    46      * @since S60 v3.2
       
    47      * @return Contact store availability
       
    48      */
       
    49     TBool IsAvailable() const;
       
    50     
       
    51     /**
       
    52      * Gives the URI of the contact store.
       
    53      * 
       
    54      * @since S60 v3.2
       
    55      * @return Contact store URI.
       
    56      */
       
    57     const TVPbkContactStoreUriPtr& ContactStoreUri() const;
       
    58     
       
    59     /**
       
    60      * Set availability.
       
    61      *
       
    62      * @since S60 v3.2
       
    63      * @param aAvailable - ETrue, store is available.
       
    64      *                     EFalse, store is unavailable.
       
    65      */
       
    66     void SetAvailability( TBool aIsAvailable );
       
    67     
       
    68 private: // data
       
    69 
       
    70     /**
       
    71      * Uri of the contact store.
       
    72      */
       
    73     TVPbkContactStoreUriPtr iContactStoreUri;
       
    74     
       
    75     /**
       
    76      * Contact store availability.
       
    77      */
       
    78     TBool iIsAvailable;
       
    79 
       
    80     };
       
    81 
       
    82 #endif // TPHCNTCONTACTSTORESTATE_H