phoneclientserver/inc/cphcltextphonebase.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) 2002 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:  It defines dial interface for phone client.
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 CPHCLTEXTPHONEBASE_H
hgs
parents:
diff changeset
    20
#define CPHCLTEXTPHONEBASE_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
//  INCLUDES
hgs
parents:
diff changeset
    23
#include <e32base.h>
hgs
parents:
diff changeset
    24
#include "phclttypes.h" 
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    27
class MPhCltExtPhoneObserver;
hgs
parents:
diff changeset
    28
class CPhCltExtPhoneDialData;
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// CLASS DECLARATION
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
/**
hgs
parents:
diff changeset
    33
*  It defines dial interface for phone client.
hgs
parents:
diff changeset
    34
*
hgs
parents:
diff changeset
    35
*  Usage:
hgs
parents:
diff changeset
    36
*  
hgs
parents:
diff changeset
    37
*  To dial, you must have a string of characters from set 
hgs
parents:
diff changeset
    38
*  { 0, 1, 2, .. 9, #, *, +, p, P, w, W }. It is the only 
hgs
parents:
diff changeset
    39
*  mandatory parameter. String may also contain other characters,
hgs
parents:
diff changeset
    40
*  but then only a note is displayed. So you should proceed as follows:
hgs
parents:
diff changeset
    41
*       1. Check that string is acceptable. 
hgs
parents:
diff changeset
    42
*          (application specific grammar)
hgs
parents:
diff changeset
    43
*       2. If not, stop. Otherwise continue.
hgs
parents:
diff changeset
    44
*       3. Convert to string acceptable by phoneclient.
hgs
parents:
diff changeset
    45
*          Note PhCltUtils class may help.
hgs
parents:
diff changeset
    46
*       4. Dial using the class.
hgs
parents:
diff changeset
    47
*
hgs
parents:
diff changeset
    48
*  Note that dialling does not always mean creating a call. 
hgs
parents:
diff changeset
    49
*  (E.g. *#43# makes phone to interrogate status of call waiting.)
hgs
parents:
diff changeset
    50
*  
hgs
parents:
diff changeset
    51
*  In order to dial, you need instance of CPhCltExtPhoneBase. You 
hgs
parents:
diff changeset
    52
*  can create one as follows:
hgs
parents:
diff changeset
    53
*       iExtCall = CPhCltExtPhoneBase::NewL( this );
hgs
parents:
diff changeset
    54
*  (the parameter is pointer to observer)
hgs
parents:
diff changeset
    55
*
hgs
parents:
diff changeset
    56
*  Then you must fill dial parameters to instance of TPhCltExtPhoneDialData.
hgs
parents:
diff changeset
    57
*  (you can read more details from its header)
hgs
parents:
diff changeset
    58
*
hgs
parents:
diff changeset
    59
*       TPhCltExtPhoneDialData data;
hgs
parents:
diff changeset
    60
*       data.SetTelephoneNumber( .. );
hgs
parents:
diff changeset
    61
*       ..
hgs
parents:
diff changeset
    62
*
hgs
parents:
diff changeset
    63
*  And finally, you can dial. Note that the method is asynchronous and
hgs
parents:
diff changeset
    64
*  observer will be informed when phone starts dialing.
hgs
parents:
diff changeset
    65
*
hgs
parents:
diff changeset
    66
*       iExtCall->DialL( data );
hgs
parents:
diff changeset
    67
*
hgs
parents:
diff changeset
    68
*  Finally, you can delete the instance. If dialing is ongoing, this should
hgs
parents:
diff changeset
    69
*  be done after observer has been informed. You can also delete before that,
hgs
parents:
diff changeset
    70
*  but then the request might also be canceled.
hgs
parents:
diff changeset
    71
*
hgs
parents:
diff changeset
    72
*  @lib phoneclient.lib
hgs
parents:
diff changeset
    73
*  @since 1.0
hgs
parents:
diff changeset
    74
*/
hgs
parents:
diff changeset
    75
class CPhCltExtPhoneBase : public CActive
hgs
parents:
diff changeset
    76
    {
hgs
parents:
diff changeset
    77
    public:  // Constructors and destructor
hgs
parents:
diff changeset
    78
 
hgs
parents:
diff changeset
    79
        /**
hgs
parents:
diff changeset
    80
        * Create an instance that implements the interface.
hgs
parents:
diff changeset
    81
        *
hgs
parents:
diff changeset
    82
        * @param aObserver It is the observer for the instance.
hgs
parents:
diff changeset
    83
        * @return Returns the created instance.
hgs
parents:
diff changeset
    84
        */
hgs
parents:
diff changeset
    85
        IMPORT_C static CPhCltExtPhoneBase* NewL( 
hgs
parents:
diff changeset
    86
            MPhCltExtPhoneObserver* aObserver );
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
    public: // New fuctions    
hgs
parents:
diff changeset
    90
        
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
       /**
hgs
parents:
diff changeset
    93
       * Makes a new call. This is the preferred way of dialling!
hgs
parents:
diff changeset
    94
       *
hgs
parents:
diff changeset
    95
       * @param aData The object containing the parameters for 
hgs
parents:
diff changeset
    96
       *              the dial request.
hgs
parents:
diff changeset
    97
       */
hgs
parents:
diff changeset
    98
       virtual void DialL( CPhCltExtPhoneDialData& aData ) = 0;
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
    protected:
hgs
parents:
diff changeset
   102
hgs
parents:
diff changeset
   103
        /**
hgs
parents:
diff changeset
   104
        * C++ constructor.
hgs
parents:
diff changeset
   105
        */
hgs
parents:
diff changeset
   106
        CPhCltExtPhoneBase( MPhCltExtPhoneObserver* aObserver );
hgs
parents:
diff changeset
   107
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
    protected: // Data
hgs
parents:
diff changeset
   110
        
hgs
parents:
diff changeset
   111
        // Observer to handle events.
hgs
parents:
diff changeset
   112
        MPhCltExtPhoneObserver* iObserver;
hgs
parents:
diff changeset
   113
hgs
parents:
diff changeset
   114
    };
hgs
parents:
diff changeset
   115
hgs
parents:
diff changeset
   116
#endif      // CPHCLTEXTPHONEBASE_H
hgs
parents:
diff changeset
   117
            
hgs
parents:
diff changeset
   118
// End of File