phonesrv_plat/dial_utils_api/inc/dialutils.h
changeset 51 12bc758d6a02
parent 48 78df25012fda
child 53 25b8d29b7c59
equal deleted inserted replaced
48:78df25012fda 51:12bc758d6a02
     1 /*
       
     2 * Copyright (c) 2004 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:  API for DialUtils usage.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIALUTILS_H
       
    20 #define DIALUTILS_H
       
    21 
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32base.h>
       
    25 
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30 *  The API for DialUtils usage.
       
    31 *
       
    32 *  @lib DialUtils.lib
       
    33 *  @since 2.6
       
    34 */
       
    35 class CDialUtilsApi 
       
    36 :   public CBase
       
    37     {
       
    38     public: // New functions
       
    39 
       
    40         /**
       
    41         * Check and if needed modify the given phone number according to
       
    42         * current configuration and location. Currently supports:
       
    43         * 1) Japan prefix modifications.
       
    44         * 
       
    45         * @param aPhoneNumber The phone number to be checked and modified.
       
    46         * @return - KErrNone if successful,
       
    47         *         - KErrOverflow if the aPhoneNumber is too short for the 
       
    48         *           combined original phone number + prefix number,
       
    49         *         - Symbian error code otherwise.
       
    50         *         In error case the aPhoneNumber is untouched.
       
    51         */
       
    52         virtual TInt CheckNumber( HBufC& aPhoneNumber ) = 0;
       
    53     };
       
    54 
       
    55 
       
    56 
       
    57 /**
       
    58 *  Interface for DialUtils creation.
       
    59 *
       
    60 *  @lib DialUtils.lib
       
    61 *  @since 2.6
       
    62 */
       
    63 class CDialUtilsFactory
       
    64 :   public CBase
       
    65     {
       
    66     public:
       
    67 
       
    68         /**
       
    69         * Creates DialUtils.
       
    70         * CDialUtilsFactory instance is deleted even in leave case.
       
    71         * 
       
    72         * @return CDialUtilsApi implementation. NULL if not supported.
       
    73         *         Ownership transferred.
       
    74         */
       
    75         virtual CDialUtilsApi* CDialUtilsApiLD() = 0;
       
    76 
       
    77     };
       
    78 
       
    79 /**
       
    80 * Only exported function. This is in index 1 in the lookup table.
       
    81 * Call this function to create CDialUtilsFactory instance.
       
    82 * 
       
    83 * IMPORT_C CDialUtilsFactory* CreateDialUtilsFactoryL();
       
    84 */ 
       
    85 
       
    86 
       
    87 #endif   // DIALUTILS_H
       
    88 
       
    89 // End of File