filemanager/Engine/inc/Mfilemanageritemiterator.h
branchRCL_3
changeset 20 491b3ed49290
parent 19 95243422089a
child 21 65326cf895ed
equal deleted inserted replaced
19:95243422089a 20:491b3ed49290
     1 /*
       
     2 * Copyright (c) 2002-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:  Interface to go through file(s) and folder(s) in copy and move
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MFILEMANAGERITEMITERATOR_H
       
    21 #define MFILEMANAGERITEMITERATOR_H
       
    22 
       
    23 // INCLUDES
       
    24 #include "FileManagerEngine.hrh"
       
    25 
       
    26 // CLASS DECLARATION
       
    27 /**
       
    28 *  Defines an interface for iterating file(s) and folder(s).
       
    29 *
       
    30 *  @since 2.0
       
    31 */
       
    32 class MFileManagerItemIterator 
       
    33 	{
       
    34 	public:
       
    35 
       
    36         /**
       
    37         * Gets the current processed item source and destination with full path
       
    38         * @since 2.0
       
    39         * @param aSrc Returns pointer to item source with full path
       
    40 		*		      if this parameter is null and aDst contains destination folder
       
    41 		*			  it means that destination is folder which should be created
       
    42         * @param aDst Returns pointer to item destination with full path
       
    43         */
       
    44         virtual void CurrentL(
       
    45             HBufC** aSrc,
       
    46             HBufC** aDst,
       
    47             TFileManagerTypeOfItem& aItemType ) = 0;
       
    48 		
       
    49         /**
       
    50         * Goes to next item
       
    51         * @since 2.0
       
    52         * @return ETrue if next item found, EFalse if end reached
       
    53         */
       
    54 		virtual TBool NextL() = 0;
       
    55 
       
    56         /**
       
    57         * Virtual desctructor
       
    58         * This is required because the ownership transfer does not work without
       
    59         */
       
    60 		virtual ~MFileManagerItemIterator() {}
       
    61 	};
       
    62 
       
    63 #endif // MFILEMANAGERITEMITERATOR_H