epoc32/include/e32power.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// e32\include\e32power.h
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __E32POWER_H__
williamr@2
    19
#define __E32POWER_H__
williamr@2
    20
williamr@2
    21
#include <e32cmn.h>
williamr@2
    22
williamr@2
    23
williamr@2
    24
williamr@2
    25
williamr@2
    26
/**
williamr@2
    27
@publishedPartner
williamr@2
    28
@released
williamr@2
    29
williamr@2
    30
System-wide power states
williamr@2
    31
*/
williamr@2
    32
enum TPowerState
williamr@2
    33
	{
williamr@2
    34
	/** The system is fully operational; could be busy or idle */ 
williamr@2
    35
	EPwActive,
williamr@2
    36
	/** The system sleeps keeping the full memory state in RAM */ 
williamr@2
    37
	EPwStandby,
williamr@2
    38
	/** System is off; can go to active by rebooting only */
williamr@2
    39
	EPwOff,
williamr@2
    40
	/** The system restarts - i.e. switches off and then back on */
williamr@2
    41
	EPwRestart,
williamr@2
    42
	/** An integer that strictly greater of any legal power state value */
williamr@2
    43
	EPwLimit,
williamr@2
    44
	};
williamr@2
    45
williamr@2
    46
williamr@2
    47
williamr@2
    48
williamr@2
    49
/** 
williamr@2
    50
@publishedPartner
williamr@2
    51
@released
williamr@2
    52
williamr@2
    53
User-level domain manager's interface to Kernel-level power management.
williamr@2
    54
*/
williamr@2
    55
class Power
williamr@2
    56
williamr@2
    57
	{
williamr@2
    58
public:
williamr@2
    59
	IMPORT_C static TInt EnableWakeupEvents(TPowerState);
williamr@2
    60
	IMPORT_C static void DisableWakeupEvents();
williamr@2
    61
	IMPORT_C static void RequestWakeupEventNotification(TRequestStatus&);
williamr@2
    62
	IMPORT_C static void CancelWakeupEventNotification();
williamr@2
    63
	IMPORT_C static TInt PowerDown();
williamr@2
    64
	};
williamr@2
    65
williamr@2
    66
#endif