classicui_plat/extended_notifiers_api/inc/AknBatteryNotify.h
changeset 0 2f259fa3e83a
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2002-2007 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:  AVKON notifier client for setting the state of
       
    15 *                status pane's battery pane.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __AKNBATTERYNOTIFY_H__
       
    21 #define __AKNBATTERYNOTIFY_H__
       
    22 
       
    23 #include <AknNotify.h>
       
    24 
       
    25 /**
       
    26 * Notifier client implementation for the system application to
       
    27 * control the battery pane state.
       
    28 *
       
    29 * @lib aknnotify.lib
       
    30 * @since 0.9
       
    31 */
       
    32 NONSHARABLE_CLASS( CAknBatteryNotify ) : public CAknNotifyBase
       
    33     {
       
    34     // Friend class is the system application that can change state of
       
    35     // battery indicator.
       
    36     friend class CSysApAppUi;
       
    37 
       
    38     friend class CIndicViewContainer;
       
    39 
       
    40 private:
       
    41 
       
    42     /**
       
    43     * Two-phased constructor.
       
    44     */
       
    45     IMPORT_C static CAknBatteryNotify* NewL();
       
    46 
       
    47     /**
       
    48     * Two-phased constructor.
       
    49     */
       
    50     IMPORT_C static CAknBatteryNotify* NewLC();
       
    51 
       
    52     /**
       
    53     * Destructor.
       
    54     */
       
    55     IMPORT_C ~CAknBatteryNotify();
       
    56 
       
    57     /**
       
    58     * Sets the battery level.
       
    59     * @param  aLevel  The battery level, accepts values from 0 to 7.
       
    60     */
       
    61     IMPORT_C void SetBatteryLevelL( TInt aLevel );
       
    62 
       
    63     /**
       
    64     * Starts the charging animation in the battery pane.
       
    65     */
       
    66     IMPORT_C void StartChargingL();
       
    67 
       
    68     /**
       
    69     * Stops the charging animation in the battery pane.
       
    70     */
       
    71     IMPORT_C void StopChargingL();
       
    72 
       
    73     /**
       
    74     * @deprecated
       
    75     */
       
    76     IMPORT_C void NotChargingL();
       
    77 
       
    78     /**
       
    79     * Changes the battery icon on the battery pane.
       
    80     * For the possible states @see TAknBatteryIndicatorStates in @c avkon.hrh
       
    81     * @param  aState  The battery icon state.
       
    82     */
       
    83     IMPORT_C void SetBatteryStateL( TInt aState );
       
    84 
       
    85     /**
       
    86     * Default C++ constructor.
       
    87     */
       
    88     CAknBatteryNotify();
       
    89 
       
    90     /**
       
    91     * Symbian 2nd-phase constructor.
       
    92     */
       
    93     void ConstructL();
       
    94     };
       
    95 
       
    96 #endif // __AKNBATTERYNOTIFY_H__