1.1 --- a/epoc32/include/mw/aknclearer.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/aknclearer.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,133 @@
     1.4 -aknclearer.h
     1.5 +/*
     1.6 +* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:  Screen Clearer API, support for screen blanking.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef AKNCLEARER_H
    1.24 +#define AKNCLEARER_H
    1.25 +
    1.26 +#include <AknControl.h>
    1.27 +
    1.28 +#include <eikenv.h>
    1.29 +
    1.30 +class CAknScreenClearerBaseExtension;
    1.31 +
    1.32 +/**
    1.33 +*  This class is base class for screen blanking.
    1.34 +*
    1.35 +*  @since Series 60 0.9
    1.36 +*/
    1.37 +class CAknScreenClearerBase : public CAknControl
    1.38 +	{
    1.39 +public:
    1.40 +
    1.41 +	/**
    1.42 +	* Handles situation when status pane size changes.
    1.43 +	*/
    1.44 +	IMPORT_C void HandleStatusPaneSizeChangeL();
    1.45 +    
    1.46 +public: // from CCoeControl
    1.47 +
    1.48 +    /**
    1.49 +    * From CCoeControl.
    1.50 +	*/
    1.51 +    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);	
    1.52 +
    1.53 +protected:
    1.54 +    
    1.55 +    /**
    1.56 +    * Destructor.
    1.57 +	*/
    1.58 +	IMPORT_C virtual ~CAknScreenClearerBase();
    1.59 +	
    1.60 +    /**
    1.61 +    * Symbian 2nd phase constructor.
    1.62 +    *
    1.63 +    * @param aParent Parent window group.
    1.64 +    * @param aOrdinalPos Ordinal position of the blank window.
    1.65 +    * @param aBlankAppStatusPane A flag to decide if application status pane area is to blanked or not.
    1.66 +	*/
    1.67 +	IMPORT_C void ConstructL(RWindowGroup& aParent, TInt aOrdinalPos, TBool aBlankAppStatusPane);
    1.68 +
    1.69 +private: // from CCoeControl
    1.70 +	
    1.71 +    /**
    1.72 +    * From CCoeControl.
    1.73 +	*/
    1.74 +	IMPORT_C void Draw(const TRect& aRect) const;
    1.75 +
    1.76 +private: // from CAknControl
    1.77 +    /**
    1.78 +    * From CAknControl.
    1.79 +    */
    1.80 +    IMPORT_C void* ExtensionInterface( TUid aInterface );
    1.81 +
    1.82 +protected:
    1.83 +    
    1.84 +    /**
    1.85 +    * Sets shape for the cleared window.
    1.86 +    */
    1.87 +	void SetShapeL();
    1.88 +
    1.89 +    /**
    1.90 +    * Sets skin background and shape for the cleared window.
    1.91 +    */
    1.92 +	void SetSkinShapeL();
    1.93 +
    1.94 +private:
    1.95 +    CAknScreenClearerBaseExtension* iExtension;
    1.96 +	TBitFlags iFlags;
    1.97 +	};
    1.98 +
    1.99 +
   1.100 +// CLASS DECLARATION
   1.101 +
   1.102 +/**
   1.103 +*  This class is for use inside applications for screen blanking.
   1.104 +*
   1.105 +*  @since Series 60 0.9
   1.106 +*/
   1.107 +class CAknLocalScreenClearer : public CAknScreenClearerBase
   1.108 +	{
   1.109 +public:
   1.110 +
   1.111 +    /**
   1.112 +    * Two-phased constructor.
   1.113 +    */
   1.114 +	IMPORT_C static CAknLocalScreenClearer* NewLC();
   1.115 +
   1.116 +    /**
   1.117 +    * Two-phased constructor.
   1.118 +    * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   1.119 +    *                            @c EFalse if not.
   1.120 +    */
   1.121 +	IMPORT_C static CAknLocalScreenClearer* NewLC(TBool aBlankAppStatusPane);
   1.122 +
   1.123 +    /**
   1.124 +    * Two-phased constructor.
   1.125 +    * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   1.126 +    *                            @c EFalse if not.
   1.127 +    */
   1.128 +	IMPORT_C static CAknLocalScreenClearer* NewL(TBool aBlankAppStatusPane);
   1.129 +
   1.130 +    /**
   1.131 +    * From CCoeControl
   1.132 +    */
   1.133 +	IMPORT_C void HandleResourceChange(TInt aType);
   1.134 +
   1.135 +	};
   1.136 +
   1.137 +#endif // AKNCLEARER_H