/*

* Copyright (c) 2002-2004 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:

* Node of layout tree

*

*/

#ifndef XNNODE_H

#define XNNODE_H

// System includes

#include <e32base.h>

#include <w32std.h>

// User includes

// Forward declarations

class CXnType;

class CXnProperty;

class CXnNodeImpl;

class CXnViewsNodeImpl;

class CXnViewNodeImpl;

class CXnComponentNodeImpl;

class CXnUiEngine;

class CXnNodePluginIf;

class CXnNodeAppIf;

class CXnDomNode;

class CXnControlAdapter;

class CXnScrollableControlAdapter;

namespace XnComponentInterface

    {

    class MXnComponentInterface;

    }

// Constants

namespace XnDirtyLevel

    {

    /** Not dirty */

    const TInt ENone = 0;

    /** Draw node's appearance */

    const TInt ERender = 1;

    /** Layout and draw node's appearance */

    const TInt ELayoutAndRender = 2;

    /** Layout and draw node's and its siblings appearance */

    const TInt ELayoutAndRenderSiblings = 3;

    }

namespace XnNodeLayout

    {

    const TInt ENone = 0;

    const TInt EDropped = 1;

    const TInt ENotLayouted = 2;

    const TInt EDroppedAndNotLayouted = 3;

    }

namespace XnAdaptive

    {

    const TInt ENone = 0x00;

    const TInt EWidth = 0x01;

    const TInt EHeight = 0x02;

    const TInt EMeasure = 0x04;

    const TInt ESizeFixed = 0x08;

    const TInt EIgnoreDirty = 0x10;

    }

namespace XnEventSource

    {

    const TInt EUnknown = 0x00;

    const TInt EStylus = 0x01;

    const TInt EKey = 0x02;

    }

namespace XnHoldProperty

    {

    const TInt ENoHold = 0x00;

    const TInt EHold = 0x01;

    }

// Class declaration

/**

 * Node of the layout tree

 *

 * @ingroup group_xnlayoutengine

 * @lib xnlayoutengine.lib

 * @since Series 60 3.1

 */

NONSHARABLE_CLASS( CXnNode ) : public CBase

    {

public:

    /**

     * Two-phased constructor.

     */

    static CXnNode* NewL();

    /**

     * Destructor.

     */

    virtual ~CXnNode();

public:

    // New functions

    /**

     * Get the node implementation

     *

     * @since Series 60 3.1

     * @return Node implementation

     */

    CXnNodeImpl* Impl();

    /**

     * Get the root node implementation

     *

     * @since Series 60 3.1

     * @return Root node implementation

     */

    CXnNodeImpl* RootNodeImpl();

    /**

     * Get the view node implementation

     *

     * @since Series 60 3.1

     * @return View node implementation

     */

    CXnViewNodeImpl* ViewNodeImpl();

    /**

     * Get the component node implementation

     *

     * @since Series 60 3.1

     * @return Component node implementation

     */

    CXnComponentNodeImpl* ComponentNodeImpl();

    /**

     * Set UI engine

     *

     * @since Series 60 3.1

     * @param aEngine UI engine

     */

    void SetUiEngine( CXnUiEngine& aEngine );

    /**

     * Get the UI engine

     *

     * @since Series 60 3.1

     * @return UI engine

     */

    CXnUiEngine* UiEngine();

    /**

     * Set the node implementation

     *

     * @since Series 60 3.1

     * @param aImpl Node implementation

     */

    void SetImpl( CXnNodeImpl* aImpl );

    /**

     * Set the Root node implementation

     *

     * @since Series 60 3.1

     * @param aRootNodeImpl Root node implementation

     */

    void SetRootNodeImpl( CXnNodeImpl* aRootNodeImpl );

    /**

     * Set the views implementation

     *

     * @since Series 60 3.1

     * @param aViewsNodeImpl Views node implementation

     */

    void SetViewsNodeImpl( CXnViewsNodeImpl* aViewsNodeImpl );

    /**

     * Set the view node implementation

     *

     * @since Series 60 3.1

     * @param aViewNodeImpl View node implementation

     */

    void SetViewNodeImpl( CXnViewNodeImpl* aViewNodeImpl );

    /**

     * Handle interaction events

     *

     * @since Series 60 3.1

     * @param aEventData Event data

     * @param aSource A source of event, e.g. XnEventSource::EStylus.

     * @return Flag indicating whether the event was consumed

     */

    TBool ReportXuikonEventL( CXnNode& aEventData, TInt aSource = 0 );

    /**

     * Handle key event

     *

     * @since Series 60 3.1

     * @param aKeyEvent Key event data

     * @param aType Event type

     */

    void OfferKeyEventL( const TKeyEvent& aKeyEvent, TEventCode aType );

    /**

     * Set the component node implementation

     *

     * @since Series 60 3.1

     * @param aComponentNodeImpl Component node implementation

     */

    void SetComponentNodeImpl( CXnComponentNodeImpl* aComponentNodeImpl );

    /**

     * Set node's layout capability

     *

     * @since Series 60 3.1

     * @param aLayoutCapable Layout capability

     */

    void SetLayoutCapable( const TBool aLayoutCapable );

    /**

     * Get node's layout capability

     *

     * @since Series 60 3.1

     * @return Layout capability

     */

    TBool IsLayoutCapable() const;

    /**

     * Set the node's characted data

     *

     * @since Series 60 3.1

     * @param aData Character data

     */

    void SetPCDataL( const TDesC8& aData );

    /**

     * Get the node's characted data

     *

     * @since Series 60 3.1

     * @return Character data

     */

    const TDesC8& GetPCData() const;

    /**

     * Set a property.

     *

     * The list will assume ownership of the property.

     * If an equal property is already in the list, it will be

     * replaced with the new property and the old property will be destroyed.

     * @since Series 60 3.1

     * @param aProperty Property to set.

     */

    void SetPropertyL( CXnProperty* aProperty );

    /**

     * Set a property without notification being sent.

     *

     * @see SetPropertyL

     * @param aProperty Property to set.

     */

    void SetPropertyWithoutNotificationL( CXnProperty* aProperty );

    /**

     * Set a property NOT replacing an equal property if already in the list.

     *

     * @see SetPropertyL

     * @param aProperty Property to set.

     */

    void InitializePropertyL( CXnProperty* aProperty );

    /**

     * Set an array of properties.

     *

     * Improves the performance when many properties need to be

     * set e.g. in construction phase.

     * The list will assume ownership of the property.

     * If an equal property is already in the list, it will be

     * replaced with the new property and the old property will be destroyed.

     * @see SetPropertyL

     */

    void SetPropertyArrayL( RPointerArray< CXnProperty >* aPropertyArray );

    /**

     * Gets a property.

     *

     * The list will retain ownership of the property,

     * the caller must not destroy the property. The returned pointer will

     * become invalid if the property is replaced in the list by a subsequent

     * SetL().

     * @since Series 60 3.1

     * @param aKey Name of the property

     * @return The property mapped to the key or NULL if not found.

     */

    CXnProperty* GetPropertyL( const TDesC8& aKey ) const;

    /**

     * Set a state

     *

     * @since Series 60 3.1

     * @param aState State to set.

     * @param aSource A source of the event.

     */

    void SetStateL(

        const TDesC8& aState,

        TInt aSource = XnEventSource::EUnknown );        

    /**

     * Check whether a state is set

     *

     * @since Series 60 3.1

     * @return ETrue if set, EFalse if not

     */

    TBool IsStateSet( const TDesC8& aState );

    /**

     * Set a state without performing notifications and re-rendering

     *

     * @since Series 60 3.1

     * @param aState State to set

     */

    void SetStateWithoutNotificationL( const TDesC8& aState );

    /**

     * Unset a state

     *

     * @since Series 60 3.1

     * @param aState State to unset.

     */

    void UnsetStateL( const TDesC8& aState );

    /**

     * Get node type

     *

     * @since Series 60 3.1

     * @return Node type

     */

    CXnType* Type();

    /**

     * Set node's content rect

     *

     * @since Series 60 3.1

     * @param aRect Content rect

     */

    void SetRect( const TRect& aRect );

    /**

     * Get node's content rect

     *

     * @since Series 60 3.1

     * @return Content rect

     */

    TRect Rect();

    /**

     * Set node's border rect

     *

     * @since Series 60 3.1

     * @param aRect Border rect

     */

    void SetBorderRect( const TRect& aRect );

    /**

     * Get node's border rect

     *

     * @since Series 60 3.1

     * @return Border rect

     */

    TRect BorderRect();

    /**

     * Set normal flow border rect

     *

     * @since Series 60 3.1

     * @param aRect border rect

     */

    void SetNormalFlowBorderRect( const TRect& aRect );

    /**

     * Get normal flow border rect

     *

     * @since Series 60 3.1

     * @return Border rect

     */

    TRect NormalFlowBorderRect();

    /**

     * Set node's margin rect

     *

     * @since Series 60 3.1

     * @param aRect Margin rect

     */

    void SetMarginRect( const TRect& aRect );

    /**

     * Get node's margin rect

     *

     * @since Series 60 3.1

     * @return Margin rect

     */

    TRect MarginRect();

    /**

     * Set node's padding rect

     *

     * @since Series 60 3.1

     * @param aRect Padding rect

     */

    void SetPaddingRect( const TRect& aRect );

    /**

     * Get node's padding rect

     *

     * @since Series 60 3.1

     * @return Padding rect

     */

    TRect PaddingRect();

    /**

     * Returns the parent. The ownership is not transferred.

     *

     * @since Series 60 3.1

     * @return The parent area, NULL if not set.

     */

    CXnNode* Parent() const;

    /**

     * Sets the parent.

     *

     * @since Series 60 3.1

     * @param aParent Parent area

     */

    void SetParent( CXnNode& aParent );

    /**

     * Adds a child node under this node. Assumes ownership of the node.

     *

     * @since Series 60 3.1

     * @param aChild Child to be added

     * @exception KXnErrAddChildToAreaFailed Adding child failed.

     */

    void AddChildL( CXnNode* aChild );

    /**

     * Get the child nodes

     *

     * @since Series 60 3.1

     * @return Child nodes

     */

    RPointerArray< CXnNode >& Children();

    /**

     * Set whether the node is dropped from layout

     *

     * @since Series 60 3.1

     * @param aDropped Flag indicating whether the node is dropped from layout

     */

    void SetDropped( const TInt aDropped );

    /**

     * Get whether the node is dropped from layout

     *

     * @since Series 60 3.1

     * @return Flag indicating whether the node is dropped from layout

     */

    TInt IsDropped() const;

    /**

     * Set node rendered, which means it will not be rendered again until

     * its properties, states or rects change

     *

     * @since Series 60 3.1

     */

    void SetRenderedL();

    /**

     * Set node laid out, which means it will not be laid out again until

     * its properties, states or rects change

     *

     * @since Series 60 3.1

     */

    void SetLaidOutL();

    /**

     * Get layout state

     *

     * @since Series 60 3.1

     * @return Layout state

     */

    TBool IsLaidOut() const;

    /**

     * Set node not rendered and not laid out

     *

     * @since Series 60 3.1

     */

    void ClearRenderedAndLaidOut();

    /**

     * Get node plugin interface

     *

     * @since Series 60 3.1

     * @return Node plugin interface

     */

    CXnNodePluginIf& PluginIfL();

    /**

     * Get node application interface

     *

     * @since Series 60 3.1

     * @return Node application interface

     */

    CXnNodeAppIf& AppIfL();

    /**

     * Create a component interface according to the given type.

     *

     * @param aType Type of the interface to create

     * @return Created interface or NULL if the provided type is not supported.