1 /*

     2 * Copyright (c) 2006 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:   Contains CNcdSearchNodeFolderProxy class

    15 *

    16 */

    17 

    18 

    19 #ifndef C_NCD_SEARCH_NODE_FOLDER_PROXY

    20 #define C_NCD_SEARCH_NODE_FOLDER_PROXY

    21 

    22 

    23 #include <e32base.h>

    24 

    25 #include "ncdparentoftransparentnodeproxy.h"

    26 

    27 

    28 class MNcdLoadNodeOperationObserver;

    29 class CNcdNodeIdentifier;

    30 class CNcdLoadNodeOperationProxy;

    31 class CNcdNodeSkinProxy;

    32 class CNcdNodeSearch;

    33 class CNcdSearchFilter;

    34 

    35 

    36 /**

    37  *  Node folder contains other nodes that may also be containers.

    38  *

    39  *  @lib ?library

    40  *  @since S60 ?S60_version *** for example, S60 v3.0

    41  */

    42 class CNcdSearchNodeFolderProxy: public CNcdParentOfTransparentNodeProxy

    43     {

    44 

    45 public:

    46 

    47     /**

    48      * NewL

    49      *

    50      * @param aSession The session between the client proxy and the

    51      * corresponding server object.

    52      * @param aHandle The handle which identifies the server object

    53      * that this proxy uses.

    54      * @param aNodeManager The manager that creates the nodes and keeps

    55      * track of the existing nodes.

    56      * @param aOperationManager This manager is used to create operations

    57      * for the node.

    58      * @param aFavoriteManager This manager is used to add or remove favorite nodes.     

    59      * @return CNcdSearchNodeFolderProxy* Pointer to the created object 

    60      * of this class.

    61      */

    62     static CNcdSearchNodeFolderProxy* NewL( MCatalogsClientServer& aSession, 

    63                                       TInt aHandle,

    64                                       CNcdNodeManagerProxy& aNodeManager,

    65                                       CNcdOperationManagerProxy& aOperationManager,

    66                                       CNcdFavoriteManagerProxy& aFavoriteManager );

    67 

    68     /**

    69      * NewL

    70      *

    71      * @param aSession The session between the client proxy and the

    72      * corresponding server object.

    73      * @param aHandle The handle which identifies the server object

    74      * that this proxy uses.

    75      * @param aNodeManager The manager that creates the nodes and keeps

    76      * track of the existing nodes.

    77      * @param aOperationManager This manager is used to create operations

    78      * for the node.

    79      * @param aFavoriteManager This manager is used to add or remove favorite nodes.

    80      * @return CNcdSearchNodeFolderProxy* Pointer to the created object 

    81      * of this class.

    82      */

    83     static CNcdSearchNodeFolderProxy* NewLC( MCatalogsClientServer& aSession, 

    84                                        TInt aHandle,

    85                                        CNcdNodeManagerProxy& aNodeManager,

    86                                        CNcdOperationManagerProxy& aOperationManager,

    87                                        CNcdFavoriteManagerProxy& aFavoriteManager );

    88 

    89 

    90     /**

    91      * Destructor

    92      *

    93      * @note Usually Release function should be used instead of

    94      * directly calling delete for this class object.

    95      *

    96      */

    97     virtual ~CNcdSearchNodeFolderProxy();

    98 

    99 

   100     /**

   101      * Getter for search filter.

   102      */

   103     const CNcdSearchFilter& SearchFilterL() const;

   104 

   105 protected: // CNcdNodeProxy

   106 

   107     /**

   108      * This function is called from the CNcdNodeProxy::InternalizeL

   109      *

   110      * @see CNcdNodeProxy::InternalizeNodeDataL

   111      */

   112     virtual void InternalizeNodeDataL( RReadStream& aStream );

   113 

   114 public: // MNcdNodeContainer

   115 

   116     /**

   117      * @see MNcdNodeContainer::LoadChildrenL

   118      */

   119     virtual MNcdLoadNodeOperation* LoadChildrenL( TInt aIndex, 

   120                                                   TInt aSize,

   121                                                   TNcdChildLoadMode aMode,

   122                                                   MNcdLoadNodeOperationObserver& aObserver );

   123 

   124 public: // MNcdNode 

   125 

   126     /**

   127      * @see MNcdNode::State

   128      */

   129     virtual TState State() const;

   130     

   131     /**

   132      * @see MNcdNode::LoadL

   133      */

   134     virtual MNcdLoadNodeOperation* LoadL( MNcdLoadNodeOperationObserver& aObserver );

   135                                        

   136 protected:

   137 

   138     /**

   139      * Constructor

   140      *

   141      * @param aSession The session between the client proxy and the

   142      * corresponding server object.

   143      * @param aHandle The handle which identifies the server object

   144      * that this proxy uses.

   145      * @param aNodeManager The manager that creates the nodes and keeps

   146      * track of the existing nodes.

   147      * @param aOperationManager This manager is used to create operations

   148      * for the node.

   149      * @param aFavoriteManager This manager is used to add or remove favorite nodes.     

   150      */

   151     CNcdSearchNodeFolderProxy( MCatalogsClientServer& aSession,

   152                          TInt aHandle,

   153                          CNcdNodeManagerProxy& aNodeManager,

   154                          CNcdOperationManagerProxy& aOperationManager,

   155                          CNcdFavoriteManagerProxy& aFavoriteManager );

   156 

   157     /**

   158      * ConstructL

   159      */

   160     virtual void ConstructL();

   161 

   162 

   163 private:

   164     // Prevent if not implemented

   165     CNcdSearchNodeFolderProxy( const CNcdSearchNodeFolderProxy& aObject );

   166     CNcdSearchNodeFolderProxy& operator =( const CNcdSearchNodeFolderProxy& aObject );

   167 

   168 protected:

   169     

   170     CNcdSearchFilter* iSearchFilter;

   171     };

   172 

   173 

   174 #endif // C_NCD_SEARCH_NODE_FOLDER_PROXY