contextframework/cfw/inc/basicoperationsplugin/cfnotifyaction.h
changeset 0 2e3d3ce01487
equal deleted inserted replaced
-1:000000000000 0:2e3d3ce01487
       
     1 /*
       
     2 * Copyright (c) 2004-2008 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:  CCFNotifyAction class declaration.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef C_CFNOTIFYACTION_H
       
    21 #define C_CFNOTIFYACTION_H
       
    22 
       
    23 // INCLUDES
       
    24 #include <e32base.h>
       
    25 #include <e32std.h>
       
    26 
       
    27 #include "cfscriptaction.h"
       
    28 
       
    29 // FORWARD DECLARATIONS
       
    30 class MCFOperationServices;
       
    31 class CCFKeyValuePair;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36 *   Implements notification action.
       
    37 *   Instance of this class is created for every notifyScript action in scripts.
       
    38 *
       
    39 *  @lib BasicOperationsPlugIn
       
    40 *  @since Series 60 5.0
       
    41 */
       
    42 NONSHARABLE_CLASS( CCFNotifyAction ): public CCFScriptAction
       
    43     {
       
    44 public: // Constructors and destructor
       
    45 
       
    46     /**
       
    47     * Creates a new CCFNotifyAction.
       
    48     * @param aServices is a reference to script operation services.
       
    49     * @param aActionId is the action identifier.
       
    50     * @param aParameters contains the action parameters.
       
    51     */
       
    52     static CCFNotifyAction* NewL( MCFOperationServices& aServices, 
       
    53             const TDesC& aActionId, 
       
    54             const RPointerArray< CCFKeyValuePair >& aParameters );
       
    55 
       
    56     /**
       
    57     * Creates a new CCFNotifyAction, leaves it into CleanupStack.
       
    58     * @param aServices is a reference to script operation services.
       
    59     * @param aActionId is the action identifier.
       
    60     * @param aParameters contains the action parameters.
       
    61     */
       
    62     static CCFNotifyAction* NewLC( MCFOperationServices& aServices, 
       
    63             const TDesC& aActionId, 
       
    64             const RPointerArray< CCFKeyValuePair >& aParameters );
       
    65 
       
    66     /**
       
    67     * Destructor.
       
    68     */
       
    69     ~CCFNotifyAction();
       
    70 
       
    71 public: // Functions from CCFScriptAction
       
    72 
       
    73     /**
       
    74     * Notifies the action handler about new action.
       
    75     * See CCFScriptAction::ActL
       
    76     */
       
    77     void ActL();
       
    78 
       
    79 	// See CCFScriptAction::GetSecurityPolicy
       
    80 	TInt GetSecurityPolicy( TSecurityPolicy& aPolicy );
       
    81 
       
    82 protected:
       
    83 
       
    84     /**
       
    85     * C++ default constructor.
       
    86     */
       
    87     CCFNotifyAction( MCFOperationServices& aServices );
       
    88 
       
    89     /**
       
    90     * By default Symbian 2nd phase constructor is private.
       
    91     */
       
    92     void ConstructL( const TDesC& aActionId,
       
    93             const RPointerArray< CCFKeyValuePair >& aParameters );
       
    94 
       
    95 private: // Data
       
    96 
       
    97     // Action parameters.
       
    98     RPointerArray< CCFKeyValuePair >    iParameters;
       
    99 
       
   100     // Action identifier.
       
   101     HBufC*                              iIdentifier;
       
   102     };
       
   103 
       
   104 #endif // C_CFNOTIFYACTION_H