taskswitcher/contextengine/tsfswpreviewprovider/inc/tspreviewobserver.h
author Pat Downey <patd@symbian.org>
Wed, 01 Sep 2010 12:32:46 +0100
branchRCL_3
changeset 83 5456b4e8b3a8
child 88 3321d3e205b6
permissions -rw-r--r--
Revert incorrect RCL_3 drop: Revision: 201033 Kit: 201035

/*
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description:  Preview provider API
*
*/


#ifndef TSPREVIEWOBSERVER_H
#define TSPREVIEWOBSERVER_H

// INCLUDES
#include <e32base.h>

/**
 * Observer for preview screenshot changes. Client must implement this and 
 * register itself when calling CTsFastSwapPreviewProvider::NewL. Callback
 * methods are called whenever there is a new preview screenshot taken from
 * the applications or when an application is exited.
 *
 * @see CTsFastSwapPreviewProvider
 */
class MTsFastSwapPreviewObserver
    {
public:

    /**
     * Called when application has changed and screenshot has been taken. 
     * New sceenshots will be taken and provided to the client via this 
     * callback every time the application goes to background.
     *
     * @param aWgId Window group id of the application.
     * @param aFbsHandle Handle to screenshot CFbsBitmap.
     */         
    virtual void HandleFswPpApplicationChange( TInt aWgId, TInt aFbsHandle ) = 0;
    
    /**
     * Called when application has been exited. Client can free the resources
     * related to aWgId (for example a copied bitmap) since the application is
     * no more running.
     *
     * @param aWgId Window group id of the application.
     */         
    virtual void HandleFswPpApplicationUnregistered( TInt aWgId ) = 0;
    
    /**
     * Called when screenshot for the application needs rotation. Client should
     * rotate bitmap for the given aWgId by 90 degrees, otherwise it will be
     * displayed incorrectly.
     * 
     * @param aWgId Window group id of the application
     * @param aClockwise marks direction of the rotation (ETrue - clockwise, EFalse - counter clockwise)
     */
    virtual void HandleFswPpApplicationBitmapRotation( TInt aWgId, TBool aClockwise ) = 0;
    };

#endif // TSPREVIEWOBSERVER_H

// End of file