usbengines/usbwatcher/inc/cusbindicatorhandler.h
author hgs
Fri, 23 Jul 2010 13:40:58 +0300
changeset 71 173beb545395
parent 52 831068540b07
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
52
831068540b07 201019_1
hgs
parents:
diff changeset
     1
/*
831068540b07 201019_1
hgs
parents:
diff changeset
     2
* Copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies).
831068540b07 201019_1
hgs
parents:
diff changeset
     3
* All rights reserved.
831068540b07 201019_1
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
831068540b07 201019_1
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
831068540b07 201019_1
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
831068540b07 201019_1
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
831068540b07 201019_1
hgs
parents:
diff changeset
     8
*
831068540b07 201019_1
hgs
parents:
diff changeset
     9
* Initial Contributors:
831068540b07 201019_1
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
831068540b07 201019_1
hgs
parents:
diff changeset
    11
*
831068540b07 201019_1
hgs
parents:
diff changeset
    12
* Contributors:
831068540b07 201019_1
hgs
parents:
diff changeset
    13
*
831068540b07 201019_1
hgs
parents:
diff changeset
    14
* Description:  Header file for class CUsbIndicatorHandler
831068540b07 201019_1
hgs
parents:
diff changeset
    15
*
831068540b07 201019_1
hgs
parents:
diff changeset
    16
*/
831068540b07 201019_1
hgs
parents:
diff changeset
    17
831068540b07 201019_1
hgs
parents:
diff changeset
    18
831068540b07 201019_1
hgs
parents:
diff changeset
    19
#ifndef CUSBINDICATORHANDLER_H
831068540b07 201019_1
hgs
parents:
diff changeset
    20
#define CUSBINDICATORHANDLER_H
831068540b07 201019_1
hgs
parents:
diff changeset
    21
831068540b07 201019_1
hgs
parents:
diff changeset
    22
#include <bldvariant.hrh>
831068540b07 201019_1
hgs
parents:
diff changeset
    23
#include <usbstates.h>
831068540b07 201019_1
hgs
parents:
diff changeset
    24
#include <e32std.h>
831068540b07 201019_1
hgs
parents:
diff changeset
    25
#include <e32base.h>
831068540b07 201019_1
hgs
parents:
diff changeset
    26
831068540b07 201019_1
hgs
parents:
diff changeset
    27
class CHbIndicatorSymbian;
831068540b07 201019_1
hgs
parents:
diff changeset
    28
class CHbSymbianVariant;
831068540b07 201019_1
hgs
parents:
diff changeset
    29
831068540b07 201019_1
hgs
parents:
diff changeset
    30
/**
831068540b07 201019_1
hgs
parents:
diff changeset
    31
*  USB indicator handler class for device side.
831068540b07 201019_1
hgs
parents:
diff changeset
    32
*
831068540b07 201019_1
hgs
parents:
diff changeset
    33
*  This class shows USB indicator when device state changes to Configured, 
831068540b07 201019_1
hgs
parents:
diff changeset
    34
*  and hides USB indicator when device leaves Configured state. Suspended 
831068540b07 201019_1
hgs
parents:
diff changeset
    35
 * state does not change the indicator.
831068540b07 201019_1
hgs
parents:
diff changeset
    36
*
831068540b07 201019_1
hgs
parents:
diff changeset
    37
*  @since TB9.2
831068540b07 201019_1
hgs
parents:
diff changeset
    38
*/
831068540b07 201019_1
hgs
parents:
diff changeset
    39
NONSHARABLE_CLASS( CUsbIndicatorHandler ) : public CBase
831068540b07 201019_1
hgs
parents:
diff changeset
    40
    {
831068540b07 201019_1
hgs
parents:
diff changeset
    41
    friend class CtTUsbIndicatorHandler;
831068540b07 201019_1
hgs
parents:
diff changeset
    42
831068540b07 201019_1
hgs
parents:
diff changeset
    43
public:
831068540b07 201019_1
hgs
parents:
diff changeset
    44
    // Constructors and destructor
831068540b07 201019_1
hgs
parents:
diff changeset
    45
831068540b07 201019_1
hgs
parents:
diff changeset
    46
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
    47
     * Destructor.
831068540b07 201019_1
hgs
parents:
diff changeset
    48
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    49
    ~CUsbIndicatorHandler();
831068540b07 201019_1
hgs
parents:
diff changeset
    50
831068540b07 201019_1
hgs
parents:
diff changeset
    51
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
    52
     * Two-phased constructor.
831068540b07 201019_1
hgs
parents:
diff changeset
    53
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    54
    static CUsbIndicatorHandler* NewL();
831068540b07 201019_1
hgs
parents:
diff changeset
    55
831068540b07 201019_1
hgs
parents:
diff changeset
    56
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
    57
     * Two-phased constructor.
831068540b07 201019_1
hgs
parents:
diff changeset
    58
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    59
    static CUsbIndicatorHandler* NewLC();
831068540b07 201019_1
hgs
parents:
diff changeset
    60
831068540b07 201019_1
hgs
parents:
diff changeset
    61
private:
831068540b07 201019_1
hgs
parents:
diff changeset
    62
831068540b07 201019_1
hgs
parents:
diff changeset
    63
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
    64
     * Constructor for performing 1st stage construction
831068540b07 201019_1
hgs
parents:
diff changeset
    65
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    66
    CUsbIndicatorHandler();
831068540b07 201019_1
hgs
parents:
diff changeset
    67
831068540b07 201019_1
hgs
parents:
diff changeset
    68
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
    69
     * EPOC default constructor for performing 2nd stage construction
831068540b07 201019_1
hgs
parents:
diff changeset
    70
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    71
    void ConstructL();
831068540b07 201019_1
hgs
parents:
diff changeset
    72
831068540b07 201019_1
hgs
parents:
diff changeset
    73
831068540b07 201019_1
hgs
parents:
diff changeset
    74
public:
831068540b07 201019_1
hgs
parents:
diff changeset
    75
        
831068540b07 201019_1
hgs
parents:
diff changeset
    76
	/**
831068540b07 201019_1
hgs
parents:
diff changeset
    77
     * Set USB indicator (On/Off, maybe more in future) according to 
831068540b07 201019_1
hgs
parents:
diff changeset
    78
     * the change of USB device state
831068540b07 201019_1
hgs
parents:
diff changeset
    79
     *
831068540b07 201019_1
hgs
parents:
diff changeset
    80
     * @param aStateOld previous USB device state
831068540b07 201019_1
hgs
parents:
diff changeset
    81
     * @param aStateNew current USB device state
831068540b07 201019_1
hgs
parents:
diff changeset
    82
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    83
    void HandleDeviceStateChangeL( TUsbDeviceState aStateOld, 
831068540b07 201019_1
hgs
parents:
diff changeset
    84
            TUsbDeviceState aStateNew, TInt aPersonality );
831068540b07 201019_1
hgs
parents:
diff changeset
    85
            
831068540b07 201019_1
hgs
parents:
diff changeset
    86
private:
831068540b07 201019_1
hgs
parents:
diff changeset
    87
	/**
831068540b07 201019_1
hgs
parents:
diff changeset
    88
     * Show USB connected indicator (On/Off, maybe more in future)
831068540b07 201019_1
hgs
parents:
diff changeset
    89
     *
831068540b07 201019_1
hgs
parents:
diff changeset
    90
     * @since TB9.2
831068540b07 201019_1
hgs
parents:
diff changeset
    91
     * @param aActivate activate or deactivate the indicator
831068540b07 201019_1
hgs
parents:
diff changeset
    92
     * @param aPersonality the personality id
831068540b07 201019_1
hgs
parents:
diff changeset
    93
     */
831068540b07 201019_1
hgs
parents:
diff changeset
    94
    void ShowUsbConnectedIndicatorL( TBool aActivate, TInt aPersonality );
831068540b07 201019_1
hgs
parents:
diff changeset
    95
831068540b07 201019_1
hgs
parents:
diff changeset
    96
	/**
831068540b07 201019_1
hgs
parents:
diff changeset
    97
     * Show USB addressed state indicator (On/Off, maybe more in future)
831068540b07 201019_1
hgs
parents:
diff changeset
    98
     *
831068540b07 201019_1
hgs
parents:
diff changeset
    99
     * @since TB9.2
831068540b07 201019_1
hgs
parents:
diff changeset
   100
     * @param aActivate activate or deactivate the indicator
831068540b07 201019_1
hgs
parents:
diff changeset
   101
     */    
831068540b07 201019_1
hgs
parents:
diff changeset
   102
    void ShowUsbAddressedIndicator( TBool aActivate );
831068540b07 201019_1
hgs
parents:
diff changeset
   103
	
831068540b07 201019_1
hgs
parents:
diff changeset
   104
private:
831068540b07 201019_1
hgs
parents:
diff changeset
   105
    /**
831068540b07 201019_1
hgs
parents:
diff changeset
   106
     * The device state before suspend.
831068540b07 201019_1
hgs
parents:
diff changeset
   107
     * Used to filter out suspend from others;
831068540b07 201019_1
hgs
parents:
diff changeset
   108
     */
831068540b07 201019_1
hgs
parents:
diff changeset
   109
    TUsbDeviceState iDevStateB4Suspend;
831068540b07 201019_1
hgs
parents:
diff changeset
   110
    
831068540b07 201019_1
hgs
parents:
diff changeset
   111
    CHbIndicatorSymbian* iSymbianIndicator;
831068540b07 201019_1
hgs
parents:
diff changeset
   112
    
831068540b07 201019_1
hgs
parents:
diff changeset
   113
    CHbSymbianVariant* iIndicatorParameters;
831068540b07 201019_1
hgs
parents:
diff changeset
   114
    
831068540b07 201019_1
hgs
parents:
diff changeset
   115
    // remember whether indicators are active or not
831068540b07 201019_1
hgs
parents:
diff changeset
   116
    // simplifies little bit the state handling in HandleDeviceStateChange 
831068540b07 201019_1
hgs
parents:
diff changeset
   117
    TBool iAddressedIndicatorActive;
831068540b07 201019_1
hgs
parents:
diff changeset
   118
    TBool iConnectedIndicatorActive;
831068540b07 201019_1
hgs
parents:
diff changeset
   119
  
831068540b07 201019_1
hgs
parents:
diff changeset
   120
    };
831068540b07 201019_1
hgs
parents:
diff changeset
   121
    
831068540b07 201019_1
hgs
parents:
diff changeset
   122
831068540b07 201019_1
hgs
parents:
diff changeset
   123
#endif   // CUSBINDICATORHANDLER_H
831068540b07 201019_1
hgs
parents:
diff changeset
   124
831068540b07 201019_1
hgs
parents:
diff changeset
   125
// End of File