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 MNcdNodeInstall interface

    15 *

    16 */

    17 

    18 

    19 #ifndef M_NCD_NODE_ACTIVATE_H

    20 #define M_NCD_NODE_ACTIVATE_H

    21 

    22 #include <f32file.h>

    23 #include <e32cmn.h>

    24 

    25 #include "catalogsbase.h"

    26 #include "ncdinterfaceids.h"

    27 

    28 

    29 /**

    30  *  Provides functionality for activating the content represented by the node.

    31  *  Well-defined only for simple nodes that contain exactly one activateable item,

    32  *  such as image (set as wallpaper), audio file (set as ringing tone) or theme.

    33  *  

    34  *  Before activating, the data should have been downloaded and installed.

    35  *  download interface.

    36  *

    37  *  @see MNcdNodeDownload

    38  *  @see MNcdNodeInstall

    39  *

    40  *  

    41  */

    42 class MNcdNodeActivate : public virtual MCatalogsBase

    43     {

    44 

    45 public:

    46 

    47     /**

    48      * Unique identifier for the interface, required for all MCatalogsBase interfaces.

    49      *

    50      * 

    51      */

    52     enum { KInterfaceUid = ENcdNodeActivateUid };

    53 

    54 

    55     /**

    56      * Activates the item represented by the node.

    57      *

    58      * For example, if the node holds a suitable image, it is set as wallpaper. If the

    59      * node holds a suitable audio file, it is set as ringing tone. If the node holds a

    60      * theme file, it is set as the current theme for the device.

    61      *

    62      * If the node has no content suitable for activation, it should not offer this

    63      * interface in the first place.

    64      * 

    65      * 

    66      * @exception Leave System wide error code.

    67      */

    68     virtual void ActivateL() = 0;

    69 

    70 protected:

    71 

    72     /**

    73      * Destructor.

    74      * 

    75      * @see MCatalogsBase::~MCatalogsBase()

    76      */

    77     virtual ~MNcdNodeActivate() {}

    78 

    79     };

    80 

    81 

    82 #endif // M_NCD_NODE_ACTIVATE_H