os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawScaling.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
sl@0
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0
     2
// All rights reserved.
sl@0
     3
// This component and the accompanying materials are made available
sl@0
     4
// under the terms of "Eclipse Public License v1.0"
sl@0
     5
// which accompanies this distribution, and is available
sl@0
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0
     7
//
sl@0
     8
// Initial Contributors:
sl@0
     9
// Nokia Corporation - initial contribution.
sl@0
    10
//
sl@0
    11
// Contributors:
sl@0
    12
//
sl@0
    13
// Description:
sl@0
    14
//
sl@0
    15
sl@0
    16
#ifndef __BITDRAWSCALING_H__
sl@0
    17
#define __BITDRAWSCALING_H__
sl@0
    18
sl@0
    19
/**
sl@0
    20
MScalingSettings interface manages X-axis and Y-axis scaling factors of CFbsDrawDevice interface.
sl@0
    21
sl@0
    22
The interface could be retrieved calling CFbsDrawDevice::GetInterface() with 
sl@0
    23
KScalingSettingsInterfaceID as an argument.
sl@0
    24
If the draw device does not have support for scaling, MScalingSettings cannot be retrieved.
sl@0
    25
sl@0
    26
MScalingSettings interface lifetime is the same as the lifetime of CFbsDrawDevice
sl@0
    27
interface, which creates it. 
sl@0
    28
Do not try to delete MScalingSettings interface pointer!
sl@0
    29
sl@0
    30
MScalingSettings interface offers following methods: 
sl@0
    31
Get(), Set(), IsScalingOff().
sl@0
    32
sl@0
    33
@see CFbsDrawDevice
sl@0
    34
@internalTechnology
sl@0
    35
*/
sl@0
    36
class MScalingSettings
sl@0
    37
	{
sl@0
    38
public:
sl@0
    39
	/**
sl@0
    40
	Sets scaling factor by which the drawing device should scale the drawing images.
sl@0
    41
	If you want to un-scale the device, call Set() with factorX = 1,  
sl@0
    42
	factorY = 1, divisorX = 1, divisorY = 1.
sl@0
    43
	@param aFactorX Scaling factor for the X-axis of the screen device.
sl@0
    44
	@param aFactorY Scaling factor for the y-axis of the screen device.
sl@0
    45
	@param aDivisorX Not used. Should be set to 1.
sl@0
    46
	@param aDivisorY Not used. Should be set to 1.
sl@0
    47
	@return KErrNone success.
sl@0
    48
	@internalTechnology
sl@0
    49
	*/
sl@0
    50
	virtual TInt Set(TInt aFactorX, TInt aFactorY, TInt aDivisorX, TInt aDivisorY) = 0;
sl@0
    51
	/**
sl@0
    52
	Retrieves X-axis and Y-axis scaling factors.
sl@0
    53
	@param aFactorX Upon return contains X-axis scaling factor.
sl@0
    54
	@param aFactorY Upon return contains Y-axis scaling factor.
sl@0
    55
	@param aDivisorX Upon return contains the decimal fraction of X-axis scaling factor.
sl@0
    56
	@param aDivisorY Upon return contains the decimal fraction of Y-axis scaling factor.
sl@0
    57
	@internalTechnology
sl@0
    58
	*/
sl@0
    59
	virtual void Get(TInt& aFactorX, TInt& aFactorY, TInt& aDivisorX, TInt& aDivisorY) = 0;
sl@0
    60
	/**
sl@0
    61
	Notifies the caller whether the drawing device is scaled or not.
sl@0
    62
	@return ETrue Drawing device is not scaled, EFalse - it is scaled.
sl@0
    63
	@internalTechnology
sl@0
    64
	*/
sl@0
    65
	virtual TBool IsScalingOff() = 0;
sl@0
    66
	};
sl@0
    67
sl@0
    68
#endif//__BITDRAWSCALING_H__