os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawOrigin.h
changeset 0 bde4ae8d615e
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawOrigin.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,57 @@
     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 __BITDRAWORIGIN_H__
    1.20 +#define __BITDRAWORIGIN_H__
    1.21 +
    1.22 +/**
    1.23 +MDrawDeviceOrigin interface manages the origin point of CFbsDrawDevice interface.
    1.24 +
    1.25 +The interface could be retrieved calling CFbsDrawDevice::GetInterface() with 
    1.26 +KDrawDeviceOriginInterfaceID as an argument.
    1.27 +If the drawing device does not have support for moving origin, MDrawDeviceOrigin cannot be retrieved.
    1.28 +   
    1.29 +MDrawDeviceOrigin interface lifetime is the same as the lifetime of CFbsDrawDevice
    1.30 +interface, which creates it. 
    1.31 +Do not try to delete MDrawDeviceOrigin interface pointer!
    1.32 +   
    1.33 +MDrawDeviceOrigin interface offers following methods: 
    1.34 +Get(), Set().
    1.35 +   
    1.36 +@see CFbsDrawDevice
    1.37 +@internalTechnology
    1.38 +*/
    1.39 +class MDrawDeviceOrigin
    1.40 +	{
    1.41 +public:
    1.42 +	/**
    1.43 +	Sets the origin of the drawing device. By default drawing device origin is (0,0).
    1.44 +	If you want to set the default origin, call Set() with (0,0) point coordinates.
    1.45 +	@param aOrigin Specifies physical coordinates of the new origin
    1.46 +	of the drawing device. The drawing device maps the logical point (0,0) to
    1.47 +	the "aOrigin" physical point .
    1.48 +	@return KErrNone success.
    1.49 +	@internalTechnology
    1.50 +	*/
    1.51 +	virtual TInt Set(const TPoint& aOrigin) = 0;
    1.52 +	/**
    1.53 +	Retrieves origin point.
    1.54 +	@param aOrigin Upon return contains origin point.
    1.55 +	@internalTechnology
    1.56 +	*/
    1.57 +	virtual void Get(TPoint& aOrigin) = 0;
    1.58 +	};
    1.59 +
    1.60 +#endif//__BITDRAWORIGIN_H__