graphicsdeviceinterface/screendriver/inc/BitDrawOrigin.h
changeset 0 5d03bc08d59c
equal deleted inserted replaced
-1:000000000000 0:5d03bc08d59c
       
     1 // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef __BITDRAWORIGIN_H__
       
    17 #define __BITDRAWORIGIN_H__
       
    18 
       
    19 /**
       
    20 MDrawDeviceOrigin interface manages the origin point of CFbsDrawDevice interface.
       
    21 
       
    22 The interface could be retrieved calling CFbsDrawDevice::GetInterface() with 
       
    23 KDrawDeviceOriginInterfaceID as an argument.
       
    24 If the drawing device does not have support for moving origin, MDrawDeviceOrigin cannot be retrieved.
       
    25    
       
    26 MDrawDeviceOrigin interface lifetime is the same as the lifetime of CFbsDrawDevice
       
    27 interface, which creates it. 
       
    28 Do not try to delete MDrawDeviceOrigin interface pointer!
       
    29    
       
    30 MDrawDeviceOrigin interface offers following methods: 
       
    31 Get(), Set().
       
    32    
       
    33 @see CFbsDrawDevice
       
    34 @internalTechnology
       
    35 */
       
    36 class MDrawDeviceOrigin
       
    37 	{
       
    38 public:
       
    39 	/**
       
    40 	Sets the origin of the drawing device. By default drawing device origin is (0,0).
       
    41 	If you want to set the default origin, call Set() with (0,0) point coordinates.
       
    42 	@param aOrigin Specifies physical coordinates of the new origin
       
    43 	of the drawing device. The drawing device maps the logical point (0,0) to
       
    44 	the "aOrigin" physical point .
       
    45 	@return KErrNone success.
       
    46 	@internalTechnology
       
    47 	*/
       
    48 	virtual TInt Set(const TPoint& aOrigin) = 0;
       
    49 	/**
       
    50 	Retrieves origin point.
       
    51 	@param aOrigin Upon return contains origin point.
       
    52 	@internalTechnology
       
    53 	*/
       
    54 	virtual void Get(TPoint& aOrigin) = 0;
       
    55 	};
       
    56 
       
    57 #endif//__BITDRAWORIGIN_H__