phonesrv_plat/string_parser_api/inc/CPhoneGsmOptionContainerBase.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002 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:  Base class for options container that can be used 
       
    15 *                to configure the parsing process. 
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef CPHONEGSMOPTIONCONTAINERBASE_H_
       
    21 #define CPHONEGSMOPTIONCONTAINERBASE_H_
       
    22 
       
    23 // INCLUDES
       
    24 #include    <e32base.h>
       
    25 
       
    26 // CONSTANTS
       
    27 
       
    28 /**
       
    29 * Option is true if operation is send. False if it is a code check.
       
    30 */
       
    31 const TInt KPhoneOptionSend = 1;
       
    32 
       
    33 /**
       
    34 * Option is true if there is a call ongoing. Otherwise false.
       
    35 */
       
    36 const TInt KPhoneOptionInCall = 2;
       
    37 
       
    38 /**
       
    39 * Option is true if two digit calling is supported. Otherwise false.
       
    40 * Client should not try to set this option with SetOptionStatus() -method because 
       
    41 * Two Digit Calling is variable feature.
       
    42 */
       
    43 const TInt KPhoneOptionTwoDigitCalling = 3;
       
    44 
       
    45 /**
       
    46 * Option is true if voip call. Otherwise false.
       
    47 */
       
    48 const TInt KPhoneOptionVoipCall = 4;
       
    49 
       
    50 // FORWARD DECLARATIONS
       
    51 
       
    52 // CLASS DECLARATION
       
    53 
       
    54 /**
       
    55 * It is container for options. Each option is identified by 
       
    56 * a single uid and each option has a boolean status.
       
    57 *
       
    58 * @since 5.0
       
    59 * @lib phoneparser.lib
       
    60 */
       
    61 NONSHARABLE_CLASS( CPhoneGsmOptionContainerBase ) 
       
    62     : public CBase
       
    63     {
       
    64     
       
    65     public: // New functions
       
    66                        
       
    67         /**
       
    68         * Sets status of option.
       
    69         *        
       
    70         * @param aOptionUid It is the uid of the option.
       
    71         * @param aStatus It is the new status for the option.
       
    72         */
       
    73         virtual void SetOptionStatus( TInt aOptionUid, TBool aStatus ) = 0;    
       
    74         
       
    75         /**
       
    76         * Finds status of option.
       
    77         *
       
    78         * @param aOptionUid It is the uid of the option.
       
    79         * @return Returne status of the option.
       
    80         */
       
    81         virtual TBool FindOptionStatus( TInt aOptionUid ) const = 0;
       
    82 
       
    83     };
       
    84 
       
    85 #endif /*CPHONEGSMOPTIONCONTAINERBASE_H_*/