1 /*

     2 * Copyright (c) 2005-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 the License "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:  Base class for scan list iterators

    15 *

    16 */

    17 

    18 

    19 #ifndef ABS_CORE_SCAN_LIST_ITERATOR_H

    20 #define ABS_CORE_SCAN_LIST_ITERATOR_H

    21 

    22 #include "core_types.h"

    23 

    24 class core_ap_data_c;

    25 

    26 /**

    27  * This class acts as the abstract base class for the iterators. 

    28  */

    29 NONSHARABLE_CLASS( abs_core_scan_list_iterator_c )

    30     {

    31 

    32 public:

    33 

    34     /**

    35      * Destructor.

    36      */

    37     virtual ~abs_core_scan_list_iterator_c() {};

    38 

    39     /**

    40      * Return the first entry in the list that matches the iterator type.

    41      *

    42      * @since S60 v3.1

    43      * @return NULL if the list empty, pointer to the first entry otherwise.

    44      * @note This method will reset the internal iterator.

    45      */

    46     virtual core_ap_data_c* first() = 0;

    47 

    48     /**

    49      * Return the next entry in the list.

    50      *

    51      * @since S60 v3.1

    52      * @return NULL if the current entry is the last one,

    53      *         pointer to the next entry otherwise.

    54      */

    55     virtual core_ap_data_c* next() = 0;

    56 

    57     /**

    58      * Return the current entry in the list.

    59      *

    60      * @since S60 v3.1

    61      * @return pointer to the current entry.

    62      */

    63     virtual core_ap_data_c* current() = 0;

    64 

    65     };

    66 

    67 #endif // ABS_CORE_SCAN_LIST_ITERATOR_H