usbengines/usbwatcher/inc/tusbindicatorhandler.h
author hgs
Fri, 23 Apr 2010 23:17:21 +0300
changeset 43 4712310216c0
permissions -rw-r--r--
201003
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Header file for class TUsbIndicatorHandler
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef TUSBINDICATORHANDLER_H
hgs
parents:
diff changeset
    20
#define TUSBINDICATORHANDLER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <bldvariant.hrh>
hgs
parents:
diff changeset
    23
#include <usbstates.h>
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
/**
hgs
parents:
diff changeset
    27
*  USB indicator handler class for device side.
hgs
parents:
diff changeset
    28
*
hgs
parents:
diff changeset
    29
*  This class shows USB indicator when device state changes to Configured, 
hgs
parents:
diff changeset
    30
*  and hides USB indicator when device leaves Configured state. Suspended 
hgs
parents:
diff changeset
    31
 * state does not change the indicator.
hgs
parents:
diff changeset
    32
*
hgs
parents:
diff changeset
    33
*  @since TB9.2
hgs
parents:
diff changeset
    34
*/
hgs
parents:
diff changeset
    35
NONSHARABLE_CLASS( TUsbIndicatorHandler )
hgs
parents:
diff changeset
    36
    {
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
public:
hgs
parents:
diff changeset
    39
    /**
hgs
parents:
diff changeset
    40
     * Constructor
hgs
parents:
diff changeset
    41
     */
hgs
parents:
diff changeset
    42
    TUsbIndicatorHandler();
hgs
parents:
diff changeset
    43
    
hgs
parents:
diff changeset
    44
	/**
hgs
parents:
diff changeset
    45
     * Set USB indicator (On/Off, maybe more in future) according to 
hgs
parents:
diff changeset
    46
     * the change of USB device state
hgs
parents:
diff changeset
    47
     *
hgs
parents:
diff changeset
    48
     * @param aStateOld previous USB device state
hgs
parents:
diff changeset
    49
     * @param aStateNew current USB device state
hgs
parents:
diff changeset
    50
     */
hgs
parents:
diff changeset
    51
    void HandleDeviceStateChange( TUsbDeviceState aStateOld, 
hgs
parents:
diff changeset
    52
            TUsbDeviceState aStateNew );
hgs
parents:
diff changeset
    53
            
hgs
parents:
diff changeset
    54
private:
hgs
parents:
diff changeset
    55
	/**
hgs
parents:
diff changeset
    56
     * Show USB indicator (On/Off, maybe more in future)
hgs
parents:
diff changeset
    57
     *
hgs
parents:
diff changeset
    58
     * @since TB9.2
hgs
parents:
diff changeset
    59
     * @param aUsbIndicatorState the state of the indicator, 0: OFF, 1: ON
hgs
parents:
diff changeset
    60
     */
hgs
parents:
diff changeset
    61
    void ShowUsbIndicator( TInt aUsbIndicatorState );
hgs
parents:
diff changeset
    62
	
hgs
parents:
diff changeset
    63
private:
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * The device state before suspend.
hgs
parents:
diff changeset
    66
     * Used to filter out suspend from others;
hgs
parents:
diff changeset
    67
     */
hgs
parents:
diff changeset
    68
    TUsbDeviceState iDevStateB4Suspend;
hgs
parents:
diff changeset
    69
    
hgs
parents:
diff changeset
    70
    /////////////////////////////////////////////////////////////////////////
hgs
parents:
diff changeset
    71
    // Test code
hgs
parents:
diff changeset
    72
    friend class CtTUsbIndicatorHandler;
hgs
parents:
diff changeset
    73
    TBool iUsbIndicator; 
hgs
parents:
diff changeset
    74
    // 
hgs
parents:
diff changeset
    75
    /////////////////////////////////////////////////////////////////////////
hgs
parents:
diff changeset
    76
     
hgs
parents:
diff changeset
    77
    };
hgs
parents:
diff changeset
    78
    
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
#endif   // TUSBINDICATORHANDLER_H
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
// End of File