|
1 /* |
|
2 * Copyright (c) 2002-2004 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: Iterates over a containers children |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef MXNCHILDITERATOR_H |
|
19 #define MXNCHILDITERATOR_H |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32base.h> |
|
23 |
|
24 /** |
|
25 * @ingroup group_xnutils |
|
26 * |
|
27 * Iterates over a containers children |
|
28 * @since Series 60 3.1 |
|
29 */ |
|
30 class MXnChildIterator |
|
31 { |
|
32 public: // Constructors and destructor |
|
33 |
|
34 /** |
|
35 * Destructor. |
|
36 */ |
|
37 virtual ~MXnChildIterator() {}; |
|
38 |
|
39 public: // New functions |
|
40 |
|
41 /** |
|
42 * Get the current iterator value. |
|
43 * @since Series 60 3.1 |
|
44 * @return Current object or NULL if iterator does not point anywhere |
|
45 */ |
|
46 virtual CBase* Value() = 0 ; |
|
47 |
|
48 /** |
|
49 * Get the next iterator value. |
|
50 * @since Series 60 3.1 |
|
51 * @return Next object or NULL if no more values. If NULL, the iterator is not advanced. |
|
52 * Therefore, given that iterator->Value() == x and iterator->Next() == NULL, next invocation |
|
53 * of iterator->Value() will return x. |
|
54 */ |
|
55 virtual CBase* NextL() = 0; |
|
56 |
|
57 /** |
|
58 * Get the previous iterator value. |
|
59 * @since Series 60 3.1 |
|
60 * @return Previous object or NULL if no more values. If NULL, the iterator is not advanced. |
|
61 * Therefore, given that iterator->Value() == x and iterator->Previous() == NULL, next invocation |
|
62 * of iterator->Value() will return x. |
|
63 */ |
|
64 virtual CBase* PreviousL() = 0; |
|
65 |
|
66 /** |
|
67 * Get the current iterator index. |
|
68 * @since Series 60 3.1 |
|
69 * @return Current index |
|
70 */ |
|
71 virtual TUint Index() const = 0; |
|
72 |
|
73 }; |
|
74 |
|
75 #endif // MXnCHILDITERATOR_H |
|
76 |
|
77 // End of File |