|
1 /* |
|
2 * Copyright (c) 2005 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: Contact lists settings manager abstract interface |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef __MPENGCONTACTLISTSETTINGSMANAGER_H__ |
|
19 #define __MPENGCONTACTLISTSETTINGSMANAGER_H__ |
|
20 |
|
21 // INCLUDES |
|
22 #include <e32base.h> |
|
23 |
|
24 |
|
25 // FORWARD DECLARATIONS |
|
26 class CPEngContactListSettings; |
|
27 class MDesCArray; |
|
28 class MPEngContactListSettingsObserver; |
|
29 class CPEngContactListModBase; |
|
30 |
|
31 |
|
32 // CLASS DECLARATION |
|
33 |
|
34 /** |
|
35 * Contact lists settings manager abstract interface. |
|
36 * |
|
37 * @since 3.0 |
|
38 */ |
|
39 class MPEngContactListSettingsManager |
|
40 { |
|
41 public: |
|
42 |
|
43 /** |
|
44 * Get Contact list settings |
|
45 * |
|
46 * @since 3.0 |
|
47 * |
|
48 * @param aContactList name of the contact list |
|
49 * @return contact list settings or NULL if no settings |
|
50 * for given list. |
|
51 */ |
|
52 virtual CPEngContactListSettings* ContactListSettingsOrNull( |
|
53 const TDesC& aContactList ) = 0; |
|
54 |
|
55 |
|
56 /** |
|
57 * Add contact list settings observer |
|
58 * |
|
59 * @since 3.0 |
|
60 * |
|
61 * @param aObserver contact list settings observer |
|
62 */ |
|
63 virtual void AddContactListSettingsObserverL( |
|
64 const MPEngContactListSettingsObserver* aObserver ) = 0; |
|
65 |
|
66 |
|
67 /** |
|
68 * Remove contact list settings observer |
|
69 * |
|
70 * @since 3.0 |
|
71 * |
|
72 * @param aObserver contact list settings observer |
|
73 */ |
|
74 virtual void RemoveContactListSettingsObserver( |
|
75 const MPEngContactListSettingsObserver* aObserver ) = 0; |
|
76 |
|
77 |
|
78 /** |
|
79 * Remove model from the array of loaded models. |
|
80 * |
|
81 * @since 3.0 |
|
82 * @param aModel contact list model to be removed |
|
83 */ |
|
84 virtual void RemoveModel( CPEngContactListModBase* aModel ) = 0; |
|
85 |
|
86 |
|
87 /** |
|
88 * Get domain of the logged user, |
|
89 * |
|
90 * KNullDesC if domain was not defined by user nor |
|
91 * neither provided by the server |
|
92 * |
|
93 * @since 3.0 |
|
94 * @return The user domain or empty descriptor. |
|
95 */ |
|
96 virtual const TDesC& UserDomain() const = 0; |
|
97 |
|
98 |
|
99 /** |
|
100 * Store contact list settings |
|
101 * |
|
102 * @since 3.0 |
|
103 */ |
|
104 virtual void StoreSettingsL() = 0; |
|
105 |
|
106 |
|
107 /** |
|
108 * Gets reference to the store entry size |
|
109 * Size can be modified through this reference |
|
110 * @since 3.0 |
|
111 * @return store size reference |
|
112 */ |
|
113 virtual TInt& StoreSize( ) = 0; |
|
114 |
|
115 |
|
116 protected: |
|
117 /** |
|
118 * Virtual inline destructor. |
|
119 * Protected to prohibite deletion through interface. |
|
120 */ |
|
121 virtual ~MPEngContactListSettingsManager() {}; |
|
122 }; |
|
123 |
|
124 #endif // __MPENGCONTACTLISTSETTINGSMANAGER_H__ |
|
125 |
|
126 // End of File |
|
127 |