epoc32/include/app/MVPbkStreamable.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) 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 objects that can be written into stream.
    15 *
    16 */
    17 
    18 
    19 #ifndef MVPBKSTREAMABLE_H
    20 #define MVPBKSTREAMABLE_H
    21 
    22 // INCLUDES
    23 #include <e32std.h>
    24 
    25 // FORWARD DECLARATIONS
    26 class RReadStream;
    27 class RWriteStream;
    28 
    29 // CLASS DECLARATIONS
    30 
    31 /**
    32  * An interface for objects that can be written into stream.
    33  */
    34 class MVPbkStreamable
    35     {
    36     protected: // destructor
    37         /**
    38          * Destructor.
    39          */
    40         virtual ~MVPbkStreamable() { }
    41 
    42     public: // interface
    43         /**
    44          * Outputs this objects state to aStream.
    45          *
    46          * @param aStream A stream for writing the object state.
    47          */
    48         virtual void ExternalizeL( RWriteStream& aStream ) const = 0;
    49         
    50         /**
    51          * Returns the externalized size of the object in bytes.
    52          *
    53          * @return The externalized size of the object.
    54          */
    55         virtual TInt ExternalizedSize() const = 0;
    56 
    57         /**
    58          * Returns an extension point for this interface or NULL.
    59          *
    60          * @param aExtensionUid no extensions defined currently.
    61          * @return An extension point for this interface or NULL.
    62          */
    63         virtual TAny* StreamableExtension( TUid /*aExtensionUid*/ ) 
    64                 { return NULL; }
    65 
    66     };
    67 
    68 #endif // MVPBKSTREAMABLE_H
    69 
    70 //End of file