epoc32/include/mw/eikenv.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     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:
    24 #include <apaflrec.h>
    24 #include <apaflrec.h>
    25 #include <apacmdln.h>
    25 #include <apacmdln.h>
    26 #include <badesca.h>
    26 #include <badesca.h>
    27 #include <baerrhan.h>
    27 #include <baerrhan.h>
    28 #include <gulcolor.h>
    28 #include <gulcolor.h>
    29 #include <eikdgfty.h>
       
    30 #include <eikaufty.h>
    29 #include <eikaufty.h>
    31 #include <eiklibry.h>
       
    32 #include <eikamnt.h>
    30 #include <eikamnt.h>
    33 #include <lafmain.h>
    31 #include <lafmain.h>
    34 #include <eikvcurs.h>
    32 #include <eikvcurs.h>
    35 #include <babitflags.h>
    33 #include <babitflags.h>
    36 #include <eikpicturefactory.h>
    34 #include <eikpicturefactory.h>
       
    35 
       
    36 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    37 #include <eikdgfty.h>
       
    38 #include <eiklibry.h>
       
    39 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
       
    40 #include <eikfctry.h>
    37 
    41 
    38 class CEikProcess;
    42 class CEikProcess;
    39 class MEikInfoMsgWin;
    43 class MEikInfoMsgWin;
    40 class MEikBusyMsgWin;
    44 class MEikBusyMsgWin;
    41 class CEikAppUi;
    45 class CEikAppUi;
    66 class CEikEnvExtra;
    70 class CEikEnvExtra;
    67 class TApaApplicationFactory;
    71 class TApaApplicationFactory;
    68 class CEikAppServer;
    72 class CEikAppServer;
    69 class CLafSystemFont;
    73 class CLafSystemFont;
    70 class RApaLsSession;
    74 class RApaLsSession;
       
    75 class MEikCDlgDialogFactory;
       
    76 class MEikPrintDialogFactory;
       
    77 class MEikFileDialogFactory;
       
    78 class CEikAutoMenuTitleArray;
       
    79 
    71 
    80 
    72 /**
    81 /**
    73 @publishedAll
    82 @publishedAll
    74 @released
    83 @released
    75 */
    84 */
    76 typedef void (*TRequestDialogFunc)();
    85 typedef void (*TRequestDialogFunc)();
    77 
       
    78 /**
       
    79 @internalComponent
       
    80 */
       
    81 const TUid KUikonLibraryUid = {KUidUikonLibraryValue};
       
    82 
       
    83 /**
       
    84 Creates the CEikLibrary interface object by calling the first ordinal function which is mapped to NewL method.
       
    85 
       
    86 The function leaves with KErrBadLibraryEntryPoint if the ordinal 1 function 
       
    87 cannot be found.
       
    88 
       
    89 @publishedPartner
       
    90 @released
       
    91 */
       
    92 typedef CEikLibrary* (*EikLibraryEntryPoint)();
       
    93 
       
    94 
    86 
    95 /** An environment for creating controls and utility functions for manipulating 
    87 /** An environment for creating controls and utility functions for manipulating 
    96 them. 
    88 them. 
    97 
    89 
    98 Every GUI application is provided with an instance of CEikonEnv 
    90 Every GUI application is provided with an instance of CEikonEnv 
   312 	void InitSystemBitmapsL();
   304 	void InitSystemBitmapsL();
   313 	void UpdateColorListL();
   305 	void UpdateColorListL();
   314 	void PostAppUiInitializeL();
   306 	void PostAppUiInitializeL();
   315 	TLanguage ApplicationLanguage() const;
   307 	TLanguage ApplicationLanguage() const;
   316 	void PostAppUiDestroy();
   308 	void PostAppUiDestroy();
       
   309 	TInt ConstructorError() const;
   317 private:
   310 private:
   318 	IMPORT_C virtual void CEikonEnv_Reserved_1();
   311 	IMPORT_C virtual void CEikonEnv_Reserved_1();
   319 	IMPORT_C virtual void CEikonEnv_Reserved_2();
   312 	IMPORT_C virtual void CEikonEnv_Reserved_2();
   320 	IMPORT_C virtual void CEikonEnv_Reserved_3();
   313 	IMPORT_C virtual void CEikonEnv_Reserved_3();
   321 	IMPORT_C virtual void CEikonEnv_Reserved_4();
   314 	IMPORT_C virtual void CEikonEnv_Reserved_4();
   443 	@return True if the Confirm button (or equivalent) was pressed, false if the 
   436 	@return True if the Confirm button (or equivalent) was pressed, false if the 
   444 	dialog was cancelled. */
   437 	dialog was cancelled. */
   445 	virtual TBool RunDlgLD(TInt aResource, const TDesC& aTitle, const TDesC& aMsg) = 0;
   438 	virtual TBool RunDlgLD(TInt aResource, const TDesC& aTitle, const TDesC& aMsg) = 0;
   446 	};
   439 	};
   447 
   440 
   448 
       
   449 /**
       
   450 @publishedPartner
       
   451 @released
       
   452 */
       
   453 class MEikAlertWin
       
   454 	{
       
   455 public:
       
   456 	virtual void ConstructL() = 0;
       
   457 	virtual void RunAlert(const TDesC& aTitle, const TDesC& aMsg) = 0;
       
   458 	virtual void Release() = 0;
       
   459 	virtual CEikDialog* AsEikDialog() = 0;
       
   460 	inline const CEikDialog* AsEikDialog() const;
       
   461 	IMPORT_C virtual CCoeControl* AsCoeControl();
       
   462 	inline const CCoeControl* AsCoeControl() const;
       
   463 private:
       
   464 	IMPORT_C virtual void MEikAlertWin_Reserved2();
       
   465 	IMPORT_C virtual void MEikAlertWin_Reserved3();
       
   466 	};
       
   467 
       
   468 
       
   469 /**
       
   470 @publishedPartner 
       
   471 @released 
       
   472 */
       
   473 class MEikDebugKeys
       
   474 	{
       
   475 public:
       
   476 	virtual void ConstructL() = 0;
       
   477 	virtual void Release() = 0;
       
   478 private:
       
   479 	IMPORT_C virtual void MEikDebugKeys_Reserved1();
       
   480 	IMPORT_C virtual void MEikDebugKeys_Reserved2();
       
   481 	IMPORT_C virtual void MEikDebugKeys_Reserved3();
       
   482 	};
       
   483 
       
   484 
       
   485 IMPORT_C void InternalizeL(TEikPortFlag& aThing,RReadStream& aStream);
   441 IMPORT_C void InternalizeL(TEikPortFlag& aThing,RReadStream& aStream);
   486 inline RWriteStream& operator<<(RWriteStream& aStream,const TEikPortFlag& aThing)
   442 inline RWriteStream& operator<<(RWriteStream& aStream,const TEikPortFlag& aThing)
   487 	{aStream.WriteUint8L(aThing);return aStream;}
   443 	{aStream.WriteUint8L(aThing);return aStream;}
   488 inline RReadStream& operator>>(RReadStream& aStream,TEikPortFlag& aThing)
   444 inline RReadStream& operator>>(RReadStream& aStream,TEikPortFlag& aThing)
   489 	{InternalizeL(aThing,aStream);return aStream;}
   445 	{InternalizeL(aThing,aStream);return aStream;}
   490 
   446 
       
   447 /**
       
   448 @publishedAll
       
   449 @released
       
   450 */
       
   451 class MEikAlertWin
       
   452     {
       
   453 public:
       
   454     virtual void ConstructL() = 0;
       
   455     virtual void RunAlert(const TDesC& aTitle, const TDesC& aMsg) = 0;
       
   456     virtual void Release() = 0;
       
   457     virtual CEikDialog* AsEikDialog() = 0;
       
   458     inline const CEikDialog* AsEikDialog() const;
       
   459     IMPORT_C virtual CCoeControl* AsCoeControl();
       
   460     inline const CCoeControl* AsCoeControl() const;
       
   461 private:
       
   462     IMPORT_C virtual void MEikAlertWin_Reserved2();
       
   463     IMPORT_C virtual void MEikAlertWin_Reserved3();
       
   464     };
       
   465 
       
   466 
       
   467 /**
       
   468 @publishedAll
       
   469 @released 
       
   470 */
       
   471 class MEikDebugKeys
       
   472     {
       
   473 public:
       
   474     virtual void ConstructL() = 0;
       
   475     virtual void Release() = 0;
       
   476 private:
       
   477     IMPORT_C virtual void MEikDebugKeys_Reserved1();
       
   478     IMPORT_C virtual void MEikDebugKeys_Reserved2();
       
   479     IMPORT_C virtual void MEikDebugKeys_Reserved3();
       
   480     };
       
   481 
   491 #include <eikenv.inl>
   482 #include <eikenv.inl>
       
   483 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
   484 #include <uikon/eikenvinterface.h>
       
   485 #endif //SYMBIAN_ENABLE_SPLIT_HEADERS
   492 
   486 
   493 #endif	// __EIKENV_H__
   487 #endif	// __EIKENV_H__