classicui_plat/extended_notifiers_api/inc/AknSignalNotify.h
changeset 0 2f259fa3e83a
child 18 fcdfafb36fe7
equal deleted inserted replaced
-1:000000000000 0:2f259fa3e83a
       
     1 /*
       
     2 * Copyright (c) 2002-2008 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 signal pane data.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef __AKNSIGNALNOTIFY_H__
       
    20 #define __AKNSIGNALNOTIFY_H__
       
    21 
       
    22 #include <AknNotify.h>
       
    23 
       
    24 NONSHARABLE_CLASS( CAknSignalNotify ) : public CAknNotifyBase
       
    25     {
       
    26     // Friend class is the system application that can change state of 
       
    27     // signal indicator. 
       
    28     friend class CSysApAppUi;
       
    29 
       
    30     friend class CIndicViewContainer;
       
    31 
       
    32 private:
       
    33 
       
    34     /**
       
    35     * Two-phased constructor.
       
    36     */
       
    37     IMPORT_C static CAknSignalNotify* NewL();
       
    38     
       
    39     /**
       
    40     * Two-phased constructor.
       
    41     */
       
    42     IMPORT_C static CAknSignalNotify* NewLC();
       
    43     
       
    44     /**
       
    45     * Destructor.
       
    46     */
       
    47     IMPORT_C ~CAknSignalNotify();
       
    48 
       
    49     /**
       
    50     * Set signal level to the signal pane on the status pane.
       
    51     * This method is also used to set signal pane to show offline mode
       
    52     * icon by using @c KAknSignalOffLineMode as the @c aLevel parameter.
       
    53     *
       
    54     * @param  aLevel  Signal level (0-7 or @c KAknSignalOffLineMode).
       
    55     */
       
    56     IMPORT_C void SetSignalLevelL( TInt aLevel );
       
    57 
       
    58     /**
       
    59     *  Set GPRS indicator state.
       
    60     *
       
    61     *  Note that the @c EAknSignalGprsIndicatorOff can only be set if
       
    62     *  the previous signal state was one of the GPRS states.
       
    63     *
       
    64     *  Available states from @c avkon.hrh:
       
    65     *    - EAknSignalGprsIndicatorOff = 0,
       
    66     *    - EAknSignalGprsIndicatorAvailable,  // Same as EAknSignalGprsIndicatorOff
       
    67     *    - EAknSignalGprsIndicatorAttached,
       
    68     *    - EAknSignalGprsIndicatorEstablishingContext,
       
    69     *    - EAknSignalGprsIndicatorContext,
       
    70     *    - EAknSignalGprsIndicatorSuspended
       
    71     *
       
    72     *  @param aGprsState GPRS indicator state.
       
    73     */
       
    74     IMPORT_C void SetGprsStateL( TInt aGprsState );
       
    75 
       
    76     /**
       
    77     *  Set Common packet data indicator state.
       
    78     *
       
    79     *  Note that the @c EAknSignalCommonPacketDataIndicatorOff can only
       
    80     *  be set if the previous signal state was one of the
       
    81     *  Common packet data states.
       
    82     *
       
    83     *  Available states from @c avkon.hrh:
       
    84     *   - EAknSignalCommonPacketDataIndicatorOff = 0x100,
       
    85     *   - EAknSignalCommonPacketDataIndicatorAvailable, // Same as EAknSignalCommonPacketDataIndicatorOff
       
    86     *   - EAknSignalCommonPacketDataIndicatorAttached,
       
    87     *   - EAknSignalCommonPacketDataIndicatorEstablishingContext,
       
    88     *   - EAknSignalCommonPacketDataIndicatorContext,
       
    89     *   - EAknSignalCommonPacketDataIndicatorSuspended,
       
    90     *   - EAknSignalCommonPacketDataIndicatorMultipdp
       
    91     *
       
    92     *  @since 2.6
       
    93     *
       
    94     *  @param  aCommonPacketDataState  Common packet data indicator state.
       
    95     */
       
    96     IMPORT_C void SetCommonPacketDataStateL( TInt aCommonPacketDataState );
       
    97 
       
    98     /**
       
    99     *  Set EDGE indicator state.
       
   100     *
       
   101     *  Note that the @c EAknSignalEdgeIndicatorOff can only be set if
       
   102     *  the previous signal state was one of the EDGE states.
       
   103     *
       
   104     *  Available states from @c avkon.hrh:
       
   105     *   - EAknSignalEdgeIndicatorOff = 0x400,
       
   106     *   - EAknSignalEdgeIndicatorAvailable,
       
   107     *   - EAknSignalEdgeIndicatorAttached,
       
   108     *   - EAknSignalEdgeIndicatorEstablishingContext, 
       
   109     *   - EAknSignalEdgeIndicatorContext,
       
   110     *   - EAknSignalEdgeIndicatorSuspended,
       
   111     *   - EAknSignalEdgeIndicatorMultipdp    
       
   112     *
       
   113     *  @since 3.0
       
   114     *
       
   115     *  @param  aEdgeState  EDGE indicator state.
       
   116     */
       
   117     IMPORT_C void SetEdgeStateL( TInt aEdgeState );
       
   118 
       
   119     /**
       
   120     *  Set WCDMA indicator state.
       
   121     *
       
   122     *  Note that the @c EAknSignalWcdmaIndicatorOff can only be set if
       
   123     *  the previous signal state was one of the WCDMA states.
       
   124     *
       
   125     *  Available states from @c avkon.hrh:
       
   126     *   - EAknSignalWcdmaIndicatorOff = 0x200,  
       
   127     *   - EAknSignalWcdmaIndicatorAvailable,  
       
   128     *   - EAknSignalWcdmaIndicatorAttached,
       
   129     *   - EAknSignalWcdmaIndicatorEstablishingContext, 
       
   130     *   - EAknSignalWcdmaIndicatorContext,
       
   131     *   - EAknSignalWcdmaIndicatorMultipdp
       
   132     *   - EAknSignalWcdmaIndicatorSuspended
       
   133     *   
       
   134     *  @since 2.6
       
   135     *
       
   136     *  @param  aWcdmaState  WCDMA indicator state.
       
   137     */
       
   138     IMPORT_C void SetWcdmaStateL( TInt aWcdmaState );
       
   139 
       
   140     /**
       
   141     *  Set HSDPA indicator state.
       
   142     *
       
   143     *  Note that the @c EAknSignalHsdpaIndicatorOff can only be set if
       
   144     *  the previous signal state was one of the HSDPA states.
       
   145     *
       
   146     *  Available states from @c avkon.hrh:
       
   147     *   - EAknSignalHsdpaIndicatorOff 
       
   148     *   - EAknSignalHsdpaIndicatorAvailable,
       
   149     *   - EAknSignalHsdpaIndicatorAttached,
       
   150     *   - EAknSignalHsdpaIndicatorEstablishingContext, 
       
   151     *   - EAknSignalHsdpaIndicatorContext,
       
   152     *   - EAknSignalHsdpaIndicatorSuspended,
       
   153     *   - EAknSignalHsdpaIndicatorMultipdp    
       
   154     *
       
   155     *  @since 3.1
       
   156     *
       
   157     *  @param  aHsdpaState  HSDPA indicator state.
       
   158     */
       
   159     IMPORT_C void SetHsdpaStateL( TInt aHsdpaState );
       
   160 
       
   161     /** 
       
   162     *  Set CDMA indicator state.
       
   163     *
       
   164     *  The CDMA states can only be used if the @c __PROTOCOL_CDMA feature
       
   165     *  flag has been defined.
       
   166     *
       
   167     *  Note that the @c EAknSignalCdmaIndicatorOff can only be set if
       
   168     *  the previous signal state was one of the CDMA states.
       
   169     *
       
   170     *  Available states from @c avkon.hrh:
       
   171     *  - EAknSignalCdmaIndicatorOff = 0x300,
       
   172     *  - EAknSignalCdmaIndicatorNoService,  
       
   173     *  - EAknSignalCdmaIndicatorAvailable,
       
   174     *  - EAknSignalCdmaIndicatorNotAvailable, 
       
   175     *  - EAknSignalCdmaIndicatorActive,
       
   176     *  - EAknSignalCdmaIndicatorDormant,
       
   177     *  - EAknSignalCdmaIndicatorSending,
       
   178     *  - EAknSignalCdmaIndicatorReceiving
       
   179     *
       
   180     *  @since 2.7
       
   181     *
       
   182     *  @param  aCdmaState  CDMA indicator state.
       
   183     */
       
   184     IMPORT_C void SetCdmaStateL( TInt aCdmaState );
       
   185 
       
   186 private:
       
   187 
       
   188     /**
       
   189     * Default C++ constructor.
       
   190     */
       
   191     CAknSignalNotify();
       
   192     
       
   193     
       
   194     /**
       
   195     * Second-phase constructor.
       
   196     */
       
   197     void ConstructL();
       
   198     
       
   199     /**
       
   200     * Sends the signal state change request.
       
   201     *
       
   202     * @param  aState  New signal state.
       
   203     */
       
   204     void SetStateL( TInt aState );
       
   205 
       
   206 private:
       
   207 
       
   208     /**
       
   209     * Reserved for future use.
       
   210     */
       
   211     IMPORT_C void CAknNotifyBase_Reserved();
       
   212     };
       
   213 
       
   214 #endif // __AKNSIGNALNOTIFY_H__