os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawScaling.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawScaling.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,68 @@
     1.4 +// Copyright (c) 2004-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 "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.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 __BITDRAWSCALING_H__
    1.20 +#define __BITDRAWSCALING_H__
    1.21 +
    1.22 +/**
    1.23 +MScalingSettings interface manages X-axis and Y-axis scaling factors of CFbsDrawDevice interface.
    1.24 +
    1.25 +The interface could be retrieved calling CFbsDrawDevice::GetInterface() with 
    1.26 +KScalingSettingsInterfaceID as an argument.
    1.27 +If the draw device does not have support for scaling, MScalingSettings cannot be retrieved.
    1.28 +
    1.29 +MScalingSettings interface lifetime is the same as the lifetime of CFbsDrawDevice
    1.30 +interface, which creates it. 
    1.31 +Do not try to delete MScalingSettings interface pointer!
    1.32 +
    1.33 +MScalingSettings interface offers following methods: 
    1.34 +Get(), Set(), IsScalingOff().
    1.35 +
    1.36 +@see CFbsDrawDevice
    1.37 +@internalTechnology
    1.38 +*/
    1.39 +class MScalingSettings
    1.40 +	{
    1.41 +public:
    1.42 +	/**
    1.43 +	Sets scaling factor by which the drawing device should scale the drawing images.
    1.44 +	If you want to un-scale the device, call Set() with factorX = 1,  
    1.45 +	factorY = 1, divisorX = 1, divisorY = 1.
    1.46 +	@param aFactorX Scaling factor for the X-axis of the screen device.
    1.47 +	@param aFactorY Scaling factor for the y-axis of the screen device.
    1.48 +	@param aDivisorX Not used. Should be set to 1.
    1.49 +	@param aDivisorY Not used. Should be set to 1.
    1.50 +	@return KErrNone success.
    1.51 +	@internalTechnology
    1.52 +	*/
    1.53 +	virtual TInt Set(TInt aFactorX, TInt aFactorY, TInt aDivisorX, TInt aDivisorY) = 0;
    1.54 +	/**
    1.55 +	Retrieves X-axis and Y-axis scaling factors.
    1.56 +	@param aFactorX Upon return contains X-axis scaling factor.
    1.57 +	@param aFactorY Upon return contains Y-axis scaling factor.
    1.58 +	@param aDivisorX Upon return contains the decimal fraction of X-axis scaling factor.
    1.59 +	@param aDivisorY Upon return contains the decimal fraction of Y-axis scaling factor.
    1.60 +	@internalTechnology
    1.61 +	*/
    1.62 +	virtual void Get(TInt& aFactorX, TInt& aFactorY, TInt& aDivisorX, TInt& aDivisorY) = 0;
    1.63 +	/**
    1.64 +	Notifies the caller whether the drawing device is scaled or not.
    1.65 +	@return ETrue Drawing device is not scaled, EFalse - it is scaled.
    1.66 +	@internalTechnology
    1.67 +	*/
    1.68 +	virtual TBool IsScalingOff() = 0;
    1.69 +	};
    1.70 +
    1.71 +#endif//__BITDRAWSCALING_H__