epoc32/include/uiklaf/private/lafmsg.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
     1.1 --- a/epoc32/include/uiklaf/private/lafmsg.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,129 +0,0 @@
     1.4 -// Copyright (c) 2000-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 __LAFMSG_H__
    1.20 -#define __LAFMSG_H__
    1.21 -
    1.22 -#include <e32std.h>
    1.23 -#include <clock.h>
    1.24 -#include <gulalign.h>
    1.25 -#include <coemain.h>
    1.26 -#include <lafmain.h>
    1.27 -
    1.28 -
    1.29 -class LafMsgWin
    1.30 -/** Provides LAF settings for the system environment's message windows (CEikMsgWin).
    1.31 -
    1.32 -@publishedPartner
    1.33 -@released */
    1.34 -	{
    1.35 -public:
    1.36 -	class TDisplayParameters;
    1.37 -public:
    1.38 -	/** Sets the shadow on the blank window which the message is contained in. 
    1.39 -	
    1.40 -	@param aBlankWindow Message window */
    1.41 -	IMPORT_C static void SetUpBlankWindow(RBlankWindow& aBlankWindow);
    1.42 -	/** Completes the intitialisation of the message window.
    1.43 -	
    1.44 -	This function should select a font and call RMessageWindow::ConstructL() for 
    1.45 -	aMessageWin.
    1.46 -	
    1.47 -	@param aMessageWin Message window
    1.48 -	@param aEnv LAF environment functions */
    1.49 -	IMPORT_C static void CompleteMessageWinConstructionL(RMessageWindow& aMessageWin,const MLafEnv& aEnv);
    1.50 -	/** Handles a change to the system resources that may affect how the window is 
    1.51 -	displayed.
    1.52 -	
    1.53 -	The function should update aMessageWin appropriately.
    1.54 -	
    1.55 -	@param aMessageWin Message window
    1.56 -	@param aEnv LAF environment functions */
    1.57 -	IMPORT_C static void HandleResourceChange(RMessageWindow& aMessageWin,const MLafEnv& aEnv);
    1.58 -	/** Formats message text display.
    1.59 -	
    1.60 -	The function should truncate the text in aParams.iTextToDisplay to fit 
    1.61 -	the device display, and set aParms.iMsgWinSize and aParams.iMsgWinPosition 
    1.62 -	appropriately, depending on the corner aParams.iDisplayCorner, and the 
    1.63 -	font for the device.
    1.64 -	
    1.65 -	aParams.iClientRect is provided for devices that wish to set the position 
    1.66 -	relative to the client rect of the application rather than the screen rect.
    1.67 -	
    1.68 -	@param aParams Display parameters
    1.69 -	@param aEnv LAF environment functions */
    1.70 -	IMPORT_C static void ConfigureText(TDisplayParameters& aParams,const MLafEnv& aEnv);
    1.71 -	};
    1.72 -
    1.73 -
    1.74 -class LafMsgWin::TDisplayParameters
    1.75 -/** Holds message window text display parameters.
    1.76 -
    1.77 -@publishedPartner
    1.78 -@released */
    1.79 -	{
    1.80 -public:
    1.81 -	/** Constructor. 
    1.82 -
    1.83 -	@param aTextToDispay Message window text. */
    1.84 -	IMPORT_C TDisplayParameters(TDes& aTextToDispay);
    1.85 -public:
    1.86 -	/** Message window position. */
    1.87 -	TPoint iMsgWinPosition;
    1.88 -	/** Message window size. */
    1.89 -	TSize  iMsgWinSize;
    1.90 -	/** Message window text. */
    1.91 -	TDes&  iTextToDisplay;
    1.92 -	/** Message window margins. */
    1.93 -	TMargins iMsgWinBorders;
    1.94 -	/** Message window alignment. */
    1.95 -	TGulAlignment iDisplayCorner;
    1.96 -	/** Associated control environment. */
    1.97 -	CCoeEnv* iEnv;
    1.98 -	/** Message window client screen area. */
    1.99 -	TRect iClientRect;
   1.100 -	};
   1.101 -
   1.102 -
   1.103 -class LafInfoMsgWin
   1.104 -/** Provides LAF settings for the system environment's information message 
   1.105 -window (CEikonEnv::InfoMsg() etc.).
   1.106 -
   1.107 -@publishedPartner
   1.108 -@released */
   1.109 -	{
   1.110 -public:
   1.111 -	/** Gets the default number of microseconds for which a message is displayed. 
   1.112 -	
   1.113 -	@return Default duration */
   1.114 -	IMPORT_C static TTimeIntervalMicroSeconds32 DefaultDuration();
   1.115 -	};
   1.116 -
   1.117 -
   1.118 -class LafBusyMsgWin
   1.119 -/** Provides LAF settings for the system environment's busy message window 
   1.120 -(CEikonEnv::BusyMsgL()).
   1.121 -
   1.122 -@publishedPartner
   1.123 -@released */
   1.124 -	{
   1.125 -public:
   1.126 -	/** Gets the default number of microseconds for which a message is displayed. 
   1.127 -	
   1.128 -	@return Default delay */
   1.129 -	IMPORT_C static TTimeIntervalMicroSeconds32 DefaultInitialDelay();
   1.130 -	};
   1.131 -
   1.132 -#endif //__LAFMSG_H__