1 mproengprofilenamearray.h |
1 /* |
|
2 * Copyright (c) 2009 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 "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: Profile name array interface. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef MPROENGPROFILENAMEARRAY_H |
|
21 #define MPROENGPROFILENAMEARRAY_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <BAMDESCA.H> // MDesCArray |
|
25 |
|
26 // FORWARD DECLARATIONS |
|
27 class MProEngProfileName; |
|
28 class MProEngProfileNameArrayExt; |
|
29 |
|
30 // CLASS DECLARATION |
|
31 |
|
32 /** |
|
33 * Profile name array interface. |
|
34 * |
|
35 * How to use: |
|
36 * Get profile names array with MProEngEngine::ProfileNameArrayLC(). |
|
37 * @code |
|
38 * MProEngProfileNameArray* nameArray = |
|
39 * iProfileEngine->ProfileNameArrayLC(); |
|
40 * @endcode |
|
41 * |
|
42 * @lib ProfileEngine.lib |
|
43 * @since 3.1 |
|
44 */ |
|
45 class MProEngProfileNameArray : public MDesCArray |
|
46 { |
|
47 public: // New functions |
|
48 |
|
49 /** |
|
50 * Return the ID of the profile in the given array index. |
|
51 * @since 3.1 |
|
52 * @param aIndex index of the profile. |
|
53 * @return Return the ID of the profile in the given array index. |
|
54 * KErrNotFound if the index is out of bounds. |
|
55 */ |
|
56 virtual TInt ProfileId( TInt aIndex ) const = 0; |
|
57 |
|
58 /** |
|
59 * Find profile index by ID of the profile. |
|
60 * @since 3.1 |
|
61 * @param aId ID of the profile. |
|
62 * @return Return index of the profile. KErrNotFound if |
|
63 * profile isn't found. |
|
64 */ |
|
65 virtual TInt FindById( TInt aId ) const = 0; |
|
66 |
|
67 /** |
|
68 * Find profile index by name of the profile. |
|
69 * @since 3.1 |
|
70 * @param aProfileName name of the profile. |
|
71 * @return Return index of the profile. KErrNotFound if |
|
72 * profile isn't found. |
|
73 */ |
|
74 virtual TInt FindByName( const TDesC& aProfileName ) const = 0; |
|
75 |
|
76 private: // Extension interface |
|
77 |
|
78 /** |
|
79 * This member is internal and not intended for use. |
|
80 */ |
|
81 virtual MProEngProfileNameArrayExt* Extension() { return NULL; } |
|
82 |
|
83 }; |
|
84 |
|
85 #endif // MPROENGPROFILENAMEARRAY_H |
|
86 |
|
87 // End of File |
|
88 |