javauis/amms_akn/module/inc/cammsmodulecontainer.h
branchRCL_3
changeset 14 04becd199f91
equal deleted inserted replaced
13:f5050f1da672 14:04becd199f91
       
     1 /*
       
     2 * Copyright (c) 2005 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:  Container for CAMMSModule objects.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CAMMSMODULECONTAINER_H
       
    20 #define CAMMSMODULECONTAINER_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "cammsmodule.h"
       
    25 
       
    26 // FORWARD DECLARATIONS
       
    27 class CMMAPlayer;
       
    28 
       
    29 // CLASS DECLARATION
       
    30 
       
    31 /**
       
    32 *
       
    33 *  This class is a container for CAMMSModule objects. All modules added to
       
    34 *  this class with CArrayPtrSeg::AppendL method are owned and deleted in the
       
    35 *  destructor.
       
    36 *
       
    37 *
       
    38 *  @since 3.0
       
    39 */
       
    40 NONSHARABLE_CLASS(CAMMSModuleContainer): public CArrayPtrSeg< CAMMSModule >
       
    41 {
       
    42 public:
       
    43     /**
       
    44     * C++ default constructor.
       
    45     */
       
    46     CAMMSModuleContainer();
       
    47 
       
    48     /**
       
    49     * Destructor.
       
    50     */
       
    51     ~CAMMSModuleContainer();
       
    52 
       
    53 public: // New functions
       
    54     /**
       
    55      * Removes player from all modules. Player states are not checked.
       
    56      * @param aPlayer player to remove
       
    57      */
       
    58     void RemovePlayer(CMMAPlayer* aPlayer);
       
    59 
       
    60     /**
       
    61      * Removes module from container. The module itself is not deleted
       
    62      * by this method, so it has to be deleted elsewhere.
       
    63      * Method returns silently if module is not found.
       
    64      * @param aModule Module to remove.
       
    65      */
       
    66     void RemoveModule(CAMMSModule* aModule);
       
    67 
       
    68 };
       
    69 
       
    70 #endif // CAMMSMODULECONTAINER_H
       
    71 
       
    72