os/graphics/graphicsdeviceinterface/screendriver/inc/BitDrawOrigin.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 __BITDRAWORIGIN_H__
sl@0
    17
#define __BITDRAWORIGIN_H__
sl@0
    18
sl@0
    19
/**
sl@0
    20
MDrawDeviceOrigin interface manages the origin point of CFbsDrawDevice interface.
sl@0
    21
sl@0
    22
The interface could be retrieved calling CFbsDrawDevice::GetInterface() with 
sl@0
    23
KDrawDeviceOriginInterfaceID as an argument.
sl@0
    24
If the drawing device does not have support for moving origin, MDrawDeviceOrigin cannot be retrieved.
sl@0
    25
   
sl@0
    26
MDrawDeviceOrigin 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 MDrawDeviceOrigin interface pointer!
sl@0
    29
   
sl@0
    30
MDrawDeviceOrigin interface offers following methods: 
sl@0
    31
Get(), Set().
sl@0
    32
   
sl@0
    33
@see CFbsDrawDevice
sl@0
    34
@internalTechnology
sl@0
    35
*/
sl@0
    36
class MDrawDeviceOrigin
sl@0
    37
	{
sl@0
    38
public:
sl@0
    39
	/**
sl@0
    40
	Sets the origin of the drawing device. By default drawing device origin is (0,0).
sl@0
    41
	If you want to set the default origin, call Set() with (0,0) point coordinates.
sl@0
    42
	@param aOrigin Specifies physical coordinates of the new origin
sl@0
    43
	of the drawing device. The drawing device maps the logical point (0,0) to
sl@0
    44
	the "aOrigin" physical point .
sl@0
    45
	@return KErrNone success.
sl@0
    46
	@internalTechnology
sl@0
    47
	*/
sl@0
    48
	virtual TInt Set(const TPoint& aOrigin) = 0;
sl@0
    49
	/**
sl@0
    50
	Retrieves origin point.
sl@0
    51
	@param aOrigin Upon return contains origin point.
sl@0
    52
	@internalTechnology
sl@0
    53
	*/
sl@0
    54
	virtual void Get(TPoint& aOrigin) = 0;
sl@0
    55
	};
sl@0
    56
sl@0
    57
#endif//__BITDRAWORIGIN_H__