1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/eiksrv.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -0,0 +1,263 @@
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 +#ifndef __EIKSRV_H__
1.20 +#define __EIKSRV_H__
1.21 +
1.22 +#include <eikappui.h>
1.23 +#include <eikenv.h>
1.24 +#include <apgtask.h>
1.25 +#include <vwsappst.h>
1.26 +#include <eikunder.h>
1.27 +#include <eikcycledef.h>
1.28 +
1.29 +class CDictionaryFileStore;
1.30 +class CVwsSessionWrapper;
1.31 +class CEikDebugPreferences;
1.32 +
1.33 +const TInt KBufferExpansionRequired = 10; // Random number chosen to indicate buffer expansion on the client side.
1.34 +
1.35 +/**
1.36 +@internalComponent
1.37 +*/
1.38 +enum TEikAppUiServPanic
1.39 + {
1.40 + EEikSrvDefault,
1.41 + EEikSrvSvrCreateServer, // no longer used
1.42 + EEikSrvSvrStartServer,
1.43 + EEikSrvSrvNotFound,
1.44 + EEikSrvBadDescriptor,
1.45 + EEikSrvIllegalError,
1.46 + EEikSrvBadRequestSequence
1.47 + };
1.48 +
1.49 +class CEikServAppUiSession;
1.50 +
1.51 +NONSHARABLE_CLASS(CEikServAppUiServer) : public CPolicyServer
1.52 +/**
1.53 +@internalComponent
1.54 +*/
1.55 + {
1.56 + friend class CEikServAppUiSession;
1.57 +public:
1.58 + enum {EPriority=EPriorityAbsoluteHigh};
1.59 + IMPORT_C static CEikServAppUiServer* NewL();
1.60 + virtual CSession2* NewSessionL(const TVersion &aVersion,const RMessage2& aMessage) const;
1.61 + static TInt ThreadFunction(TAny* aStarted);
1.62 + CEikAppUi& AppUi(); // non-inline (and non-exported) so that it cannot be accessed outside of the DLL
1.63 + ~CEikServAppUiServer();
1.64 +private:
1.65 + CEikServAppUiServer(TInt aPriority=EPriority);
1.66 + void ConstructL();
1.67 + CEikServAppUiSession* NewSessionL();
1.68 +private:
1.69 + CEikAppUi* iAppUi;
1.70 + CEikDebugPreferences* iDebugPreferences;
1.71 + };
1.72 +
1.73 +class MEikServAppUiSessionHandler
1.74 +/**
1.75 +@publishedPartner
1.76 +@released
1.77 +*/
1.78 + {
1.79 +public:
1.80 + virtual void NotifyAlarmServerOfTaskChangeL() = 0;
1.81 + virtual void LaunchTaskListL() = 0;
1.82 + virtual void CycleTasksL(enum TTaskCycleDirection aDirection) = 0;
1.83 + virtual void SetStatusPaneFlags(TInt aFlags) = 0;
1.84 + virtual void SetStatusPaneLayoutL(TInt aLayoutResId) = 0;
1.85 + virtual void BlankScreenL() = 0;
1.86 + virtual void UnblankScreen() = 0;
1.87 + virtual void EnableTaskListL() = 0;
1.88 + virtual void Extension(TUid aExtensionUid,const TDesC8& aBuffer,RMessagePtr2 aMessage) = 0;
1.89 +protected:
1.90 + IMPORT_C MEikServAppUiSessionHandler();
1.91 +private:
1.92 + IMPORT_C virtual void MEikServAppUiSessionHandler_Reserved1();
1.93 + IMPORT_C virtual void MEikServAppUiSessionHandler_Reserved2();
1.94 +private:
1.95 + TInt iMEikServAppUiSessionHandler_Reserved1;
1.96 + };
1.97 +
1.98 +class CEikServAppUiSession : public CSession2
1.99 +/**
1.100 +@publishedPartner
1.101 +@released
1.102 +*/
1.103 + {
1.104 +public:
1.105 + IMPORT_C CEikServAppUiSession(MEikServAppUiSessionHandler* aHandler);
1.106 + IMPORT_C ~CEikServAppUiSession();
1.107 + IMPORT_C virtual void ConstructL();
1.108 + IMPORT_C virtual void ServiceL(const RMessage2& aMessage);
1.109 + IMPORT_C virtual void ServiceError(const RMessage2& aMessage,TInt aError);
1.110 +private:
1.111 + void PanicClient(const RMessage2& aMessage, TEikAppUiServPanic aCode);
1.112 + inline CEikServAppUiServer& Server() {return *STATIC_CAST(CEikServAppUiServer*,CONST_CAST(CServer2*,CSession2::Server()));}
1.113 +protected:
1.114 + IMPORT_C MEikServAppUiSessionHandler* SessionHandler() const;
1.115 +protected:
1.116 + CEikServAppUiServer* iAppUiServer;
1.117 + TBool iScreenBlanked;
1.118 + MEikServAppUiSessionHandler* iSessionHandler;
1.119 +private: // below are old obsolete member variables, kept for binary compatibility
1.120 + TInt iNotUsed1;
1.121 + TInt iNotUsed2;
1.122 + };
1.123 +
1.124 +
1.125 +NONSHARABLE_CLASS(CEikPasswordModeCategory) : public CBase
1.126 +/** Gives access to the system's password mode.
1.127 +
1.128 +The password mode can be passed to a password window, see RWindowBase::PasswordWindow().
1.129 +This is a window that requires the user to enter a password before any further actions can
1.130 +be carried out.
1.131 +
1.132 +The possible password modes are enumerated in TPasswordMode.
1.133 +
1.134 +@publishedPartner
1.135 +@released */
1.136 + {
1.137 +public:
1.138 + IMPORT_C static CEikPasswordModeCategory* NewLC(RFs& aFs);
1.139 + IMPORT_C ~CEikPasswordModeCategory();
1.140 + IMPORT_C void GetPasswordModeL(TPasswordMode& aMode) const;
1.141 + IMPORT_C void SetPasswordModeL(TPasswordMode aMode);
1.142 +private:
1.143 + CEikPasswordModeCategory();
1.144 + void ConstructL(RFs& aFs);
1.145 +private:
1.146 + CDictionaryFileStore* iStore;
1.147 + };
1.148 +
1.149 +class CEikServNotifyServer;
1.150 +class CNotifierServerExtended;
1.151 +class CEikServBackupServer;
1.152 +class CEikServAlarmAlertServer;
1.153 +class CEikKeyWindow;
1.154 +class CEikUndertaker;
1.155 +class CEikPasswordControl;
1.156 +class CEikTaskListDialog;
1.157 +class MEikServNotifyAlert;
1.158 +class MEikServAlarmFactory;
1.159 +class CEikServDllClose;
1.160 +
1.161 +NONSHARABLE_CLASS(TEikServCtrlFactories)
1.162 +/**
1.163 +@publishedPartner
1.164 +@released
1.165 +*/
1.166 + {
1.167 +public:
1.168 + inline TEikServCtrlFactories();
1.169 + inline TEikServCtrlFactories(MEikServNotifyAlert* aAlert,MEikServAlarmFactory* aAlarmAlert);
1.170 +public:
1.171 + MEikServNotifyAlert* iAlert;
1.172 + MEikServAlarmFactory* iAlarmAlert; // does not own anything
1.173 +private:
1.174 + TInt iTEikServCtrlFactories_Reserved1;
1.175 + };
1.176 +
1.177 +class MEikServAppUiSessionFactory
1.178 +/**
1.179 +@publishedPartner
1.180 +@released
1.181 +*/
1.182 + {
1.183 +public:
1.184 + virtual CEikServAppUiSession* CreateSessionL() = 0;
1.185 +protected:
1.186 + IMPORT_C MEikServAppUiSessionFactory();
1.187 +private:
1.188 + IMPORT_C virtual void MEikServAppUiSessionFactory_Reserved1();
1.189 + IMPORT_C virtual void MEikServAppUiSessionFactory_Reserved2();
1.190 +private:
1.191 + TInt iMEikServAppUiSessionFactory_Reserved1;
1.192 + };
1.193 +
1.194 +NONSHARABLE_CLASS(CEikServEnv) : public CEikonEnv
1.195 +/**
1.196 +@publishedPartner
1.197 +@released
1.198 +*/
1.199 + {
1.200 +public:
1.201 + IMPORT_C CEikServEnv();
1.202 + IMPORT_C ~CEikServEnv();
1.203 + IMPORT_C void DestroyEnvironment();
1.204 +public:
1.205 + IMPORT_C void SetEikServAppUiSessionFactory(MEikServAppUiSessionFactory* aSessionFactory);
1.206 + IMPORT_C MEikServAppUiSessionFactory* EikServAppUiSessionFactory() const;
1.207 + IMPORT_C TBool IsTaskListEnabled() const;
1.208 + IMPORT_C void EnableTaskList();
1.209 +public:
1.210 + void SetEikServer(CEikServAppUiServer* aServer);
1.211 + IMPORT_C void SetUiDll(RLibrary& aDll);
1.212 +private: // reserved virtuals. do not override!
1.213 + IMPORT_C virtual void CEikServEnv_Reserved1();
1.214 + IMPORT_C virtual void CEikServEnv_Reserved2();
1.215 + IMPORT_C virtual void CEikServEnv_Reserved3();
1.216 + IMPORT_C virtual void CEikServEnv_Reserved4();
1.217 + IMPORT_C virtual void CEikServEnv_Reserved5();
1.218 + IMPORT_C virtual void CEikServEnv_Reserved6();
1.219 +private: // from CCoeEnv. do not override!
1.220 + IMPORT_C void Reserved_1();
1.221 + IMPORT_C void Reserved_2();
1.222 +private:
1.223 + RLibrary iUiDll;
1.224 + CEikServAppUiServer* iServer;
1.225 + MEikServAppUiSessionFactory* iSessionFactory;
1.226 + TBool iIsTaskListEnabled;
1.227 + TInt iCEikServEnv_Reserved1;
1.228 + };
1.229 +
1.230 +inline TEikServCtrlFactories::TEikServCtrlFactories()
1.231 + : iAlert(NULL), iAlarmAlert(NULL)
1.232 + {}
1.233 +
1.234 +inline TEikServCtrlFactories::TEikServCtrlFactories(MEikServNotifyAlert* aAlert,MEikServAlarmFactory* aAlarmAlert)
1.235 + : iAlert(aAlert), iAlarmAlert(aAlarmAlert)
1.236 + {}
1.237 +
1.238 +NONSHARABLE_CLASS(CEikServSecureData) : public CBase
1.239 +/**
1.240 +@publishedPartner
1.241 +@released
1.242 +*/
1.243 + {
1.244 +public:
1.245 + IMPORT_C static void GetInstalledFepNameL(TDes& aName);
1.246 + IMPORT_C static void SetInstalledFepNameL(const TDesC& aName, TBool aRaiseFileError);
1.247 + IMPORT_C static void OpenFepAttributesL();
1.248 + IMPORT_C static void GetFepAttributeL(TUid aAttribUid, TDes8& aAttribData);
1.249 + IMPORT_C static void SetFepAttributeL(TUid aAttribUid, const TDesC8& aAttribData);
1.250 + IMPORT_C static void CommitFepAttributesL();
1.251 + IMPORT_C static void CloseFepAttributes();
1.252 + IMPORT_C static CBufBase* GetBufferedSystemColorListL();
1.253 + IMPORT_C static void SetBufferedSystemColorListL(const TDesC8& aBuffer);
1.254 +private:
1.255 + CEikServSecureData();
1.256 + };
1.257 +
1.258 +class TErrorFlagAndId
1.259 + {
1.260 +public:
1.261 + TInt iTextId;
1.262 + TUint iFlags;
1.263 + TBool iIsMemoryAllocatedByErrResolver;
1.264 + };
1.265 +
1.266 +#endif // __EIKSRV_H__