ncdengine/inc/ncdinstalloperation.h
changeset 0 ba25891c3a9e
equal deleted inserted replaced
-1:000000000000 0:ba25891c3a9e
       
     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:   Install operation interface definition
       
    15 *
       
    16 */
       
    17 	
       
    18 
       
    19 #ifndef M_NCD_INSTALL_OPERATION_H
       
    20 #define M_NCD_INSTALL_OPERATION_H
       
    21 
       
    22 #include <e32cmn.h>
       
    23 
       
    24 #include "ncdoperation.h"
       
    25 #include "ncdinterfaceids.h"
       
    26 
       
    27 
       
    28 /**
       
    29  *  Install operation interface.
       
    30  *  
       
    31  *  Install operation handles the installing of an installable node.
       
    32  *  The operation installs one or more files in predefined order.
       
    33  *
       
    34  *  The install process is handled outside of Catalogs Engine, in the
       
    35  *  platform installer.
       
    36  *
       
    37  *  The platform installer has it's own ui, (which is initiated
       
    38  *  automatically) that gives the user more detailed progress information.
       
    39  *
       
    40  *  
       
    41  *  @see MNcdInstallOperationObserver
       
    42  *  @see MNcdNodeInstall
       
    43  */
       
    44 class MNcdInstallOperation : public MNcdOperation
       
    45     {
       
    46 
       
    47 public:
       
    48     
       
    49     /**
       
    50      * Unique identifier for the interface, required for all MCatalogsBase interfaces.
       
    51      *
       
    52      * 
       
    53      */
       
    54     enum { KInterfaceUid = ENcdInstallOperationUid };
       
    55     
       
    56     /**
       
    57      * Getter for file count. This is the total number of files this operation
       
    58      * is installing.
       
    59      *
       
    60      * 
       
    61      * @return Total number of files to be installed.
       
    62      */
       
    63     virtual TInt FileCount() = 0;
       
    64     
       
    65     /**
       
    66      * Getter for current file index. This is the index of the file that
       
    67      * is currently being installed.
       
    68      *
       
    69      * @return Number of the file currently being installed.
       
    70      */
       
    71     virtual TInt CurrentFile() = 0;
       
    72     
       
    73 protected:
       
    74 
       
    75     /**
       
    76     * Destructor.
       
    77     *
       
    78     * @see MCatalogsBase::~MCatalogsBase
       
    79     */
       
    80     virtual ~MNcdInstallOperation() {}
       
    81 
       
    82     };
       
    83 	
       
    84 	
       
    85 #endif //  M_NCD_INSTALL_OPERATION_H