ncdengine/provider/client/inc/ncdrootnodeproxy.h
changeset 0 ba25891c3a9e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ncdengine/provider/client/inc/ncdrootnodeproxy.h	Thu Dec 17 08:51:10 2009 +0200
@@ -0,0 +1,183 @@
+/*
+* Copyright (c) 2006 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:   Contains CNcdRootNodeProxy class
+*
+*/
+
+
+#ifndef C_NCD_ROOT_NODE_PROXY
+#define C_NCD_ROOT_NODE_PROXY
+
+
+#include <e32base.h>
+
+#include "ncdparentoftransparentnodeproxy.h"
+
+
+class MNcdLoadNodeOperationObserver;
+class CNcdNodeIdentifier;
+
+
+/**
+ *  Node folder contains other nodes that may also be containers.
+ *  Root may also contain children of the transparent child folder.
+ *
+ *  @lib ?library
+ *  @since S60 ?S60_version *** for example, S60 v3.0
+ */
+class CNcdRootNodeProxy: public CNcdParentOfTransparentNodeProxy 
+    {
+
+public:
+
+    /**
+     * NewL
+     *
+     * @param aSession The session between the client proxy and the
+     * corresponding server object.
+     * @param aHandle The handle which identifies the server object
+     * that this proxy uses.
+     * @param aNodeManager The manager that creates the nodes and keeps
+     * track of the existing nodes.
+     * @param aOperationManager This manager is used to create operations
+     * for the node.
+     * @param aFavoriteManager This manager is used to add or remove favorite nodes.
+     * @return CNcdRootNodeProxy* Pointer to the created object 
+     * of this class.
+     */
+    static CNcdRootNodeProxy* NewL( MCatalogsClientServer& aSession, 
+                                    TInt aHandle,
+                                    CNcdNodeManagerProxy& aNodeManager,
+                                    CNcdOperationManagerProxy& aOperationManager,
+                                    CNcdFavoriteManagerProxy& aFavoriteManager );
+
+    /**
+     * NewL
+     *
+     * @param aSession The session between the client proxy and the
+     * corresponding server object.
+     * @param aHandle The handle which identifies the server object
+     * that this proxy uses.
+     * @param aNodeManager The manager that creates the nodes and keeps
+     * track of the existing nodes.
+     * @param aOperationManager This manager is used to create operations
+     * for the node.
+     * @param aFavoriteManager This manager is used to add or remove favorite nodes.
+     * @return CNcdRootNodeProxy* Pointer to the created object 
+     * of this class.
+     */
+    static CNcdRootNodeProxy* NewLC( MCatalogsClientServer& aSession, 
+                                     TInt aHandle,
+                                     CNcdNodeManagerProxy& aNodeManager,
+                                     CNcdOperationManagerProxy& aOperationManager,
+                                     CNcdFavoriteManagerProxy& aFavoriteManager );        
+
+
+    /**
+     * Destructor
+     *
+     * @note Usually Release function should be used instead of
+     * directly calling delete for this class object.
+     *
+     */
+    virtual ~CNcdRootNodeProxy();
+
+
+public: // MNcdNodeContainer
+
+    /**
+     * @see MNcdNodeContainer::ChildCount
+     */
+    virtual TInt ChildCount() const;
+
+    /**
+     * @see MNcdNodeContainer:: ChildL
+     */
+    virtual MNcdNode* ChildL( TInt aIndex );
+
+    /**
+     * @see MNcdNodeContainer::LoadChildrenL
+     */
+    virtual MNcdLoadNodeOperation* LoadChildrenL( TInt aIndex, 
+                                                  TInt aSize,
+                                                  TNcdChildLoadMode aMode,
+                                                  MNcdLoadNodeOperationObserver& aObserver );
+
+
+public: // CNcdNodeProxy
+
+    /**
+     * @see CNcdNodeProxy::State
+     */
+    virtual TState State() const;
+
+    /**
+     * @see CNcdNodeProxy::LoadL
+     */
+    virtual MNcdLoadNodeOperation* LoadL( MNcdLoadNodeOperationObserver& aObserver );
+
+    /**
+     * @see CNcdNodeProxy::OperationsL
+     */
+    virtual RCatalogsArray< MNcdOperation > OperationsL() const;
+
+
+public:// MNcdLoadNodeOperationObserver
+
+    /**
+     * @see MNcdLoadNodeOperationObserver::OperationComplete
+     * Calls the internalize function to update the node data.
+     */
+    virtual void OperationComplete( MNcdLoadNodeOperation& aOperation,
+                                    TInt aError );
+            
+protected:
+
+    /**
+     * Constructor
+     *
+     * @param aSession The session between the client proxy and the
+     * corresponding server object.
+     * @param aHandle The handle which identifies the server object
+     * that this proxy uses.
+     * @param aNodeManager The manager that creates the nodes and keeps
+     * track of the existing nodes.
+     * @param aOperationManager This manager is used to create operations
+     * for the node.
+     * @param aFavoriteManager This manager is used to add or remove favorite nodes.
+     */
+    CNcdRootNodeProxy( MCatalogsClientServer& aSession,
+                       TInt aHandle,
+                       CNcdNodeManagerProxy& aNodeManager,
+                       CNcdOperationManagerProxy& aOperationManager,
+                       CNcdFavoriteManagerProxy& aFavoriteManager );
+
+    /**
+     * ConstructL
+     */
+    virtual void ConstructL();
+
+
+private:
+    // Prevent if not implemented
+    CNcdRootNodeProxy( const CNcdRootNodeProxy& aObject );
+    CNcdRootNodeProxy& operator =( const CNcdRootNodeProxy& aObject );
+
+
+private: // data
+
+    };
+
+
+#endif // C_NCD_ROOT_NODE_PROXY