1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/mw/eikenv.inl Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,194 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +
1.20 +
1.21 +/**
1.22 + Gets the CEikonEnv maintained by the framework for the application.
1.23 +
1.24 + This function should never be run in a thread where such a static Uikon environment
1.25 + does not exist. Code that may run on the server side of an application server
1.26 + is one such case.
1.27 +
1.28 + @return A static CEikonEnv.
1.29 + @see CCoeEnv::Static()
1.30 +*/
1.31 +inline CEikonEnv* CEikonEnv::Static()
1.32 + { return((CEikonEnv*)(CCoeEnv::Static())); }
1.33 +
1.34 +/**
1.35 +@publishedPartner
1.36 +@released
1.37 +*/
1.38 +inline TInt CEikonEnv::EditableControlStandardHeight() const
1.39 + { return(iEditableControlStandardHeight); }
1.40 +
1.41 +/** Gets the Uikon process that manages the files of applications started in this
1.42 +environment.
1.43 +
1.44 +@return The CEikProcess object. */
1.45 +inline CEikProcess* CEikonEnv::Process() const
1.46 + { return(iProcess); }
1.47 +
1.48 +/** Gets the application UI of the application using this CEikonEnv.
1.49 +
1.50 +@return Pointer to the CEikAppUi. */
1.51 +inline CEikAppUi* CEikonEnv::EikAppUi() const
1.52 + { return((CEikAppUi*)iAppUi); }
1.53 +inline const MEikAlertWin* CEikonEnv::Alert() const
1.54 + { return(iAlertWin); }
1.55 +
1.56 +/** Gets the minus nudge character, this could be the left arrow for example.
1.57 +
1.58 +@return Minus nudge character. */
1.59 +inline TChar CEikonEnv::NudgeCharMinus() const
1.60 + {return(iNudgeChars[0]);}
1.61 +
1.62 +/** Gets the plus nudge character, this could be the right arrow for example.
1.63 +
1.64 +@return Plus nudge character. */
1.65 +inline TChar CEikonEnv::NudgeCharPlus() const
1.66 + {return(iNudgeChars[1]);}
1.67 +
1.68 +/** Gets the physical (TRgb) colour which corresponds to a logical colour.
1.69 +
1.70 +@param aLogicalColor A logical colour value.
1.71 +@return The physical colour which corresponds to aLogicalColor. */
1.72 +inline TRgb CEikonEnv::Color(TLogicalColor aLogicalColor) const
1.73 + {return ColorList().Color(aLogicalColor); }
1.74 +
1.75 +/** Gets the custom colour array.
1.76 +
1.77 +@return The custom colour array. */
1.78 +inline CColorArray& CEikonEnv::CustomColorArray() const
1.79 + {return *(ColorList().ColorArray(TUid::Uid(KEikCustomColorsArrayValue)));}
1.80 +
1.81 +/** Gets the application's colour list.
1.82 +
1.83 +The colour list provides member functions to retrieve and modify colours
1.84 +in the list, and to append new arrays of colours to the colour list.
1.85 +
1.86 +@return The application's colour list */
1.87 +inline CColorList& CEikonEnv::ColorList() const
1.88 + {__ASSERT_DEBUG(iColorList,User::Invariant()); return *iColorList; }
1.89 +
1.90 +/** Sets a mapping in the application's colour list between the logical and physical
1.91 +colours specified.
1.92 +
1.93 +@param aLogicalColor A logical colour value.
1.94 +@param aColor A physical colour value. */
1.95 +inline void CEikonEnv::SetColor(TLogicalColor aLogicalColor, TRgb aColor)
1.96 + { ColorList().SetColor(aLogicalColor, aColor); }
1.97 +
1.98 +/**
1.99 +@publishedPartner
1.100 +@released
1.101 +*/
1.102 +inline void CEikonEnv::SetCDlgDialogFactory(MEikCDlgDialogFactory* aDialogFactory)
1.103 + {iCDlgDialogFactory=aDialogFactory;}
1.104 +
1.105 +/**
1.106 +@publishedPartner
1.107 +@released
1.108 +*/
1.109 +inline void CEikonEnv::SetPrintDialogFactory(MEikPrintDialogFactory* aDialogFactory)
1.110 + {iPrintDialogFactory=aDialogFactory;}
1.111 +
1.112 +/**
1.113 +@publishedPartner
1.114 +@released
1.115 +*/
1.116 +inline void CEikonEnv::SetFileDialogFactory(MEikFileDialogFactory* aDialogFactory)
1.117 + {iFileDialogFactory=aDialogFactory;}
1.118 +
1.119 +/**
1.120 +@publishedPartner
1.121 +@released
1.122 +*/
1.123 +inline void CEikonEnv::SetIrFactory(MEikIrFactory* aIrFactory)
1.124 + {iIrFactory=aIrFactory;}
1.125 +
1.126 +/**
1.127 +@publishedPartner
1.128 +@released
1.129 +*/
1.130 +inline MEikCDlgDialogFactory* CEikonEnv::CDlgDialogFactory() const
1.131 + {return iCDlgDialogFactory;}
1.132 +
1.133 +/**
1.134 +@publishedPartner
1.135 +@released
1.136 +*/
1.137 +inline MEikPrintDialogFactory* CEikonEnv::PrintDialogFactory() const
1.138 + {return iPrintDialogFactory;}
1.139 +
1.140 +/**
1.141 +@publishedPartner
1.142 +@released
1.143 +*/
1.144 +inline MEikFileDialogFactory* CEikonEnv::FileDialogFactory() const
1.145 + {return iFileDialogFactory;}
1.146 +
1.147 +/**
1.148 +@publishedPartner
1.149 +@released
1.150 +*/
1.151 +inline MEikIrFactory* CEikonEnv::IrFactory() const
1.152 + {return iIrFactory;}
1.153 +
1.154 +
1.155 +inline TInt CEikonEnv::AddLibraryL(TCreateByTypeFunction aControlFactory)
1.156 + {return(AddLibraryL(aControlFactory, NULL));}
1.157 +inline TInt CEikonEnv::AddLibraryL(TFileName* aResourceFile)
1.158 + {return(AddLibraryL(NULL, aResourceFile));}
1.159 +inline void CEikonEnv::RemoveLibrary(TCreateByTypeFunction aControlFactory)
1.160 + {RemoveLibrary(aControlFactory, NULL);}
1.161 +inline void CEikonEnv::RemoveLibrary(TInt aResourceFileOffset)
1.162 + {RemoveLibrary(NULL, aResourceFileOffset);}
1.163 +
1.164 +
1.165 +/**
1.166 +@publishedPartner
1.167 +@deprecated
1.168 +*/
1.169 +inline CBase* CEikonEnv::Extension() const
1.170 + {return iExtension;}
1.171 +
1.172 +/**
1.173 +@publishedPartner
1.174 +@released
1.175 +*/
1.176 +inline TInt CEikonEnv::StatusPaneCoreResId() const
1.177 + {return iStatusPaneCoreResId;}
1.178 +
1.179 +/**
1.180 +@publishedPartner
1.181 +@released
1.182 +*/
1.183 +inline void CEikonEnv::SetStatusPaneCoreResId(TInt aStatusPaneCoreResId)
1.184 + {iStatusPaneCoreResId=aStatusPaneCoreResId;}
1.185 +
1.186 +/**
1.187 +@publishedPartner
1.188 +@released
1.189 +*/
1.190 +inline CEikAutoMenuTitleArray* CEikonEnv::AutoMenuTitleArray() const
1.191 + {return iAutoMenuTitleArray;}
1.192 +
1.193 +inline const CEikDialog* MEikAlertWin::AsEikDialog() const
1.194 + {return (const CEikDialog*)const_cast<MEikAlertWin*>(this)->AsEikDialog();}
1.195 +
1.196 +inline const CCoeControl* MEikAlertWin::AsCoeControl() const
1.197 + {return (const CCoeControl*)const_cast<MEikAlertWin*>(this)->AsCoeControl();}