|
1 /* |
|
2 * Copyright (c) 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: Operation progress information data structure. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef T_NCD_PROGRESS_H |
|
20 #define T_NCD_PROGRESS_H |
|
21 |
|
22 #include <e32base.h> |
|
23 |
|
24 /** |
|
25 * Operation progress information. Progress is represented as two |
|
26 * integer values: one defining the maximum progress value, and the |
|
27 * other defining the current value. The maximum value stays |
|
28 * (preferably) the same during an operation, while the current value |
|
29 * is incremented during an operation, until it reaches the maximum |
|
30 * value when the operation is complete. |
|
31 * |
|
32 * @note Operation completion should not be determined using the |
|
33 * progress values, the values are indicative only. |
|
34 * |
|
35 * |
|
36 */ |
|
37 class TNcdProgress |
|
38 { |
|
39 public: |
|
40 |
|
41 /** |
|
42 * Default constructor. |
|
43 * |
|
44 * Progress values are left uninitialized. |
|
45 * |
|
46 * |
|
47 */ |
|
48 IMPORT_C TNcdProgress(); |
|
49 |
|
50 /** |
|
51 * Constructor. |
|
52 * |
|
53 * Initializes progress values with given parameters. |
|
54 * |
|
55 * |
|
56 */ |
|
57 IMPORT_C TNcdProgress( TUint aProgress, TUint aMaxProgress ); |
|
58 |
|
59 public: |
|
60 /** |
|
61 * Current progress value of the current state (zero-based) |
|
62 * |
|
63 * |
|
64 */ |
|
65 TUint iProgress; |
|
66 |
|
67 /** |
|
68 * Maximum progress value for the current state |
|
69 * |
|
70 * |
|
71 */ |
|
72 TUint iMaxProgress; |
|
73 |
|
74 }; |
|
75 |
|
76 #endif // T_NCD_PROGRESS_H |