phoneapp/phoneuiutils/inc/tphonecmdparamemergencycallheaderdata.h
changeset 0 5f000ab63145
equal deleted inserted replaced
-1:000000000000 0:5f000ab63145
       
     1 /*
       
     2 * Copyright (c) 2005 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: 
       
    15 *   See class description.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef __TPHONECMDPARAMEMERGENCYCALLHEADERDATA_H
       
    21 #define __TPHONECMDPARAMEMERGENCYCALLHEADERDATA_H
       
    22 
       
    23 //  INCLUDES
       
    24 
       
    25 #include <w32std.h>
       
    26 #include "tphonecommandparam.h"
       
    27 
       
    28 // DATA TYPES
       
    29 
       
    30 // CLASS DECLARATION
       
    31 
       
    32 /**
       
    33 *  A parameter class for emergency call header information.
       
    34 */
       
    35 class TPhoneCmdParamEmergencyCallHeaderData : public TPhoneUICommandParam
       
    36     {   
       
    37     public:  
       
    38         
       
    39         /**
       
    40         * C++ default constructor.
       
    41         */
       
    42         IMPORT_C TPhoneCmdParamEmergencyCallHeaderData();
       
    43 
       
    44     public: 
       
    45         
       
    46         /**
       
    47         * Sets the call header label text.
       
    48         * @param aLabelText is the label
       
    49         */
       
    50         IMPORT_C void SetLabelText( const TDesC& aLabelText );
       
    51 
       
    52         /**
       
    53         * Sets the call header text
       
    54         * @param aHeaderText is the short label
       
    55         */
       
    56         IMPORT_C void SetHeaderText( const TDesC& aHeaderText );
       
    57 
       
    58         /**
       
    59         * Sets the call header voice privacy status.
       
    60         * @param aCiphering is ETrue if voice privacy is on.
       
    61         */
       
    62         IMPORT_C void SetCiphering( TBool aCiphering );
       
    63 
       
    64         /**
       
    65         * Sets the call header own phone number text
       
    66         * @param aOwnNumberText is the user's phone number
       
    67         */
       
    68         IMPORT_C void SetOwnPhoneNumberText( 
       
    69             const TDesC& aOwnPhoneNumberText );
       
    70 
       
    71         /**
       
    72         * Returns the call header label text
       
    73         * @return Returns the label
       
    74         */
       
    75         IMPORT_C const TDesC& LabelText() const;
       
    76 
       
    77         /**
       
    78         * Returns the call header text.
       
    79         * @return Returns the header
       
    80         */
       
    81         IMPORT_C const TDesC& HeaderText() const;
       
    82 
       
    83         /**
       
    84         * Returns the call header ciphering status.
       
    85         * @return Returns ETrue if ciphering is on 
       
    86         */
       
    87         IMPORT_C TBool Ciphering() const;
       
    88 
       
    89         /**
       
    90         * Returns the own phone number text.
       
    91         * @return Returns the own phone number text
       
    92         */
       
    93         IMPORT_C const TDesC& OwnPhoneNumberText() const;
       
    94 
       
    95         /**
       
    96         * Sets the ciphering indicator allowed or hidden
       
    97         * @param aAllowed EFalse to prevent ciphering indicator from showing
       
    98         *                 ETrue to enable
       
    99         */
       
   100         IMPORT_C void SetCipheringIndicatorAllowed( TBool aAllowed );
       
   101         
       
   102         /**
       
   103         * Returns the ciphering indicator allowed status
       
   104         * @return Returns EFalse when ciphering indicator is wanted to be disabled
       
   105         *         ETrue to be allowed
       
   106         */
       
   107         IMPORT_C TBool CipheringIndicatorAllowed() const;
       
   108         
       
   109     private:    
       
   110         
       
   111         /**
       
   112         * Call header label text
       
   113         */
       
   114         TPtrC iLabelText;
       
   115 
       
   116         /**
       
   117         * Call header text
       
   118         */
       
   119         TPtrC iHeaderText;
       
   120 
       
   121         /**
       
   122         * Call header ciphering status
       
   123         */
       
   124         TBool iCiphering;
       
   125 
       
   126         /**
       
   127         * Call header own phone number Text
       
   128         */
       
   129         TPtrC iOwnPhoneNumberText;
       
   130 
       
   131         /**
       
   132         * Should the ciphering indicator be visible or not
       
   133         */
       
   134         TBool iCipheringIndicatorAllowed;
       
   135         
       
   136     };
       
   137 
       
   138 #endif // __TPHONECMDPARAMEMERGENCYCALLHEADERDATA_H   
       
   139             
       
   140 // End of File