epoc32/include/app/MVPbkContactLinkPacking.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     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:  Virtual Phonebook link packing interface for packing 
    15 *                link internals.
    16 *
    17 */
    18 
    19 
    20 #ifndef MVPBKCONTACTLINKPACKING_H
    21 #define MVPBKCONTACTLINKPACKING_H
    22 
    23 // INCLUDES
    24 #include <e32cmn.h>
    25 #include <e32std.h>
    26 
    27 // FORWARD DECLARATIONS
    28 class RWriteStream;
    29 
    30 // CLASS DECLARATIONS
    31 
    32 /**
    33  * An interface Contact link packing.
    34  * This interface can be used to pack a contact link to a stream.
    35  */
    36 class MVPbkContactLinkPacking
    37     {
    38     public: // destructor
    39         /**
    40          * Destructor.
    41          */
    42         virtual ~MVPbkContactLinkPacking() { }
    43 
    44     public: // interface
    45         /**
    46          * Returns the packed size of internals (excluding the store URI) of 
    47          * this link.
    48          * @return Packed size of internals (excluding the store URI) of 
    49          *         this link.
    50          */
    51         virtual TInt InternalPackedSize() const =0;
    52 
    53         /**
    54          * Appends the packed internals (excluding the URI) of this link.
    55          * @param aStream   Stream to append to this link.
    56          */
    57         virtual void PackInternalsL(RWriteStream& aStream) const =0;
    58 
    59         /**
    60          * Returns an extension point for this interface or NULL.
    61          * @param aExtensionUid Uid of extension.
    62          * @return Extension point or NULL.
    63          */
    64         virtual TAny* ContactLinkPackingExtension(
    65                 TUid /*aExtensionUid*/) { return NULL; }
    66 
    67     };
    68 
    69 #endif // MVPBKCONTACTLINKPACKING_H
    70 
    71 // End of File