phonesrv_plat/dial_utils_api/inc/dialutils.h
author hgs
Wed, 21 Jul 2010 18:26:52 +0300
changeset 33 8d5d7fcf9b59
permissions -rw-r--r--
201027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2004 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  API for DialUtils usage.
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef DIALUTILS_H
hgs
parents:
diff changeset
    20
#define DIALUTILS_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// CLASS DECLARATION
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
*  The API for DialUtils usage.
hgs
parents:
diff changeset
    31
*
hgs
parents:
diff changeset
    32
*  @lib DialUtils.lib
hgs
parents:
diff changeset
    33
*  @since 2.6
hgs
parents:
diff changeset
    34
*/
hgs
parents:
diff changeset
    35
class CDialUtilsApi 
hgs
parents:
diff changeset
    36
:   public CBase
hgs
parents:
diff changeset
    37
    {
hgs
parents:
diff changeset
    38
    public: // New functions
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
        /**
hgs
parents:
diff changeset
    41
        * Check and if needed modify the given phone number according to
hgs
parents:
diff changeset
    42
        * current configuration and location. Currently supports:
hgs
parents:
diff changeset
    43
        * 1) Japan prefix modifications.
hgs
parents:
diff changeset
    44
        * 
hgs
parents:
diff changeset
    45
        * @param aPhoneNumber The phone number to be checked and modified.
hgs
parents:
diff changeset
    46
        * @return - KErrNone if successful,
hgs
parents:
diff changeset
    47
        *         - KErrOverflow if the aPhoneNumber is too short for the 
hgs
parents:
diff changeset
    48
        *           combined original phone number + prefix number,
hgs
parents:
diff changeset
    49
        *         - Symbian error code otherwise.
hgs
parents:
diff changeset
    50
        *         In error case the aPhoneNumber is untouched.
hgs
parents:
diff changeset
    51
        */
hgs
parents:
diff changeset
    52
        virtual TInt CheckNumber( HBufC& aPhoneNumber ) = 0;
hgs
parents:
diff changeset
    53
    };
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
/**
hgs
parents:
diff changeset
    58
*  Interface for DialUtils creation.
hgs
parents:
diff changeset
    59
*
hgs
parents:
diff changeset
    60
*  @lib DialUtils.lib
hgs
parents:
diff changeset
    61
*  @since 2.6
hgs
parents:
diff changeset
    62
*/
hgs
parents:
diff changeset
    63
class CDialUtilsFactory
hgs
parents:
diff changeset
    64
:   public CBase
hgs
parents:
diff changeset
    65
    {
hgs
parents:
diff changeset
    66
    public:
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
        * Creates DialUtils.
hgs
parents:
diff changeset
    70
        * CDialUtilsFactory instance is deleted even in leave case.
hgs
parents:
diff changeset
    71
        * 
hgs
parents:
diff changeset
    72
        * @return CDialUtilsApi implementation. NULL if not supported.
hgs
parents:
diff changeset
    73
        *         Ownership transferred.
hgs
parents:
diff changeset
    74
        */
hgs
parents:
diff changeset
    75
        virtual CDialUtilsApi* CDialUtilsApiLD() = 0;
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
    };
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
/**
hgs
parents:
diff changeset
    80
* Only exported function. This is in index 1 in the lookup table.
hgs
parents:
diff changeset
    81
* Call this function to create CDialUtilsFactory instance.
hgs
parents:
diff changeset
    82
* 
hgs
parents:
diff changeset
    83
* IMPORT_C CDialUtilsFactory* CreateDialUtilsFactoryL();
hgs
parents:
diff changeset
    84
*/ 
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
#endif   // DIALUTILS_H
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
// End of File