1 /*

     2 * Copyright (c) 2007-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:  MCFPlugInOperation interface.

    15 *

    16 */

    17 

    18 

    19 

    20 #ifndef M_CFPLUGINOPERATION_H

    21 #define M_CFPLUGINOPERATION_H

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 

    26 

    27 // FORWARD DECLARATIONS

    28 class CCFOperationNode;

    29 class CCFScriptRoot;

    30 class MCFOperationServices;

    31 class CMDXMLNode;

    32 

    33 // CLASS DECLARATION

    34 

    35 /**

    36 *  This is a plugin operation interface for Script Engine scripts. Parsing

    37 *  operations will be executed via this interface.

    38 *

    39 *  @lib CFScriptEngine

    40 *  @since S60 v5.0

    41 */

    42 class MCFPlugInOperation

    43     {

    44 public: // New functions

    45 

    46     /**

    47     * Parses a xml node and returns a pointer to CCFOperationNode instance.

    48     * @since S60 5.0

    49     * @param aParent is the parsed parent node for the aNode.

    50     * @param aNode is the node to be parsed.

    51     * @param aOperationServices is the operation services reference to be used

    52     *   by the new operation node.

    53     * @param aUid Implementation uid of the provider.

    54     * @return a ptr to CCFOperationNode instance parsed from the given node,

    55     *   note that the ownership is transferred to the caller. Returns NULL if

    56     *   the node cannot be parsed.

    57     */

    58     virtual CCFOperationNode* ParseL( CCFOperationNode* aParent,

    59             CMDXMLNode& aNode,

    60             MCFOperationServices& aOperationServices,

    61             TUid& aUid ) = 0;

    62 

    63     /**

    64     * Parses a xml node and returns a pointer to CCFScriptRoot instance.

    65     * @since S60 5.0

    66     * @param aParent is the parsed parent node for the aNode.

    67     * @param aNode is the node to be parsed.

    68     * @param aOperationServices is the operation services reference to be used

    69     *   by the new script root node.

    70     * @param aUid Implementation uid of the provider.

    71     * @return a ptr to CCFScriptRoot instance parsed from the given node,

    72     *   note that the ownership is transferred to the caller. Returns NULL if

    73     *   the node cannot be parsed.

    74     */

    75     virtual CCFScriptRoot* ParseScriptRootL( CCFOperationNode* aParent,

    76             CMDXMLNode& aNode,

    77             MCFOperationServices& aOperationServices,

    78             TUid& aUid ) = 0;

    79 

    80 

    81 protected: // Destructor

    82 

    83     // Deny destruction through this interface.

    84     virtual ~MCFPlugInOperation(){};

    85 

    86     };

    87 

    88 

    89 #endif // M_CFPLUGINOPERATION_H