contextframework/cfw/inc/basicoperationsplugin/cfelseifclause.h
author Pat Downey <patd@symbian.org>
Tue, 18 May 2010 16:46:03 +0100
branchRCL_3
changeset 32 afba831adaf6
parent 0 2e3d3ce01487
permissions -rw-r--r--
Re-merge Symbian FOundation splash screen changes.

/*
* Copyright (c) 2004-2008 Nokia Corporation and/or its subsidiary(-ies). 
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  CCFElseIfClause class declaration.
*
*/



#ifndef C_CFELSEIFCLAUSE_H
#define C_CFELSEIFCLAUSE_H

// INCLUDES
#include <e32base.h>

#include "cfclausenode.h"

// CLASS DECLARATION

/**
*   This class implements ElseIfClause XML node of CFW script in Script Engine
*   scripts.
*
*  @lib CFScriptEngine
*  @since Series 60 2.6
*/
NONSHARABLE_CLASS( CCFElseIfClause ): public CCFClauseNode
    {
public: // Constructors and destructor

    /**
    * Creates a CCFElseIfClause object
    * @param aServices is the operation services interface for nodes.
    * @param aParent parent of this node or NULL if this is a root. The
    *   ownership of the parent is not transferred.
    * @return a pointer to the created instance of CCFElseIfClause
    */
    static CCFElseIfClause* NewL( MCFOperationServices& aServices,
            CCFOperationNode* aParent );

    /**
    * Creates a CCFElseIfClause object
    * @param aServices is the operation services interface for nodes.
    * @param aParent parent of this node or NULL if this is a root. The
    *   ownership of the parent is not transferred.
    * @return a pointer to the created instance of CCFElseIfClause
    */
    static CCFElseIfClause* NewLC( MCFOperationServices& aServices,
            CCFOperationNode* aParent );

    /**
    * Creates and parses a CCFElseIfClause instance from an xml node.
    * @param aServices is the operation services interface for nodes.
    * @param aParent is the parent of this node or NULL if this is a root. The
    *   ownership of the parent is not transferred.
    * @param aNode is the node to be parsed.
    * @return a pointer to the created instance of CCFElseIfClause, or NULL if
    *   the node is not else if clause node. May leave with any system wide
    *   error code.
    */
    static CCFElseIfClause* ParseL( MCFOperationServices& aServices,
            CCFOperationNode* aParent,
            CMDXMLNode& aNode );

    /**
    * Destructor.
    */
    ~CCFElseIfClause();

protected: // Functions from CCFClauseNode

    /**
    * Fires actions of the node.
    * @return None.
    */
    void FireActionsL();

protected: // Functions from CCFOperationNode

    /**
    * Activates this node by passing the activate call to its' child.
    * @return None.
    */
    void ActivateL();

    /**
    * Deactivates this node by passing the deactivate call to its' child.
    * @return None.
    */
    void Deactivate();

    /**
    * Asks this node to check its security (via services interface). Checks the
    * security of contexts to be subscribed and actions to be performed.
    * @return KErrNone if security check passed, otherwise any of the system
    *   wide error codes.
    */
    TInt CheckSecurity();

    /**
    * Called by child node, to ask the parent to re-evaluate its value,
    * since the child's value has changed.
    * @return None.
    */
    void Evaluate();

    /**
    * Cleanup long term resources like persistent data files.
    * This is called by the context framework when the script is uninstalled
    * from the system.
    */ 
    void Cleanup();

private:

    /**
    * C++ default constructor.
    */
   CCFElseIfClause( MCFOperationServices& aServices,
           CCFOperationNode* aParent );

    /**
    * By default Symbian 2nd phase constructor is private.
    */
    void ConstructL();

private: // Data

    // Must have one "root" operation, a child.
    CCFOperationNode* iChild;

    // ElseIf clause actions.
    RPointerArray< CCFScriptAction > iActions;
    };

#endif // C_CFELSEIFCLAUSE_H