|
1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). |
|
2 // All rights reserved. |
|
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 |
|
5 // which accompanies this distribution, and is available |
|
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
|
7 // |
|
8 // Initial Contributors: |
|
9 // Nokia Corporation - initial contribution. |
|
10 // |
|
11 // Contributors: |
|
12 // |
|
13 // Description: |
|
14 // |
|
15 |
|
16 |
|
17 |
|
18 /** |
|
19 Gets the CEikonEnv maintained by the framework for the application. |
|
20 |
|
21 This function should never be run in a thread where such a static Uikon environment |
|
22 does not exist. Code that may run on the server side of an application server |
|
23 is one such case. |
|
24 |
|
25 @return A static CEikonEnv. |
|
26 @see CCoeEnv::Static() |
|
27 */ |
|
28 inline CEikonEnv* CEikonEnv::Static() |
|
29 { return((CEikonEnv*)(CCoeEnv::Static())); } |
|
30 |
|
31 /** |
|
32 @publishedPartner |
|
33 @released |
|
34 */ |
|
35 inline TInt CEikonEnv::EditableControlStandardHeight() const |
|
36 { return(iEditableControlStandardHeight); } |
|
37 |
|
38 /** Gets the Uikon process that manages the files of applications started in this |
|
39 environment. |
|
40 |
|
41 @return The CEikProcess object. */ |
|
42 inline CEikProcess* CEikonEnv::Process() const |
|
43 { return(iProcess); } |
|
44 |
|
45 /** Gets the application UI of the application using this CEikonEnv. |
|
46 |
|
47 @return Pointer to the CEikAppUi. */ |
|
48 inline CEikAppUi* CEikonEnv::EikAppUi() const |
|
49 { return((CEikAppUi*)iAppUi); } |
|
50 inline const MEikAlertWin* CEikonEnv::Alert() const |
|
51 { return(iAlertWin); } |
|
52 |
|
53 /** Gets the minus nudge character, this could be the left arrow for example. |
|
54 |
|
55 @return Minus nudge character. */ |
|
56 inline TChar CEikonEnv::NudgeCharMinus() const |
|
57 {return(iNudgeChars[0]);} |
|
58 |
|
59 /** Gets the plus nudge character, this could be the right arrow for example. |
|
60 |
|
61 @return Plus nudge character. */ |
|
62 inline TChar CEikonEnv::NudgeCharPlus() const |
|
63 {return(iNudgeChars[1]);} |
|
64 |
|
65 /** Gets the physical (TRgb) colour which corresponds to a logical colour. |
|
66 |
|
67 @param aLogicalColor A logical colour value. |
|
68 @return The physical colour which corresponds to aLogicalColor. */ |
|
69 inline TRgb CEikonEnv::Color(TLogicalColor aLogicalColor) const |
|
70 {return ColorList().Color(aLogicalColor); } |
|
71 |
|
72 /** Gets the custom colour array. |
|
73 |
|
74 @return The custom colour array. */ |
|
75 inline CColorArray& CEikonEnv::CustomColorArray() const |
|
76 {return *(ColorList().ColorArray(TUid::Uid(KEikCustomColorsArrayValue)));} |
|
77 |
|
78 /** Gets the application's colour list. |
|
79 |
|
80 The colour list provides member functions to retrieve and modify colours |
|
81 in the list, and to append new arrays of colours to the colour list. |
|
82 |
|
83 @return The application's colour list */ |
|
84 inline CColorList& CEikonEnv::ColorList() const |
|
85 {__ASSERT_DEBUG(iColorList,User::Invariant()); return *iColorList; } |
|
86 |
|
87 /** Sets a mapping in the application's colour list between the logical and physical |
|
88 colours specified. |
|
89 |
|
90 @param aLogicalColor A logical colour value. |
|
91 @param aColor A physical colour value. */ |
|
92 inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor) |
|
93 { ColorList().SetColor(aLogicalColor, aColor); } |
|
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) |
|
153 {return(AddLibraryL(aControlFactory, NULL));} |
|
154 inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile) |
|
155 {return(AddLibraryL(NULL, aResourceFile));} |
|
156 inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory) |
|
157 {RemoveLibrary(aControlFactory, NULL);} |
|
158 inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset) |
|
159 {RemoveLibrary(NULL, aResourceFileOffset);} |
|
160 |
|
161 |
|
162 /** |
|
163 @publishedPartner |
|
164 @deprecated |
|
165 */ |
|
166 inline CBase* CEikonEnv::Extension() const |
|
167 {return iExtension;} |
|
168 |
|
169 /** |
|
170 @publishedPartner |
|
171 @released |
|
172 */ |
|
173 inline TInt CEikonEnv::StatusPaneCoreResId() const |
|
174 {return iStatusPaneCoreResId;} |
|
175 |
|
176 /** |
|
177 @publishedPartner |
|
178 @released |
|
179 */ |
|
180 inline void CEikonEnv::SetStatusPaneCoreResId(TInt aStatusPaneCoreResId) |
|
181 {iStatusPaneCoreResId=aStatusPaneCoreResId;} |
|
182 |
|
183 /** |
|
184 @publishedPartner |
|
185 @released |
|
186 */ |
|
187 inline CEikAutoMenuTitleArray* CEikonEnv::AutoMenuTitleArray() const |
|
188 {return iAutoMenuTitleArray;} |
|
189 |
|
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();} |