messagingapp/msgsettings/msginit/inc/msignalstrengthhandler.h
author hgs
Tue, 07 Sep 2010 13:28:39 +0530
changeset 62 fdbe8253b596
parent 46 b1f0785c289d
permissions -rw-r--r--
201035_03
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
46
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     1
/*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     3
* All rights reserved.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     8
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
     9
* Initial Contributors:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    11
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    12
* Contributors:
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    13
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    14
* Description:   Interface for signal strength handler.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    15
*
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    16
*/
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    17
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    18
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    19
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    20
#ifndef MSIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    21
#define MSIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    22
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    23
//  INCLUDES
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    24
#include <e32base.h>
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    25
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    26
// FORWARD DECLARATIONS
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    27
class MSignalStrengthObserver;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    28
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    29
// CLASS DECLARATION
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    30
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    31
/**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    32
*  Interface for a class which handles changes
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    33
*  in phone signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    34
*/
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    35
class MSignalStrengthHandler
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    36
    {
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    37
    public:     // Constructors and destructor
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    38
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    39
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    40
        * Destructor.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    41
        */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    42
        virtual ~MSignalStrengthHandler() {};
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    43
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    44
    public:     // New functions
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    45
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    46
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    47
         * Returns ETrue if signal observing is supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    48
         * @return ETrue if signal observing is supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    49
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    50
        virtual TBool ObservingSupported() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    51
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    52
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    53
         * Returns ETrue if signal strength requests are supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    54
         * @return ETrue if signal strength requests are supported, EFalse otherwise.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    55
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    56
        virtual TBool RequestsSupported() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    57
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    58
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    59
         * Sets the signal strength observer. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    60
         * if signal strength observing is not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    61
         * @param aObserver Observer for signal strength. Ownership is not passed.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    62
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    63
        virtual void SetSignalStrengthObserverL( MSignalStrengthObserver* aObserver ) = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    64
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    65
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    66
         * Starts observing the signal strength. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    67
         * if signal strength observing is not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    68
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    69
        virtual void StartObservingL() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    70
 
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    71
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    72
         * Stops the signal strength observing.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    73
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    74
        virtual void StopObservingL() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    75
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    76
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    77
         * Returns the current signal strength. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    78
         * if signal strength requests are not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    79
         * @return The current signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    80
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    81
        virtual TInt SignalStrengthL() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    82
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    83
        /**
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    84
         * Returns the current bar value. May leave with KErrNotSupported
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    85
         * if bar value requests are not supported.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    86
         * @return The current signal strength.
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    87
         */
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    88
        virtual TInt BarValueL() = 0;
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    89
        
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    90
    };
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    91
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    92
#endif      // MSIGNALSTRENGTHHANDLER_H
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    93
b1f0785c289d 201027_03
hgs
parents:
diff changeset
    94
// End of File