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.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2004-2007 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:  An interface for objects that can be written into stream.
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
williamr@4
    19
#ifndef MVPBKSTREAMABLE_H
williamr@4
    20
#define MVPBKSTREAMABLE_H
williamr@4
    21
williamr@4
    22
// INCLUDES
williamr@4
    23
#include <e32std.h>
williamr@4
    24
williamr@4
    25
// FORWARD DECLARATIONS
williamr@4
    26
class RReadStream;
williamr@4
    27
class RWriteStream;
williamr@4
    28
williamr@4
    29
// CLASS DECLARATIONS
williamr@4
    30
williamr@4
    31
/**
williamr@4
    32
 * An interface for objects that can be written into stream.
williamr@4
    33
 */
williamr@4
    34
class MVPbkStreamable
williamr@4
    35
    {
williamr@4
    36
    protected: // destructor
williamr@4
    37
        /**
williamr@4
    38
         * Destructor.
williamr@4
    39
         */
williamr@4
    40
        virtual ~MVPbkStreamable() { }
williamr@4
    41
williamr@4
    42
    public: // interface
williamr@4
    43
        /**
williamr@4
    44
         * Outputs this objects state to aStream.
williamr@4
    45
         *
williamr@4
    46
         * @param aStream A stream for writing the object state.
williamr@4
    47
         */
williamr@4
    48
        virtual void ExternalizeL( RWriteStream& aStream ) const = 0;
williamr@4
    49
        
williamr@4
    50
        /**
williamr@4
    51
         * Returns the externalized size of the object in bytes.
williamr@4
    52
         *
williamr@4
    53
         * @return The externalized size of the object.
williamr@4
    54
         */
williamr@4
    55
        virtual TInt ExternalizedSize() const = 0;
williamr@4
    56
williamr@4
    57
        /**
williamr@4
    58
         * Returns an extension point for this interface or NULL.
williamr@4
    59
         *
williamr@4
    60
         * @param aExtensionUid no extensions defined currently.
williamr@4
    61
         * @return An extension point for this interface or NULL.
williamr@4
    62
         */
williamr@4
    63
        virtual TAny* StreamableExtension( TUid /*aExtensionUid*/ ) 
williamr@4
    64
                { return NULL; }
williamr@4
    65
williamr@4
    66
    };
williamr@4
    67
williamr@4
    68
#endif // MVPBKSTREAMABLE_H
williamr@4
    69
williamr@4
    70
//End of file