epoc32/include/mw/aknclearer.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:  Screen Clearer API, support for screen blanking.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef AKNCLEARER_H
williamr@2
    20
#define AKNCLEARER_H
williamr@2
    21
williamr@2
    22
#include <AknControl.h>
williamr@2
    23
williamr@2
    24
#include <eikenv.h>
williamr@2
    25
williamr@2
    26
class CAknScreenClearerBaseExtension;
williamr@2
    27
williamr@2
    28
/**
williamr@2
    29
*  This class is base class for screen blanking.
williamr@2
    30
*
williamr@2
    31
*  @since Series 60 0.9
williamr@2
    32
*/
williamr@2
    33
class CAknScreenClearerBase : public CAknControl
williamr@2
    34
	{
williamr@2
    35
public:
williamr@2
    36
williamr@2
    37
	/**
williamr@2
    38
	* Handles situation when status pane size changes.
williamr@2
    39
	*/
williamr@2
    40
	IMPORT_C void HandleStatusPaneSizeChangeL();
williamr@2
    41
    
williamr@2
    42
public: // from CCoeControl
williamr@2
    43
williamr@2
    44
    /**
williamr@2
    45
    * From CCoeControl.
williamr@2
    46
	*/
williamr@2
    47
    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);	
williamr@2
    48
williamr@2
    49
protected:
williamr@2
    50
    
williamr@2
    51
    /**
williamr@2
    52
    * Destructor.
williamr@2
    53
	*/
williamr@2
    54
	IMPORT_C virtual ~CAknScreenClearerBase();
williamr@2
    55
	
williamr@2
    56
    /**
williamr@2
    57
    * Symbian 2nd phase constructor.
williamr@2
    58
    *
williamr@2
    59
    * @param aParent Parent window group.
williamr@2
    60
    * @param aOrdinalPos Ordinal position of the blank window.
williamr@2
    61
    * @param aBlankAppStatusPane A flag to decide if application status pane area is to blanked or not.
williamr@2
    62
	*/
williamr@2
    63
	IMPORT_C void ConstructL(RWindowGroup& aParent, TInt aOrdinalPos, TBool aBlankAppStatusPane);
williamr@2
    64
williamr@2
    65
private: // from CCoeControl
williamr@2
    66
	
williamr@2
    67
    /**
williamr@2
    68
    * From CCoeControl.
williamr@2
    69
	*/
williamr@2
    70
	IMPORT_C void Draw(const TRect& aRect) const;
williamr@2
    71
williamr@2
    72
private: // from CAknControl
williamr@2
    73
    /**
williamr@2
    74
    * From CAknControl.
williamr@2
    75
    */
williamr@2
    76
    IMPORT_C void* ExtensionInterface( TUid aInterface );
williamr@2
    77
williamr@2
    78
protected:
williamr@2
    79
    
williamr@2
    80
    /**
williamr@2
    81
    * Sets shape for the cleared window.
williamr@2
    82
    */
williamr@2
    83
	void SetShapeL();
williamr@2
    84
williamr@2
    85
    /**
williamr@2
    86
    * Sets skin background and shape for the cleared window.
williamr@2
    87
    */
williamr@2
    88
	void SetSkinShapeL();
williamr@2
    89
williamr@2
    90
private:
williamr@2
    91
    CAknScreenClearerBaseExtension* iExtension;
williamr@2
    92
	TBitFlags iFlags;
williamr@2
    93
	};
williamr@2
    94
williamr@2
    95
williamr@2
    96
// CLASS DECLARATION
williamr@2
    97
williamr@2
    98
/**
williamr@2
    99
*  This class is for use inside applications for screen blanking.
williamr@2
   100
*
williamr@2
   101
*  @since Series 60 0.9
williamr@2
   102
*/
williamr@2
   103
class CAknLocalScreenClearer : public CAknScreenClearerBase
williamr@2
   104
	{
williamr@2
   105
public:
williamr@2
   106
williamr@2
   107
    /**
williamr@2
   108
    * Two-phased constructor.
williamr@2
   109
    */
williamr@2
   110
	IMPORT_C static CAknLocalScreenClearer* NewLC();
williamr@2
   111
williamr@2
   112
    /**
williamr@2
   113
    * Two-phased constructor.
williamr@2
   114
    * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
williamr@2
   115
    *                            @c EFalse if not.
williamr@2
   116
    */
williamr@2
   117
	IMPORT_C static CAknLocalScreenClearer* NewLC(TBool aBlankAppStatusPane);
williamr@2
   118
williamr@2
   119
    /**
williamr@2
   120
    * Two-phased constructor.
williamr@2
   121
    * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
williamr@2
   122
    *                            @c EFalse if not.
williamr@2
   123
    */
williamr@2
   124
	IMPORT_C static CAknLocalScreenClearer* NewL(TBool aBlankAppStatusPane);
williamr@2
   125
williamr@2
   126
    /**
williamr@2
   127
    * From CCoeControl
williamr@2
   128
    */
williamr@2
   129
	IMPORT_C void HandleResourceChange(TInt aType);
williamr@2
   130
williamr@2
   131
	};
williamr@2
   132
williamr@2
   133
#endif // AKNCLEARER_H