1 /*

     2 * Copyright (c) 2002-2008 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:  Defines an internal singleton class CAknsAppUiParameters.

    15 *                Encapsulates AppUi-specific skin parameters and acts as a

    16 *                singleton in application scope.

    17 *

    18 */

    19 

    20 

    21 #ifndef AKNSAPPUIPARAMETERS_H

    22 #define AKNSAPPUIPARAMETERS_H

    23 

    24 //  INCLUDES

    25 #include <coemain.h>

    26 

    27 // CLASS DECLARATION

    28 

    29 /**

    30 * Singleton class encapsulating AppUi-specific skin parameters

    31 *

    32 * This is an internal class that contains no exported functions.

    33 * The class is not intended for derivation outside the library.

    34 *

    35 * @since 2.0

    36 *

    37 * @internal

    38 */

    39 NONSHARABLE_CLASS(CAknsAppUiParameters) : public CCoeStatic

    40     {

    41     protected:  // Protected constructor

    42 

    43         /**

    44         * C++ default constructor.

    45         *

    46         * @internal

    47         */

    48         CAknsAppUiParameters();

    49 

    50     public: // Constructors and destructors

    51 

    52         /**

    53         * Creates the singleton.

    54         *

    55         * @par Exceptions:

    56         *   If construction fails, leaves with an error code.

    57         *

    58         * @internal

    59         */

    60         static void CreateSingletonL();

    61 

    62         /**

    63         * Destructor.

    64         *

    65         * @internal

    66         */

    67         virtual ~CAknsAppUiParameters();

    68 

    69     public: // New methods

    70 

    71         /**

    72         * Sets the value of the flag indicating whether newly created Avkon

    73         * controls should use default skin parameters.

    74         *

    75         * @param aEnabled Flag value as TBool.

    76         */

    77         void SetAvkonSkinEnabled( TBool aEnabled );

    78 

    79         /**

    80         * Retrieves the value of the flag indicating whether newly created

    81         * Avkon controls should use default skin parameters.

    82         *

    83         * @return Flag value as TBool.

    84         */

    85         TBool AvkonSkinEnabled() const;

    86 

    87         /**

    88         * Sets the value of the flag indicating whether newly created Avkon

    89         * list controls should use highlight animation.

    90         *

    91         * @param aEnabled Flag value as TBool.

    92         */

    93         void SetAvkonHighlightAnimationEnabled( TBool aEnabled );

    94 

    95         /**

    96         * Retrieves the value of the flag indicating whether newly created

    97         * Avkon list controls should use highlight animation.

    98         *

    99         * @return Flag value as TBool.

   100         */

   101         TBool AvkonHighlightAnimationEnabled() const;

   102 

   103     protected:  // Data

   104 

   105         /**

   106         * Flag indicating whether default skin parameters should be used

   107         * for newly created Avkon controls.

   108         */

   109         TBool iAvkonSkinEnabled;

   110 

   111         /**

   112         * Flag indicating whether highlight animation should be used for newly

   113         * created Avkon list controls.

   114         */

   115         TBool iAvkonHighlightAnimationEnabled;

   116     };

   117 

   118 #endif // AKNSAPPUIPARAMETERS_H

   119 

   120 // End of File