1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
2 // All rights reserved. |
2 // All rights reserved. |
3 // This component and the accompanying materials are made available |
3 // This component and the accompanying materials are made available |
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members |
4 // under the terms of "Eclipse Public License v1.0" |
5 // which accompanies this distribution, and is available |
5 // which accompanies this distribution, and is available |
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 // |
7 // |
8 // Initial Contributors: |
8 // Initial Contributors: |
9 // Nokia Corporation - initial contribution. |
9 // Nokia Corporation - initial contribution. |
10 // |
10 // |
11 // Contributors: |
11 // Contributors: |
12 // |
12 // |
13 // Description: |
13 // Description: |
14 // |
14 // |
15 |
15 |
16 |
16 #ifndef __EIKENV_INL__ |
|
17 #define __EIKENV_INL__ |
17 |
18 |
18 /** |
19 /** |
19 Gets the CEikonEnv maintained by the framework for the application. |
20 Gets the CEikonEnv maintained by the framework for the application. |
20 |
21 |
21 This function should never be run in a thread where such a static Uikon environment |
22 This function should never be run in a thread where such a static Uikon environment |
25 @return A static CEikonEnv. |
26 @return A static CEikonEnv. |
26 @see CCoeEnv::Static() |
27 @see CCoeEnv::Static() |
27 */ |
28 */ |
28 inline CEikonEnv* CEikonEnv::Static() |
29 inline CEikonEnv* CEikonEnv::Static() |
29 { return((CEikonEnv*)(CCoeEnv::Static())); } |
30 { return((CEikonEnv*)(CCoeEnv::Static())); } |
30 |
|
31 /** |
|
32 @publishedPartner |
|
33 @released |
|
34 */ |
|
35 inline TInt CEikonEnv::EditableControlStandardHeight() const |
|
36 { return(iEditableControlStandardHeight); } |
|
37 |
31 |
38 /** Gets the Uikon process that manages the files of applications started in this |
32 /** Gets the Uikon process that manages the files of applications started in this |
39 environment. |
33 environment. |
40 |
34 |
41 @return The CEikProcess object. */ |
35 @return The CEikProcess object. */ |
47 @return Pointer to the CEikAppUi. */ |
41 @return Pointer to the CEikAppUi. */ |
48 inline CEikAppUi* CEikonEnv::EikAppUi() const |
42 inline CEikAppUi* CEikonEnv::EikAppUi() const |
49 { return((CEikAppUi*)iAppUi); } |
43 { return((CEikAppUi*)iAppUi); } |
50 inline const MEikAlertWin* CEikonEnv::Alert() const |
44 inline const MEikAlertWin* CEikonEnv::Alert() const |
51 { return(iAlertWin); } |
45 { return(iAlertWin); } |
|
46 |
|
47 inline const CEikDialog* MEikAlertWin::AsEikDialog() const |
|
48 {return (const CEikDialog*)const_cast<MEikAlertWin*>(this)->AsEikDialog();} |
|
49 |
|
50 inline const CCoeControl* MEikAlertWin::AsCoeControl() const |
|
51 {return (const CCoeControl*)const_cast<MEikAlertWin*>(this)->AsCoeControl();} |
52 |
52 |
53 /** Gets the minus nudge character, this could be the left arrow for example. |
53 /** Gets the minus nudge character, this could be the left arrow for example. |
54 |
54 |
55 @return Minus nudge character. */ |
55 @return Minus nudge character. */ |
56 inline TChar CEikonEnv::NudgeCharMinus() const |
56 inline TChar CEikonEnv::NudgeCharMinus() const |
90 @param aLogicalColor A logical colour value. |
90 @param aLogicalColor A logical colour value. |
91 @param aColor A physical colour value. */ |
91 @param aColor A physical colour value. */ |
92 inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor) |
92 inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor) |
93 { ColorList().SetColor(aLogicalColor, aColor); } |
93 { ColorList().SetColor(aLogicalColor, aColor); } |
94 |
94 |
95 /** |
|
96 @publishedPartner |
|
97 @released |
|
98 */ |
|
99 inline void CEikonEnv::SetCDlgDialogFactory(MEikCDlgDialogFactory* aDialogFactory) |
|
100 {iCDlgDialogFactory=aDialogFactory;} |
|
101 |
|
102 /** |
|
103 @publishedPartner |
|
104 @released |
|
105 */ |
|
106 inline void CEikonEnv::SetPrintDialogFactory(MEikPrintDialogFactory* aDialogFactory) |
|
107 {iPrintDialogFactory=aDialogFactory;} |
|
108 |
|
109 /** |
|
110 @publishedPartner |
|
111 @released |
|
112 */ |
|
113 inline void CEikonEnv::SetFileDialogFactory(MEikFileDialogFactory* aDialogFactory) |
|
114 {iFileDialogFactory=aDialogFactory;} |
|
115 |
|
116 /** |
|
117 @publishedPartner |
|
118 @released |
|
119 */ |
|
120 inline void CEikonEnv::SetIrFactory(MEikIrFactory* aIrFactory) |
|
121 {iIrFactory=aIrFactory;} |
|
122 |
|
123 /** |
|
124 @publishedPartner |
|
125 @released |
|
126 */ |
|
127 inline MEikCDlgDialogFactory* CEikonEnv::CDlgDialogFactory() const |
|
128 {return iCDlgDialogFactory;} |
|
129 |
|
130 /** |
|
131 @publishedPartner |
|
132 @released |
|
133 */ |
|
134 inline MEikPrintDialogFactory* CEikonEnv::PrintDialogFactory() const |
|
135 {return iPrintDialogFactory;} |
|
136 |
|
137 /** |
|
138 @publishedPartner |
|
139 @released |
|
140 */ |
|
141 inline MEikFileDialogFactory* CEikonEnv::FileDialogFactory() const |
|
142 {return iFileDialogFactory;} |
|
143 |
|
144 /** |
|
145 @publishedPartner |
|
146 @released |
|
147 */ |
|
148 inline MEikIrFactory* CEikonEnv::IrFactory() const |
|
149 {return iIrFactory;} |
|
150 |
|
151 |
|
152 inline TInt CEikonEnv::AddLibraryL(TCreateByTypeFunction aControlFactory) |
95 inline TInt CEikonEnv::AddLibraryL(TCreateByTypeFunction aControlFactory) |
153 {return(AddLibraryL(aControlFactory, NULL));} |
96 {return(AddLibraryL(aControlFactory, NULL));} |
154 inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile) |
97 inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile) |
155 {return(AddLibraryL(NULL, aResourceFile));} |
98 {return(AddLibraryL(NULL, aResourceFile));} |
156 inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory) |
99 inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory) |
157 {RemoveLibrary(aControlFactory, NULL);} |
100 {RemoveLibrary(aControlFactory, NULL);} |
158 inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset) |
101 inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset) |
159 {RemoveLibrary(NULL, aResourceFileOffset);} |
102 {RemoveLibrary(NULL, aResourceFileOffset);} |
160 |
103 |
161 |
|
162 /** |
104 /** |
163 @publishedPartner |
105 @publishedPartner |
164 @deprecated |
106 @deprecated |
|
107 WARNING: For internal use ONLY. Compatibility is not guaranteed in future releases. |
165 */ |
108 */ |
166 inline CBase* CEikonEnv::Extension() const |
109 inline CBase* CEikonEnv::Extension() const |
167 {return iExtension;} |
110 {return iExtension;} |
168 |
111 |
169 /** |
|
170 @publishedPartner |
|
171 @released |
|
172 */ |
|
173 inline TInt CEikonEnv::StatusPaneCoreResId() const |
|
174 {return iStatusPaneCoreResId;} |
|
175 |
112 |
176 /** |
|
177 @publishedPartner |
|
178 @released |
|
179 */ |
|
180 inline void CEikonEnv::SetStatusPaneCoreResId(TInt aStatusPaneCoreResId) |
|
181 {iStatusPaneCoreResId=aStatusPaneCoreResId;} |
|
182 |
113 |
183 /** |
114 #endif // __EIKENV_INL__ |
184 @publishedPartner |
|
185 @released |
|
186 */ |
|
187 inline CEikAutoMenuTitleArray* CEikonEnv::AutoMenuTitleArray() const |
|
188 {return iAutoMenuTitleArray;} |
|
189 |
115 |
190 inline const CEikDialog* MEikAlertWin::AsEikDialog() const |
|
191 {return (const CEikDialog*)const_cast<MEikAlertWin*>(this)->AsEikDialog();} |
|
192 |
|
193 inline const CCoeControl* MEikAlertWin::AsCoeControl() const |
|
194 {return (const CCoeControl*)const_cast<MEikAlertWin*>(this)->AsCoeControl();} |
|