1 /*

     2 * Copyright (c) 2006, 2007 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:  s_enginecontmgtextfeatures.cpp

    15 *

    16 */

    17 

    18 #ifndef S_MCCAPARAMETER_H_

    19 #define S_MCCAPARAMETER_H_

    20 

    21 

    22 #include <e32std.h>

    23 #include <cntdef.h>

    24 #include <MVPbkContactLink.h>

    25 #include <mccaparameter.h>

    26 

    27 /** @file mccaparameter.h

    28  *

    29  *  MCCAParameter class is used to store, control and define how the CCA application is launched

    30  *  with the contact specified data.

    31  *

    32  *  Example usage of the API:

    33  *  @code

    34  *   MCCAParameter* aParameter = TCCAFactory::NewParameterL()

    35  *   aParameter->SetConnectionFlag(ENormal);

    36  *   aParameter->SetContactDataFlag(EContactId);

    37  *   aParameter->SetContactDataL(aString);

    38  *

    39  *   aParameter->SetLaunchedViewUid(aUid);

    40  *

    41  *  @endcode

    42  *

    43  *  @lib ccaclient

    44  *  @since S60 v5.0

    45  */

    46 class MCCAParameterstub:public MCCAParameter

    47     {

    48 

    49 public:

    50     static MCCAParameter* MCCAParameterstub::NewL();

    51     /**

    52      * Destroy this parameter entity and all its data.

    53      * @since S60 5.0

    54      */

    55      void Close() ;

    56 

    57     /**

    58      * Getter for the flags of connection.

    59      * @since S60 5.0

    60      * @return the flags.

    61      */

    62      MCCAParameter::TConnectionFlags ConnectionFlag() ;

    63 

    64     /**

    65      * Getter for the contact data flags.

    66      * @since S60 5.0

    67      * @return the flags.

    68      */

    69      MCCAParameter::TContactDataFlags ContactDataFlag() ;

    70 

    71     /**

    72      * Getter for the contact data.

    73      * @leave KErrArgument if data not set.

    74      * @since S60 5.0

    75      * @return the reference of contact data.

    76      */

    77      HBufC& ContactDataL() ;

    78 

    79     /**

    80      * Getter for the view uid.

    81      * @since S60 5.0

    82      * @return the Uid.

    83      */

    84      TUid LaunchedViewUid() ;

    85 

    86     /**

    87      * Getter for the version.

    88      * @since S60 5.0

    89      * @return the version.

    90      */

    91      TInt32 Version() ;

    92 

    93     /**

    94      * Setter for the flag of connection.

    95      *

    96      * @see TConnectionFlags

    97      * @since S60 5.0

    98      * @param aFlags: flags of connection

    99      */

   100      void

   101         SetConnectionFlag(const MCCAParameter::TConnectionFlags aConnectionFlags) ;

   102 

   103     /**

   104      * Setter for the contact data flag.

   105      *

   106      * @see TContactDataFlags

   107      * @since S60 5.0

   108      * @param aFlags: flags of connection

   109      */

   110      void

   111         SetContactDataFlag(const MCCAParameter::TContactDataFlags aContactDataFlags) ;

   112 

   113     /**

   114      * Setter for the contact data.

   115      * If you are using TContactDataFlags::EContactLink, the MVPbkContactLink

   116      * should be streamed with PackLC before given for this method.

   117      * Ownership is NOT transferred.

   118      * @see MVPbkContactLink from  phonebook.

   119      * @leave KErrNotFound if contact data flag is not

   120      *        set before calling this method.

   121      * @see MCCAParameter::SetContactDataFlags

   122      * @since S60 5.0

   123      * @param aContactData: given contact data.

   124      */

   125      void SetContactDataL(const TDesC& aContactData) ;

   126 

   127     /**

   128      * Setter for the launched view uid. Use this when there

   129      * is need to get a particular view opened first on launch of CCA.

   130      * If view uid is not set, CCA uses the default view.

   131      * NOT IMPLEMENTED YET!

   132      * @since S60 5.0

   133      * @param aContactData: given contact data.

   134      */

   135      void SetLaunchedViewUid(const TUid aUid) ;

   136 

   137     /**

   138      * Returns an extension point for this interface or NULL.

   139      * @param aExtensionUid Uid of extension

   140      * @return Extension point or NULL

   141      */

   142      TAny* CcaParameterExtension(

   143         TUid /*aExtensionUid*/ ) { return NULL; }

   144 

   145     };

   146 

   147 

   148 #endif /* S_MCCAPARAMETER_H_ */