contextframework/cfw/tsrc/public/basic/common/cfenvutils.h
branchRCL_3
changeset 19 924385140d98
parent 18 0818dd463d41
child 20 c2c61fdca848
equal deleted inserted replaced
18:0818dd463d41 19:924385140d98
     1 /*
       
     2 * Copyright (c) 2008-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:  Environment utils.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef CFENVUTILS_H
       
    20 #define CFENVUTILS_H
       
    21 
       
    22 // SYSTEM INCLUDE FILES
       
    23 #include <e32std.h>
       
    24 
       
    25 // USER INCLUDE FILES
       
    26 
       
    27 // FORWARD DECLARATIONS
       
    28 
       
    29 // DATA TYPES
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  * Context FW environment utils.
       
    35  *
       
    36  * @lib None.
       
    37  * @since S60 5.1
       
    38  */
       
    39 class CFEnvUtils
       
    40     {
       
    41 public:
       
    42 
       
    43     /**
       
    44      * Enables / disbales screen saver.
       
    45      * @param aWasEnabled Returns the current value of screen saver.
       
    46      * @param aEnable Enable screen saver.
       
    47      * @return TInt KErrNone if no errors.
       
    48      */
       
    49     static TInt EnableScreenSaver( TBool& aWasEnabled, const TBool aEnable );
       
    50     
       
    51     /**
       
    52      * Enables / disbales screen saver.
       
    53      * @param aEnable Enable screen saver.
       
    54      * @return TInt KErrNone if no errors.
       
    55      */
       
    56     static TInt EnableScreenSaver( const TBool aEnable );
       
    57 
       
    58 private:
       
    59 
       
    60     /**
       
    61      * C++ constructor.
       
    62      */
       
    63     CFEnvUtils();
       
    64 
       
    65 private:
       
    66     // data
       
    67     };
       
    68 
       
    69 #endif // CFENVUTILS_H