epoc32/include/eikbusymsgwin.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
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __EIKBUSYMSGWIN_H__
williamr@2
    17
#define __EIKBUSYMSGWIN_H__
williamr@2
    18
williamr@2
    19
/** An interface class for creating customized busy message windows 
williamr@2
    20
williamr@2
    21
@publishedPartner 
williamr@2
    22
@released */
williamr@2
    23
class MEikBusyMsgWin
williamr@2
    24
	{
williamr@2
    25
public:
williamr@2
    26
	/** Displays a busy message window after a specified duration.
williamr@2
    27
	@param aText The text for the busy message.
williamr@2
    28
	@param aCorner The alignment for the busy message.
williamr@2
    29
	@param aInitialDelay The time period after which the busy message is displayed. */
williamr@2
    30
	virtual void StartDisplaySpecifyingInitialDelay(const TDesC& aText, TGulAlignment aCorner, TTimeIntervalMicroSeconds32 aInitialDelay) =0;
williamr@2
    31
williamr@2
    32
	/** Displays the message window with the specified text and alignment.
williamr@2
    33
williamr@2
    34
	@param aText The text to display in the message. 
williamr@2
    35
	@param aCorner The position in which the message window will appear. There 
williamr@2
    36
	are 9 options for this, each square of a 3 by 3 matrix on the screen. */
williamr@2
    37
	virtual void StartDisplay(const TDesC& aText, TGulAlignment aCorner) =0;
williamr@2
    38
	
williamr@2
    39
	/** Deletes the object, calling it's private destructor.
williamr@2
    40
	*/
williamr@2
    41
	virtual void Release() = 0;
williamr@2
    42
	};
williamr@2
    43
	
williamr@2
    44
#endif	// __EIKBUSYMSGWIN_H__