1 /* |
|
2 * Copyright (c) 2008 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: This class provides functionality for editing Events. |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef EVTEVENTSDLG_H |
|
21 #define EVTEVENTSDLG_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32base.h> // CBase |
|
25 |
|
26 // User Includes |
|
27 |
|
28 // FORWARD DECLARATIONS |
|
29 class CEvtEvent; |
|
30 class CEvtEditor; |
|
31 class MObjectProvider; |
|
32 class TCoeHelpContext; |
|
33 class TCoordinate; |
|
34 class CEvtMgmtUiEngine; |
|
35 |
|
36 // CLASS DECLARATION |
|
37 |
|
38 /** |
|
39 * This is a dialog class, which is used to launch Events editor dialog. |
|
40 */ |
|
41 class CEvtEventsDlg : public CBase |
|
42 { |
|
43 public: // Constructors and destructor |
|
44 /** |
|
45 * This is a static function, which creates and returns an instance of this class. |
|
46 * The Event that has to be edited is shown in the editor. |
|
47 * |
|
48 * @leave Leaves with KErrNotSupported if framework functionality is not available. |
|
49 * @panic Panics with system-wide panic codes. |
|
50 * @return new instance of this class |
|
51 */ |
|
52 IMPORT_C static CEvtEventsDlg* NewL(TBool aIsEditable, |
|
53 CEvtEvent& aEvent, |
|
54 CEvtMgmtUiEngine& aEventEngine, |
|
55 TBool aDisplayExitMenuItem = ETrue |
|
56 ); |
|
57 |
|
58 /** |
|
59 * Destructor. |
|
60 */ |
|
61 IMPORT_C ~CEvtEventsDlg(); |
|
62 |
|
63 public: // New functions |
|
64 /** |
|
65 * This function sets the context - that is, the enclosing parent control - for this control. |
|
66 * |
|
67 * @param [in] aParent The parent object which is the context for the control. |
|
68 * @panic Panics with KLmkPanicNullMember, if the selector is not |
|
69 * constructed properly. |
|
70 */ |
|
71 IMPORT_C void SetMopParent( MObjectProvider* aParent ); |
|
72 |
|
73 /** |
|
74 * This method sets help context. This provides an option to show the help context |
|
75 * of the application that launches editor. By default, we show the Events Ui help context. |
|
76 * @param[in] aContext help context to use |
|
77 */ |
|
78 IMPORT_C void SetHelpContext( TCoeHelpContext aContext ); |
|
79 |
|
80 /** |
|
81 * This function launches the Events editor dialog. Client uses this function |
|
82 * to launch events editor dialog. |
|
83 * This object is destroyed when this function returns or leaves. |
|
84 * @leave Leaves with system-wide leave codes. |
|
85 * @panic Panics with KEvtPanicNullMember, if the selector is not constructed properly. |
|
86 * @return Returns non-zero if accepted, else zero. |
|
87 */ |
|
88 IMPORT_C TInt ExecuteLD( ); |
|
89 private: |
|
90 /** |
|
91 * C++ default constructor. |
|
92 * @return newly instantiated object |
|
93 */ |
|
94 CEvtEventsDlg(); |
|
95 |
|
96 /** |
|
97 * By default Symbian 2nd phase constructor is private. |
|
98 */ |
|
99 |
|
100 void ConstructL( TBool aIsEditable, |
|
101 CEvtEvent& aEvent, |
|
102 CEvtMgmtUiEngine& aEventEngine, |
|
103 TBool aDisplayExitMenuItem = ETrue |
|
104 ); |
|
105 |
|
106 |
|
107 private: // Data |
|
108 |
|
109 /// Own: Editor object |
|
110 CEvtEditor* iEvtEditor; |
|
111 |
|
112 /// Own: A pointer to TBool |
|
113 TBool* iDestroyedPtr; |
|
114 |
|
115 }; |
|
116 |
|
117 #endif // EVTEVENTSDLG_H |
|
118 |
|
119 // End of File |
|