epoc32/include/app/MVPbkStreamable.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkStreamable.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,70 @@
     1.4 +/*
     1.5 +* Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:  An interface for objects that can be written into stream.
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKSTREAMABLE_H
    1.23 +#define MVPBKSTREAMABLE_H
    1.24 +
    1.25 +// INCLUDES
    1.26 +#include <e32std.h>
    1.27 +
    1.28 +// FORWARD DECLARATIONS
    1.29 +class RReadStream;
    1.30 +class RWriteStream;
    1.31 +
    1.32 +// CLASS DECLARATIONS
    1.33 +
    1.34 +/**
    1.35 + * An interface for objects that can be written into stream.
    1.36 + */
    1.37 +class MVPbkStreamable
    1.38 +    {
    1.39 +    protected: // destructor
    1.40 +        /**
    1.41 +         * Destructor.
    1.42 +         */
    1.43 +        virtual ~MVPbkStreamable() { }
    1.44 +
    1.45 +    public: // interface
    1.46 +        /**
    1.47 +         * Outputs this objects state to aStream.
    1.48 +         *
    1.49 +         * @param aStream A stream for writing the object state.
    1.50 +         */
    1.51 +        virtual void ExternalizeL( RWriteStream& aStream ) const = 0;
    1.52 +        
    1.53 +        /**
    1.54 +         * Returns the externalized size of the object in bytes.
    1.55 +         *
    1.56 +         * @return The externalized size of the object.
    1.57 +         */
    1.58 +        virtual TInt ExternalizedSize() const = 0;
    1.59 +
    1.60 +        /**
    1.61 +         * Returns an extension point for this interface or NULL.
    1.62 +         *
    1.63 +         * @param aExtensionUid no extensions defined currently.
    1.64 +         * @return An extension point for this interface or NULL.
    1.65 +         */
    1.66 +        virtual TAny* StreamableExtension( TUid /*aExtensionUid*/ ) 
    1.67 +                { return NULL; }
    1.68 +
    1.69 +    };
    1.70 +
    1.71 +#endif // MVPBKSTREAMABLE_H
    1.72 +
    1.73 +//End of file