1 /*

     2 * Copyright (c) 2006 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:  MPX View container definition.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef MMPXVIEWCONTAINER_H

    21 #define MMPXVIEWCONTAINER_H

    22 

    23 

    24 // INCLUDES

    25 #include <coecntrl.h>

    26 

    27 // FORWARD DECLARATIONS

    28 class CEikMenuPane;

    29 

    30 // CLASS DECLARATION

    31 

    32 /**

    33  *  Abstract class for view container.

    34  *  The view container class owns a common container to access List box

    35  *  commands, receive CoeControl events and GetHelpContext(). The view 

    36  *  container class should implement the following virtual functions:

    37  *

    38  *  virtual void HandleKeyEvent();

    39  *  virtual void HandleHelpContent();

    40  *

    41  *  common container uses this to pass CoeControl events back to the view

    42  *  container class. 

    43  *

    44  *  The view container class should implement the following virtual function

    45  *  from MEikCommandObserver 

    46  *

    47  *  virtual void ProcessCommandL(TInt aCommandId);

    48  *

    49  *  common container uses this to pass commands back to the view class

    50  *  the commands supported are defined in mpxcommoncontainer.hrh

    51  *

    52  *  @since S60 v3.2

    53  */

    54 class MMPXViewContainer

    55     {

    56 public:

    57 

    58     /**

    59      * Destructor.

    60      */

    61     virtual ~MMPXViewContainer() {};

    62 

    63     /**

    64      * Handles key events.

    65      *

    66      * @param aKeyEvent The key event.

    67      * @param aType The type of key event.

    68      */

    69     virtual TKeyResponse HandleKeyEventL(

    70         const TKeyEvent& aKeyEvent,

    71         TEventCode aType ) = 0;

    72     

    73     /**

    74      * Handles the retrieval of the view container's help context.

    75      *

    76      * @param aContext The control's help context.

    77      */

    78     virtual void HandleHelpContext( TCoeHelpContext& aContext ) const = 0;

    79 

    80     /**

    81      * Returns the indicators for the specified item within the view container

    82      *

    83      * @param aIndex specified array index

    84      * @return Indicator icon indices

    85      */

    86     virtual RArray<TInt> IndicatorsL( TInt aIndex ) = 0;

    87     };

    88 

    89 #endif  // MMPXVIEWCONTAINER_H

    90 

    91 // End of File