|
1 /* |
|
2 * Copyright (c) 2005-2007 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: Phonebook 2 fetch dialog page interface. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef MPBK2FETCHDLGPAGE_H |
|
20 #define MPBK2FETCHDLGPAGE_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32std.h> |
|
24 |
|
25 // FORWARD DECLARATIONS |
|
26 class MVPbkBaseContact; |
|
27 class MVPbkContactLink; |
|
28 class MPbk2ContactUiControl; |
|
29 class MVPbkContactViewBase; |
|
30 |
|
31 // CLASS DECLARATION |
|
32 |
|
33 /** |
|
34 * Phonebook 2 fetch dialog page interface. |
|
35 */ |
|
36 class MPbk2FetchDlgPage |
|
37 { |
|
38 public: // Interface |
|
39 |
|
40 /** |
|
41 * Destructor |
|
42 */ |
|
43 virtual ~MPbk2FetchDlgPage() |
|
44 {} |
|
45 |
|
46 /** |
|
47 * Returns this page's id. |
|
48 * |
|
49 * @return Page id. |
|
50 */ |
|
51 virtual TInt FetchDlgPageId() const = 0; |
|
52 |
|
53 /** |
|
54 * Activates this dialog page. Page can set internal state according |
|
55 * to gives state parameter. |
|
56 */ |
|
57 virtual void ActivateFetchDlgPageL() = 0; |
|
58 |
|
59 /** |
|
60 * Deactivates this dialog page. |
|
61 */ |
|
62 virtual void DeactivateFetchDlgPage() = 0; |
|
63 |
|
64 /** |
|
65 * Returns the currently focused contact on this page. |
|
66 * |
|
67 * @return Focused contact. |
|
68 */ |
|
69 virtual const MVPbkBaseContact* FocusedContactL() const = 0; |
|
70 |
|
71 /** |
|
72 * Returns the UI control of the page. |
|
73 * |
|
74 * @return UI control. |
|
75 */ |
|
76 virtual MPbk2ContactUiControl& Control() const = 0; |
|
77 |
|
78 /** |
|
79 * Returns the view of the page. |
|
80 * |
|
81 * @return View. |
|
82 */ |
|
83 virtual MVPbkContactViewBase& View() const = 0; |
|
84 |
|
85 /** |
|
86 * Sets the view of the page. |
|
87 * |
|
88 * @param aView The view to set. |
|
89 */ |
|
90 virtual void SetViewL( |
|
91 MVPbkContactViewBase& aView ) = 0; |
|
92 |
|
93 /** |
|
94 * Returns ETrue if the page initialisation is complete |
|
95 * and the page can be used. |
|
96 * |
|
97 * @return ETrue if the page is ready. |
|
98 */ |
|
99 virtual TBool DlgPageReady() const = 0; |
|
100 |
|
101 /** |
|
102 * Returns ETrue if this fetch dialog page is empty. |
|
103 * |
|
104 * @return ETrue if the page is empty. |
|
105 */ |
|
106 virtual TBool DlgPageEmpty() const = 0; |
|
107 |
|
108 /** |
|
109 * Selects contact in the UI control |
|
110 * |
|
111 * @param aContactLink Link to the contact to select. |
|
112 * @param aSelect ETrue if contact is to be selected, |
|
113 * EFalse if deselected. |
|
114 */ |
|
115 virtual void SelectContactL( |
|
116 const MVPbkContactLink& aContactLink, |
|
117 TBool aSelect ) = 0; |
|
118 |
|
119 /** |
|
120 * Handles a resource change. |
|
121 * |
|
122 * @param aType Resource change type. |
|
123 */ |
|
124 virtual void HandleResourceChange( |
|
125 TInt aType ) = 0; |
|
126 }; |
|
127 |
|
128 #endif // MPBK2FETCHDLGPAGE_H |
|
129 |
|
130 // End of File |