ncdengine/inc/ncdnodechildoftransparent.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     1 /*
       
     2 * Copyright (c) 2006-2008 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 MNcdNodeChildOfTransparent interface
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef M_NCD_NODE_CHILD_OF_TRANSPARENT_H
       
    20 #define M_NCD_NODE_CHILD_OF_TRANSPARENT_H
       
    21 
       
    22 
       
    23 #include <e32cmn.h>
       
    24 
       
    25 #include "catalogsbase.h"
       
    26 #include "ncdinterfaceids.h"
       
    27 
       
    28 
       
    29 class MNcdNode;
       
    30 
       
    31 /**
       
    32  * This interface provides function to obtain the transparent parent of
       
    33  * a child of a transparent node. Transparent nodes are not normally
       
    34  * present in proxy side.
       
    35  *
       
    36  * This interface can be queried from node objects that are direct children of
       
    37  * transparent nodes.
       
    38  *
       
    39  * 
       
    40  */
       
    41 class MNcdNodeChildOfTransparent : public virtual MCatalogsBase
       
    42     {
       
    43 
       
    44 public:
       
    45 
       
    46     /**
       
    47      * Unique identifier for the interface, required for all MCatalogsBase interfaces.
       
    48      *
       
    49      * 
       
    50      */
       
    51     enum { KInterfaceUid = ENcdNodeChildOfTransparentUid };
       
    52     
       
    53     /**
       
    54      * Returns the transparent parent of the node, or NULL if the parent
       
    55      * is not found from cache.
       
    56      *
       
    57      * @return The parent.
       
    58      * @leave System wide error code.
       
    59      */
       
    60     virtual MNcdNode* TransparentParentL() const = 0;
       
    61 
       
    62 protected:
       
    63 
       
    64     /**
       
    65     * Destructor.
       
    66     *
       
    67     * @see MCatalogsBase::~MCatalogsBase
       
    68     */
       
    69     virtual ~MNcdNodeChildOfTransparent() {}
       
    70 
       
    71     };
       
    72 
       
    73 
       
    74 #endif // M_NCD_NODE_CHILD_OF_TRANSPARENT_H