classicui_pub/screen_clearer_api/inc/AknClearer.h
branchRCL_3
changeset 29 a8834a2e9a96
parent 0 2f259fa3e83a
equal deleted inserted replaced
25:941195f2d488 29:a8834a2e9a96
     1 /*
     1 /*
     2 * Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
     2 * Copyright (c) 2002-2010 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     4 * This component and the accompanying materials are made available
     5 * under the terms of "Eclipse Public License v1.0"
     5 * under the terms of "Eclipse Public License v1.0"
     6 * which accompanies this distribution, and is available
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
    84 
    84 
    85     /**
    85     /**
    86     * Sets skin background and shape for the cleared window.
    86     * Sets skin background and shape for the cleared window.
    87     */
    87     */
    88 	void SetSkinShapeL();
    88 	void SetSkinShapeL();
       
    89     
       
    90     /**
       
    91     * Creates the extension class.
       
    92     */
       
    93 	void CreateExtensionL();
       
    94 
       
    95     /**
       
    96     * Sets the clearer as transparent or opaque.
       
    97     *
       
    98     * @param aTransparent @c ETrue to set transparency on,
       
    99 	*                     @c EFalse otherwise.
       
   100     */
       
   101 	void SetTransparent( TBool aTransparent );
    89 
   102 
    90 private:
   103 private:
    91     CAknScreenClearerBaseExtension* iExtension;
   104     CAknScreenClearerBaseExtension* iExtension;
    92 	TBitFlags iFlags;
   105 	TBitFlags iFlags;
    93 	};
   106 	};
   113     * Two-phased constructor.
   126     * Two-phased constructor.
   114     * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   127     * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   115     *                            @c EFalse if not.
   128     *                            @c EFalse if not.
   116     */
   129     */
   117 	IMPORT_C static CAknLocalScreenClearer* NewLC(TBool aBlankAppStatusPane);
   130 	IMPORT_C static CAknLocalScreenClearer* NewLC(TBool aBlankAppStatusPane);
   118 
   131     
       
   132     /**
       
   133     * Two-phased constructor.
       
   134     * @param aBlankAppStatusPane @c ETrue if application status pane is blank,
       
   135     *                            @c EFalse if not.
       
   136     * @param aTransparent        @c ETrue to construct a transparent clearer,
       
   137     *                            @c EFalse to create an opaque one that draws
       
   138     *                            the skin background.
       
   139     */
       
   140     IMPORT_C static CAknLocalScreenClearer* NewLC(TBool aBlankAppStatusPane, TBool aTranparent);
   119     /**
   141     /**
   120     * Two-phased constructor.
   142     * Two-phased constructor.
   121     * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   143     * @param aBlankAppStatusPane @c ETrue if application status pane is blank, 
   122     *                            @c EFalse if not.
   144     *                            @c EFalse if not.
   123     */
   145     */
   124 	IMPORT_C static CAknLocalScreenClearer* NewL(TBool aBlankAppStatusPane);
   146 	IMPORT_C static CAknLocalScreenClearer* NewL(TBool aBlankAppStatusPane);
       
   147 
       
   148     /**
       
   149     * Two-phased constructor.
       
   150     * @param aBlankAppStatusPane @c ETrue if application status pane is blank,
       
   151     *                            @c EFalse if not.
       
   152     * @param aTransparent        @c ETrue to construct a transparent clearer,
       
   153     *                            @c EFalse to create an opaque one that draws
       
   154     *                            the skin background.
       
   155     */
       
   156     IMPORT_C static CAknLocalScreenClearer* NewL(TBool aBlankAppStatusPane, TBool aTransparent);
   125 
   157 
   126     /**
   158     /**
   127     * From CCoeControl
   159     * From CCoeControl
   128     */
   160     */
   129 	IMPORT_C void HandleResourceChange(TInt aType);
   161 	IMPORT_C void HandleResourceChange(TInt aType);