epoc32/include/eikmsg.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- a/epoc32/include/eikmsg.h	Tue Mar 16 16:12:26 2010 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,148 +0,0 @@
     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 __EIKMSG_H__
    1.20 -#define __EIKMSG_H__
    1.21 -
    1.22 -#include <clock.h>
    1.23 -#include <gulalign.h>
    1.24 -
    1.25 -#include <eikinfomsgwin.h>
    1.26 -#include <eikbusymsgwin.h>
    1.27 -
    1.28 -class CCoeControl;
    1.29 -class CEikonEnv;
    1.30 -class RWindowGroup;
    1.31 -class CEikResourceChange;
    1.32 -
    1.33 -
    1.34 -/** Base class providing functions to construct and display an information message. 
    1.35 -
    1.36 -@publishedAll
    1.37 -@released */
    1.38 -class CEikMsgWin : public CBase
    1.39 -	{
    1.40 -protected:
    1.41 -	IMPORT_C CEikMsgWin(CEikonEnv& aEikonEnv);
    1.42 -public:
    1.43 -	IMPORT_C void ConstructL(RWindowGroup& aWindowGroup);
    1.44 -	IMPORT_C virtual ~CEikMsgWin();
    1.45 -	IMPORT_C void StartDisplay(const TDesC& aText, TGulAlignment aCorner);
    1.46 -	IMPORT_C void CancelDisplay();
    1.47 -private:
    1.48 -	IMPORT_C virtual void CEikMsgWin_Reserved1();
    1.49 -	IMPORT_C virtual void CEikMsgWin_Reserved2();
    1.50 -protected:
    1.51 -	TDes& PrepareDisplay(TDes& aText, TGulAlignment aCorner);
    1.52 -private:
    1.53 -	virtual void DoStartDisplay(const TDesC& aText)=0;
    1.54 -protected:
    1.55 -	/** A CEikonEnv*, which all applications have. This is required for construction 
    1.56 -	of a CEikMsgWin as it provides access to services which the message window 
    1.57 -	needs, the window server session for example. */
    1.58 -	CEikonEnv& iEikonEnv_; // the underscore is to prevent a name clash with the iEikonEnv #define
    1.59 -	/** An empty control required for construction of a blank window. This defines 
    1.60 -	a handle back to the client side object, which is only required if you need 
    1.61 -	to later initiate client side drawing. */
    1.62 -	CCoeControl* iDummy;
    1.63 -	/** The window in which the message will be drawn. */
    1.64 -	RBlankWindow* iBlankWindow;
    1.65 -	/** An RAnim derived class, which is responsible for interacting with server side 
    1.66 -	classes to provide the message window's animation on the screen. It is constructed 
    1.67 -	by passing in the RWindowBase which it will use to draw its contents to, and 
    1.68 -	also a handle to an animation DLL, which provides the animation functionality. */
    1.69 -	RMessageWindow* iMessageWindow;
    1.70 -private:
    1.71 -	CEikResourceChange* iResourceChange;
    1.72 -	TInt iCEikMsgWin_Spare1;
    1.73 -	};
    1.74 -
    1.75 -/**
    1.76 -@publishedAll
    1.77 -@released
    1.78 -*/
    1.79 -const TInt KEikInfoMsgMaxLen=RMessageWindow::EMaxTextLength;
    1.80 -
    1.81 -/** Specifies the maximum length of the message buffer. 
    1.82 -
    1.83 -@publishedAll
    1.84 -@released */
    1.85 -typedef TBuf<KEikInfoMsgMaxLen> TEikInfoMsgBuf;
    1.86 -
    1.87 -class CEikInfoMsgWin : public CEikMsgWin, public MEikInfoMsgWin
    1.88 -/** Enables construction of an information message window. 
    1.89 -
    1.90 -@publishedAll 
    1.91 -@released */
    1.92 -	{
    1.93 -public:
    1.94 -	IMPORT_C void ConstructL(RWindowGroup& aWindowGroup, TInt aParam = 0);
    1.95 -	IMPORT_C CEikInfoMsgWin(CEikonEnv& aEikonEnv);
    1.96 -public:  //from MEikInfoMsgWin
    1.97 -	IMPORT_C void StartDisplaySpecifyingDuration(const TDesC& aText, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aDuration);	
    1.98 -	IMPORT_C void StartDisplay(const TDesC& aText, TGulAlignment aCorner);
    1.99 -	IMPORT_C void CancelDisplay();
   1.100 -	IMPORT_C void Release();
   1.101 -private:
   1.102 -	virtual void DoStartDisplay(const TDesC& aText);
   1.103 -	IMPORT_C virtual void CEikInfoMsgWin_Reserved1();
   1.104 -	IMPORT_C virtual void CEikInfoMsgWin_Reserved2();
   1.105 -private: // From CEikMsgWin. do not override!
   1.106 -	IMPORT_C void CEikMsgWin_Reserved1();
   1.107 -	IMPORT_C void CEikMsgWin_Reserved2();
   1.108 -private:
   1.109 -	TInt iCEikInfoMsgWin_Spare1;
   1.110 -	};
   1.111 -
   1.112 -
   1.113 -/**
   1.114 -@publishedAll
   1.115 -@released
   1.116 -*/
   1.117 -const TInt KEikBusyMsgMaxLen=RMessageWindow::EMaxTextLength;
   1.118 -
   1.119 -/**
   1.120 -@publishedAll
   1.121 -@released
   1.122 -*/
   1.123 -typedef TBuf<KEikBusyMsgMaxLen> TEikBusyMsgBuf;
   1.124 -
   1.125 -/** 
   1.126 -@publishedAll 
   1.127 -@released
   1.128 -*/
   1.129 -class CEikBusyMsgWin : public CEikMsgWin, public MEikBusyMsgWin
   1.130 -	{
   1.131 -public:
   1.132 -	IMPORT_C void ConstructL(RWindowGroup& aWindowGroup);
   1.133 -	IMPORT_C CEikBusyMsgWin(CEikonEnv& aEikonEnv);
   1.134 -public:   //from MEikBusyMsgWin
   1.135 -	IMPORT_C void StartDisplaySpecifyingInitialDelay(const TDesC& aText, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aInitialDelay);
   1.136 -	IMPORT_C void StartDisplay(const TDesC& aText, TGulAlignment aCorner);
   1.137 -	IMPORT_C void Release();
   1.138 -private:
   1.139 -	IMPORT_C virtual void CEikBusyMsgWin_Reserved1();
   1.140 -	IMPORT_C virtual void CEikBusyMsgWin_Reserved2();
   1.141 -private: // From CEikMsgWin. do not override!
   1.142 -	IMPORT_C void CEikMsgWin_Reserved1();
   1.143 -	IMPORT_C void CEikMsgWin_Reserved2();
   1.144 -private:
   1.145 -	virtual void DoStartDisplay(const TDesC& aText);
   1.146 -private:
   1.147 -	TTimeIntervalMicroSeconds32 iInitialDelay;
   1.148 -	TInt iCEikBusyMsgWin_Spare1;
   1.149 -	};
   1.150 -
   1.151 -#endif	// __EIKMSG_H__