1 /*

     2 * Copyright (c) 2007 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:  Command iterator API definition.

    15 *

    16 */

    17 

    18 

    19 #ifndef M_VTUICOMMANDITERATOR_H

    20 #define M_VTUICOMMANDITERATOR_H

    21 

    22 #include <e32base.h>

    23 

    24 /**

    25  *  MVtUiCommandIterator

    26  *

    27  *  API for iterating through set of commands.

    28  *

    29  *  @since S60 v3.2

    30  */

    31 class MVtUiCommandIterator

    32     {

    33 

    34 public:

    35 

    36     /**

    37      * Returns ETrue if the iteration has more elements

    38      *

    39      * @return ETrue if iteration contains more commands (i.e. call to Next()

    40      * will return a valid command), EFalse otherwise.

    41      */

    42     virtual TBool HasNext() const = 0;

    43 

    44     /**

    45      * Returns the next command in the iteration.

    46      *

    47      * @return Next command in the iteration.

    48      */

    49     virtual TInt Next() = 0;

    50 

    51     };

    52 

    53 #endif // M_VTUICOMMANDITERATOR_H