|
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 pages interface. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef MPBK2FETCHDLGPAGES_H |
|
20 #define MPBK2FETCHDLGPAGES_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32std.h> |
|
24 |
|
25 // FORWARD DECLARATIONS |
|
26 class MVPbkBaseContact; |
|
27 class MPbk2FetchDlgPage; |
|
28 class MVPbkContactLink; |
|
29 |
|
30 // CLASS DECLARATION |
|
31 |
|
32 /** |
|
33 * Phonebook 2 fetch dialog page collection interface. |
|
34 */ |
|
35 class MPbk2FetchDlgPages |
|
36 { |
|
37 public: // Interface |
|
38 |
|
39 /** |
|
40 * Destructor |
|
41 */ |
|
42 virtual ~MPbk2FetchDlgPages() |
|
43 {} |
|
44 |
|
45 /** |
|
46 * Returns the number of pages in the collection. |
|
47 * |
|
48 * @return Page count. |
|
49 */ |
|
50 virtual TInt DlgPageCount() const = 0; |
|
51 |
|
52 /** |
|
53 * Returns the page at given index. |
|
54 * |
|
55 * @param aIndex The index to inspect. |
|
56 * @return Page at given index. |
|
57 */ |
|
58 virtual MPbk2FetchDlgPage& DlgPageAt( |
|
59 TInt aIndex ) const = 0; |
|
60 |
|
61 /** |
|
62 * Returns a page with given id or NULL if not found. |
|
63 * |
|
64 * @param aPageId Id of the page to search for. |
|
65 * @return Page with given id or NULL. |
|
66 */ |
|
67 virtual MPbk2FetchDlgPage* DlgPageWithId( |
|
68 TInt aPageId ) const = 0; |
|
69 |
|
70 /** |
|
71 * Activates the page with given id and deactives the previous one. |
|
72 * |
|
73 * @param aPageId Id of the page to activate. |
|
74 */ |
|
75 virtual void HandlePageChangedL( |
|
76 TInt aPageId ) = 0; |
|
77 |
|
78 /** |
|
79 * Returns ETrue if all pages are ready otherwise EFalse. |
|
80 * |
|
81 * @return ETrue if all pages are ready. |
|
82 */ |
|
83 virtual TBool AllPagesReady() = 0; |
|
84 |
|
85 /** |
|
86 * Returns ETrue if the currently active page is empty. |
|
87 * |
|
88 * @return ETrue if currently active page is empty. |
|
89 */ |
|
90 virtual TBool IsActivePageEmpty() = 0; |
|
91 |
|
92 /** |
|
93 * Actives the first page. |
|
94 */ |
|
95 virtual void ActiveFirstPageL() = 0; |
|
96 |
|
97 /** |
|
98 * Returns the currently focused contact on an active page. |
|
99 * |
|
100 * @return Focused contact. |
|
101 */ |
|
102 virtual const MVPbkBaseContact* FocusedContactL() const = 0; |
|
103 |
|
104 /** |
|
105 * Returns the current page. |
|
106 * |
|
107 * @return Current page. |
|
108 */ |
|
109 virtual MPbk2FetchDlgPage& CurrentPage() const = 0; |
|
110 |
|
111 /** |
|
112 * Selects contact in the UI control |
|
113 * |
|
114 * @param aContactLink Link to the contact to select. |
|
115 * @param aSelect ETrue if contact is to be selected, |
|
116 * EFalse if deselected. |
|
117 */ |
|
118 virtual void SelectContactL( |
|
119 const MVPbkContactLink& aContactLink, |
|
120 TBool aSelect ) = 0; |
|
121 }; |
|
122 |
|
123 #endif // MPBK2FETCHDLGPAGES_H |
|
124 |
|
125 // End of File |