idlefw/inc/framework/aicpsexecuteparam.h
branchRCL_3
changeset 14 15e4dd19031c
child 15 a0713522ab97
equal deleted inserted replaced
12:502e5d91ad42 14:15e4dd19031c
       
     1 /*
       
     2 * Copyright (c) 2010 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: CPS Execute parameter 
       
    15  *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef AICPSEXECUTEPARAM_H
       
    20 #define AICPSEXECUTEPARAM_H
       
    21 
       
    22 // System includes
       
    23 #include <e32base.h>
       
    24 
       
    25 // User includes
       
    26 
       
    27 // Forward declarations
       
    28 class CLiwGenericParamList;
       
    29 // Constants
       
    30 
       
    31 /**
       
    32  * CPS Execute Command Parameter 
       
    33  *
       
    34  * @since S60 5.2
       
    35  */
       
    36 
       
    37 /**
       
    38  * Holds parameters to execute the CPS excute command 
       
    39  * 
       
    40  * @since S60 5.2
       
    41  */
       
    42 NONSHARABLE_CLASS( CAiCpsExecuteParam ) : public CBase
       
    43     {
       
    44 public:
       
    45     // constructors and destructor
       
    46 
       
    47     /**
       
    48     * Two-phased constructors.
       
    49     */
       
    50     static CAiCpsExecuteParam* NewL( );
       
    51     static CAiCpsExecuteParam* NewLC();
       
    52 
       
    53     /**
       
    54     * Destructor.
       
    55     */
       
    56     ~CAiCpsExecuteParam();
       
    57 
       
    58 private:
       
    59     // constructors
       
    60     
       
    61     /**
       
    62      * C++ default constructor
       
    63      */
       
    64     CAiCpsExecuteParam();
       
    65 
       
    66     /**
       
    67      * 2nd phase constructor
       
    68      */
       
    69     void ConstructL( );    
       
    70 
       
    71 public:
       
    72     // new functions
       
    73         
       
    74     /**
       
    75     * Gets plugin id
       
    76     * 
       
    77     * @since S60 5.2
       
    78     * @return plugin id
       
    79     */
       
    80     const TDesC& PluginId() const;
       
    81     
       
    82     /**
       
    83     * Returns the input parameter list for Execute command
       
    84     * it will leave the CLiwGenericParamList object in the stack
       
    85     * 
       
    86     * @since S60 5.2
       
    87     * @return generic parameter list 
       
    88     */    
       
    89     CLiwGenericParamList* InParamListLC();
       
    90    
       
    91     /**
       
    92     * Adds a actions to the action list  
       
    93     * 
       
    94     * @since S60 5.2
       
    95     * @param aAction actions to add
       
    96     */        
       
    97     void AddActionL(const TDesC8& aAction);   
       
    98     
       
    99     /**
       
   100     * Sets the filter values
       
   101     * This method always over write the previous filters vlaues.  
       
   102     * 
       
   103     * @since S60 5.2
       
   104     * @param aMap filter map
       
   105     */
       
   106     void SetFilterL(CLiwDefaultMap* aMap);
       
   107     
       
   108     /**
       
   109     * Sets Registry type
       
   110     * This method always over write the previous retgistry type.  
       
   111     * 
       
   112     * @since S60 5.2
       
   113     * @param aRegistryType type of cps registry
       
   114     */
       
   115     void SetRegistryTypeL(const TDesC& aRegistryType);
       
   116     
       
   117     /**
       
   118     * Sets the plugin id  
       
   119     * This method always over write the previous plugin id.
       
   120     *  
       
   121     * @since S60 5.2
       
   122     * @param aPluginId actions to add
       
   123     */
       
   124     void SetPluginIdL(const TDesC& aPluginId);
       
   125 
       
   126 private:
       
   127     // data
       
   128     /** Plugin Id, owned.*/
       
   129     HBufC* iPluginId;
       
   130     /** Registry type, owned. */
       
   131     HBufC* iRegistryType;
       
   132     /** Filters, owned.*/
       
   133     HBufC* iPublisher;
       
   134     HBufC* iContentType;
       
   135     HBufC* iContentId;
       
   136     
       
   137     /** action trigger list, owned.  */
       
   138     RPointerArray<HBufC8> iActions;
       
   139     };
       
   140 
       
   141 #endif /* AICPSEXECUTEPARAM_H */