contacts_plat/virtual_phonebook_engine_api/inc/MVPbkContactViewBaseChildAccessExtension.h
branchRCL_3
changeset 63 f4a778e096c2
child 64 c1e8ba0c2b16
equal deleted inserted replaced
62:5b6f26637ad3 63:f4a778e096c2
       
     1 /*
       
     2 * Copyright (c) 2004-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:  An interface for contact view base extension.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MVPBKCONTACTVIEWBASECHILDACCESSEXT_H
       
    20 #define MVPBKCONTACTVIEWBASECHILDACCESSEXT_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32cmn.h>
       
    24 #include <VPbkContactView.hrh>
       
    25 #include <bamdesca.h>
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 
       
    29 // CLASS DECLARATIONS
       
    30 
       
    31 /// This is the UID that identifies this interface.
       
    32 const TUint KVPbkViewBaseExtChildAccess = 123; // TODO Allocate UID.
       
    33 
       
    34 /**
       
    35  * This is an extension to MVPbkContactViewBase for accessing child views
       
    36  * of a composite.
       
    37  */
       
    38 class MVPbkContactViewBaseChildAccessExtension
       
    39     {
       
    40     public: // types
       
    41 
       
    42     public:  // Destructor
       
    43 
       
    44         /**
       
    45          * Destructor.
       
    46          */
       
    47         virtual ~MVPbkContactViewBaseChildAccessExtension() { }
       
    48 
       
    49     public:  // New functions
       
    50 
       
    51         /**
       
    52          * Tells the number of child views.
       
    53          */
       
    54         virtual TInt ChildViewCount() const = 0;
       
    55 
       
    56         /**
       
    57          * Gives reference to a specific child view.
       
    58          * @param aIndex Index of child view.
       
    59          */
       
    60         virtual MVPbkContactViewBase& ChildViewAt(TInt aIndex) = 0;
       
    61         
       
    62         /**
       
    63          * Gives pointer to a specific child view.
       
    64          * @param aId Id of child view.
       
    65          */
       
    66         virtual MVPbkContactViewBase* GetChildViewById(TInt aId) = 0;
       
    67   
       
    68         /**
       
    69          * Gives a current view id.
       
    70          */
       
    71         virtual TInt GetViewId() = 0;
       
    72         /**
       
    73          * Returns an extension point for this interface or NULL.
       
    74          *
       
    75          * @param aExtensionUid no extensions defined currently.
       
    76          * @return an extension point for this interface or NULL.
       
    77          */
       
    78         virtual TAny* MVPbkContactViewBaseChildAccessExtensionExtension(TUid /*aExtensionUid*/) 
       
    79                 { return NULL; }
       
    80     };
       
    81 
       
    82 
       
    83 #endif // MVPBKCONTACTVIEWBASECHILDACCESSEXT_H
       
    84 
       
    85 // End of File