epoc32/include/eikinfomsgwin.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2004-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 #ifndef __EIKINFOMSGWIN_H__
    18 #define __EIKINFOMSGWIN_H__
    19 
    20 /** An interface class for creating customized info message windows 
    21 
    22 @publishedPartner 
    23 @released */
    24 class MEikInfoMsgWin
    25 	{
    26 public:
    27 
    28 	/** Displays an information message window for a specified duration.
    29 	@param aText The text for the information message.
    30 	@param aCorner The alignment for the information message.
    31 	@param aDuration The time period for the information message. */
    32     virtual void StartDisplaySpecifyingDuration(const TDesC& aText, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aDuration) = 0;
    33 	
    34 	/** Displays the message window with the specified text and alignment.
    35 	@param aText The text to display in the message. 
    36 	@param aCorner The position in which the message window will appear. There 
    37 	are 9 options for this, each square of a 3 by 3 matrix on the screen. */	
    38 	virtual void StartDisplay(const TDesC& aText, TGulAlignment aCorner) =0;
    39 	
    40 	/** Stops displaying the message window. 
    41 	*/	
    42 	virtual void CancelDisplay() =0;
    43 	
    44 	/** Deletes the object, calling it's private destructor.
    45 	*/	
    46 	virtual void Release() = 0;
    47 	};
    48 	
    49 #endif	// __EIKINFOMSGWIN_H__