epoc32/include/app/MVPbkExpandable.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 expanded to a view
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
williamr@4
    19
#ifndef MVPBKEXPANDABLE_H
williamr@4
    20
#define MVPBKEXPANDABLE_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 MVPbkContactViewBase;
williamr@4
    27
class MVPbkContactViewObserver;
williamr@4
    28
class MVPbkFieldTypeList;
williamr@4
    29
williamr@4
    30
// CLASS DECLARATIONS
williamr@4
    31
williamr@4
    32
/**
williamr@4
    33
 * An interface for objects that can be expanded to a view
williamr@4
    34
 *
williamr@4
    35
 * E.g. a view contact that represents a group can be expanded
williamr@4
    36
 * to the group members view.
williamr@4
    37
 * @see MVPbkViewContact
williamr@4
    38
 */
williamr@4
    39
class MVPbkExpandable
williamr@4
    40
    {
williamr@4
    41
    protected: // destructor
williamr@4
    42
        /**
williamr@4
    43
         * Destructor.
williamr@4
    44
         */
williamr@4
    45
        virtual ~MVPbkExpandable() { }
williamr@4
    46
williamr@4
    47
    public: // interface
williamr@4
    48
        /**
williamr@4
    49
         * Returns an expanded view that is constructed asynchronously.
williamr@4
    50
         *
williamr@4
    51
         * A client must wait the expanded view to become ready before
williamr@4
    52
         * usage.
williamr@4
    53
         *
williamr@4
    54
         * @param aObserver A contact view observer
williamr@4
    55
         * @param aSortOrder A contact view sort order.
williamr@4
    56
         * @return the expanded view.
williamr@4
    57
         * @return The child view.
williamr@4
    58
         */
williamr@4
    59
        virtual MVPbkContactViewBase* ExpandLC(
williamr@4
    60
            MVPbkContactViewObserver& aObserver,
williamr@4
    61
            const MVPbkFieldTypeList& aSortOrder ) const =0;
williamr@4
    62
williamr@4
    63
        /**
williamr@4
    64
         * Returns an extension point for this interface or NULL.
williamr@4
    65
         *
williamr@4
    66
         * @param aExtensionUid no extensions defined currently.
williamr@4
    67
         * @return an extension point for this interface or NULL.
williamr@4
    68
         */
williamr@4
    69
        virtual TAny* ExpandableExtension( TUid /*aExtensionUid*/ ) 
williamr@4
    70
                { return NULL; }
williamr@4
    71
    };
williamr@4
    72
williamr@4
    73
#endif // MVPBKEXPANDABLE_H
williamr@4
    74
williamr@4
    75
//End of file