epoc32/include/app/MVPbkExpandable.h
branchSymbian3
changeset 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/app/MVPbkExpandable.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -0,0 +1,75 @@
     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 expanded to a view
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef MVPBKEXPANDABLE_H
    1.23 +#define MVPBKEXPANDABLE_H
    1.24 +
    1.25 +// INCLUDES
    1.26 +#include <e32std.h>
    1.27 +
    1.28 +// FORWARD DECLARATIONS
    1.29 +class MVPbkContactViewBase;
    1.30 +class MVPbkContactViewObserver;
    1.31 +class MVPbkFieldTypeList;
    1.32 +
    1.33 +// CLASS DECLARATIONS
    1.34 +
    1.35 +/**
    1.36 + * An interface for objects that can be expanded to a view
    1.37 + *
    1.38 + * E.g. a view contact that represents a group can be expanded
    1.39 + * to the group members view.
    1.40 + * @see MVPbkViewContact
    1.41 + */
    1.42 +class MVPbkExpandable
    1.43 +    {
    1.44 +    protected: // destructor
    1.45 +        /**
    1.46 +         * Destructor.
    1.47 +         */
    1.48 +        virtual ~MVPbkExpandable() { }
    1.49 +
    1.50 +    public: // interface
    1.51 +        /**
    1.52 +         * Returns an expanded view that is constructed asynchronously.
    1.53 +         *
    1.54 +         * A client must wait the expanded view to become ready before
    1.55 +         * usage.
    1.56 +         *
    1.57 +         * @param aObserver A contact view observer
    1.58 +         * @param aSortOrder A contact view sort order.
    1.59 +         * @return the expanded view.
    1.60 +         * @return The child view.
    1.61 +         */
    1.62 +        virtual MVPbkContactViewBase* ExpandLC(
    1.63 +            MVPbkContactViewObserver& aObserver,
    1.64 +            const MVPbkFieldTypeList& aSortOrder ) const =0;
    1.65 +
    1.66 +        /**
    1.67 +         * Returns an extension point for this interface or NULL.
    1.68 +         *
    1.69 +         * @param aExtensionUid no extensions defined currently.
    1.70 +         * @return an extension point for this interface or NULL.
    1.71 +         */
    1.72 +        virtual TAny* ExpandableExtension( TUid /*aExtensionUid*/ ) 
    1.73 +                { return NULL; }
    1.74 +    };
    1.75 +
    1.76 +#endif // MVPBKEXPANDABLE_H
    1.77 +
    1.78 +//End of file