1 /*

     2 * Copyright (c) 2009 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: Tacticon player plugin interface.

    15 * Part of    : Tacticon Server

    16 */

    17 

    18 #ifndef C_TACTICONPLAYER_H

    19 #define C_TACTICONPLAYER_H

    20 

    21 #include <e32base.h>

    22 #include <ecom/ecom.h>

    23 

    24 #include <tacticon.hrh>

    25 

    26 class CRepository;

    27 

    28 /**

    29  *  Tacticon player ECom plugin interface.

    30  *

    31  *  @since S60 5.2

    32  */

    33 class CTacticonPlayer : public CBase

    34     {

    35 public:

    36     /**

    37      * Instantiates an object of this type.

    38      *

    39      * @since S60 5.2

    40      * @param aImplementationUid - Implementation uid of the plugin

    41      *                             to be created.

    42      * @param aRepository        - Reference to Central Repository, which is

    43      *                             used for reading Tacticon settings. 

    44      *                             CR Keys for Tacticons are defined in 

    45      *                             tacticondomaincrkeys.h

    46      *

    47      * @return Instance of tacticon player plugin.

    48      */

    49     IMPORT_C static CTacticonPlayer* NewL( TUid aImplementationUid, 

    50                                            CRepository& aRepository );

    51 

    52     /**

    53      * Destructor.

    54      */

    55     IMPORT_C virtual ~CTacticonPlayer();

    56 

    57     /**

    58      * Returns a list of available implementations for this 

    59      * interface.

    60      *

    61      * @since S60 5.2

    62      * @param aImplInfoArray - Implementation information array of all

    63      *                         available implementations.

    64      */ 

    65     IMPORT_C static void ListImplementationsL( RImplInfoPtrArray& aImplInfoArray );

    66 

    67 public:

    68     /**

    69     * Plays tacticon according to aTacticonType

    70     * @since S60 5.2 

    71     * @param aTacticonType, Tacticon type to be played

    72     */

    73     virtual void PlayTacticon( TTacticonType aTacticonType ) = 0; 

    74     

    75     /**

    76     * Stops playing tacticon

    77     * @since S60 5.2 

    78     */    

    79     virtual void StopTacticon() = 0;

    80 

    81 private:

    82     

    83     // Unique instance identifier key.  

    84     TUid iDtor_ID_Key;

    85         

    86     };

    87     

    88 #endif // C_TACTICONPLAYER_H