|
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: Defines an interface for GFLM clients to access item groups |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MGFLMITEMGROUP_H |
|
21 #define MGFLMITEMGROUP_H |
|
22 |
|
23 |
|
24 // INCLUDES |
|
25 #include "GFLM.hrh" |
|
26 #include <e32std.h> |
|
27 |
|
28 |
|
29 // FORWARD DECLARATIONS |
|
30 class CGflmGroupItem; |
|
31 |
|
32 |
|
33 // CLASS DECLARATION |
|
34 |
|
35 /** |
|
36 * Defines an interface for GFLM clients to access item groups |
|
37 * |
|
38 * @lib GFLM.lib |
|
39 * @since 2.0 |
|
40 */ |
|
41 class MGflmItemGroup |
|
42 { |
|
43 public: // New functions |
|
44 |
|
45 /** |
|
46 * Returns the Id of the group |
|
47 * @since 2.0 |
|
48 * @return Id of the group |
|
49 */ |
|
50 virtual TInt Id() const = 0; |
|
51 |
|
52 /** |
|
53 * Returns the number of items in the group |
|
54 * @since 2.0 |
|
55 * @return Number of items in the group |
|
56 */ |
|
57 virtual TInt ItemCount() const = 0; |
|
58 |
|
59 /** |
|
60 * Returns a pointer to a specific item in the group by its index |
|
61 * @since 2.0 |
|
62 * @param aIndex Index of the requested CGflmGroupItem object |
|
63 * @return Pointer to a CGflmGroupItem object |
|
64 */ |
|
65 virtual CGflmGroupItem* Item( TInt aIndex ) = 0; |
|
66 |
|
67 /** |
|
68 * Adds a new filesystem source to the group |
|
69 * @since 2.0 |
|
70 * @param aDirectory Path of the directory to add to the group |
|
71 */ |
|
72 virtual void AddSourceL( const TDesC& aDirectory ) = 0; |
|
73 |
|
74 /** |
|
75 * Resets the list of filesystem sources |
|
76 * @since 2.0 |
|
77 */ |
|
78 virtual void ResetSources() = 0; |
|
79 |
|
80 /** |
|
81 * Adds a new action item to the group |
|
82 * @since 2.0 |
|
83 * @param aId Id of the new action item |
|
84 * @param aCaption Caption of the new action item |
|
85 */ |
|
86 virtual void AddActionItemL( TInt aId, const TDesC& aCaption ) = 0; |
|
87 |
|
88 /** |
|
89 * Sets the inclusion mode (files/directories) of the group |
|
90 * @since 2.0 |
|
91 * @param aInclusion New inclusion mode. See TGflmFSItemInclusion. |
|
92 */ |
|
93 virtual void SetInclusion( TUint aInclusion ) = 0; |
|
94 |
|
95 /** |
|
96 * Gets the collation method |
|
97 * @since 5.0 |
|
98 * @return Pointer to collation method |
|
99 */ |
|
100 virtual const TCollationMethod* CollationMethod() = 0; |
|
101 |
|
102 }; |
|
103 |
|
104 #endif // MGFLMITEMGROUP_H |
|
105 |
|
106 // End of File |