radioengine/settings/api/mradioapplicationsettings.h
changeset 23 a2b50a479edf
parent 19 afea38384506
child 24 6df133bd92e1
equal deleted inserted replaced
19:afea38384506 23:a2b50a479edf
     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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef M_RADIOAPPLICATIONSETTINGS_H
       
    19 #define M_RADIOAPPLICATIONSETTINGS_H
       
    20 
       
    21 #include <badesca.h>
       
    22 
       
    23 /**
       
    24  * MRadioApplicationSettings
       
    25  *
       
    26  * Interface for managing persistent Visual Radio application settings.
       
    27  */
       
    28 NONSHARABLE_CLASS( MRadioApplicationSettings )
       
    29     {
       
    30 
       
    31 public:
       
    32 
       
    33     /**
       
    34      * Possible states for audio playing state.
       
    35      * Once the state reaches ´played´, it doesn't change.
       
    36      */
       
    37     enum TRadioCRAudioPlayHistory
       
    38         {
       
    39         ERadioCRInitial,
       
    40         ERadioCRAudioTriggered,
       
    41         ERadioCRAudioPlayed
       
    42         };
       
    43 
       
    44 public:
       
    45 
       
    46     /**
       
    47      * Stores the currently active preset in the preset list.
       
    48      *
       
    49      * @param aIndex The list box index of the preset that is
       
    50      * currently active.
       
    51      */
       
    52     virtual TInt SetActiveFocusLocation( TInt aIndex ) = 0;
       
    53 
       
    54     /**
       
    55      * Retrieves the list box index of the currently active preset.
       
    56      * By default, the first preset is active.
       
    57      *
       
    58      * @return The list box index of the currently active preset.
       
    59      */
       
    60     virtual TInt ActiveFocusLocation() const = 0;
       
    61 
       
    62     /**
       
    63      * Stores the audio history telling whether the audio has been
       
    64      * played ( so that user has triggered it ).
       
    65      *
       
    66      * Once the history reaches state 'played', it does not change.
       
    67      *
       
    68      * @param aHistory The audio history.
       
    69      */
       
    70     virtual void SetAudioPlayHistoryL( TRadioCRAudioPlayHistory aHistory ) = 0;
       
    71 
       
    72     /**
       
    73      * Retrieves the current audio play history.
       
    74      *
       
    75      * @return The current audio play history.
       
    76      */
       
    77     virtual TRadioCRAudioPlayHistory AudioPlayHistory() const = 0;
       
    78 
       
    79     virtual TInt UpdateStartCount() = 0;
       
    80 
       
    81     virtual TInt SetUiFlags( TUint aUiFlags ) = 0;
       
    82 
       
    83     virtual TUint UiFlags() const = 0;
       
    84 
       
    85     };
       
    86 
       
    87 #endif // M_RADIOAPPLICATIONSETTINGS_H