1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_awt_XUnitConversion_idl__
28#define __com_sun_star_awt_XUnitConversion_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_awt_Point_idl__
35#include <com/sun/star/awt/Point.idl>
36#endif
37
38#ifndef __com_sun_star_awt_Size_idl__
39#include <com/sun/star/awt/Size.idl>
40#endif
41
42#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43#include <com/sun/star/lang/IllegalArgumentException.idl>
44#endif
45
46//=============================================================================
47
48 module com {  module sun {  module star {  module awt {
49
50//=============================================================================
51
52/** allows converting between different measurement units
53
54    @since OOo 3.0
55 */
56published interface XUnitConversion: com::sun::star::uno::XInterface
57{
58    /** converts the given <type>Point</type>, which is specified in pixels, into the given logical unit
59
60        @param Point
61            A given <type>Point</type> in a well known type
62        @param TargetUnit
63            A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Point will convert to.
64
65        @return
66            Returns a new <type>Point</type> in the TargetUnit type format.
67     */
68    com::sun::star::awt::Point convertPointToLogic( [in] com::sun::star::awt::Point Point, [in] short TargetUnit )
69            raises ( com::sun::star::lang::IllegalArgumentException );
70
71    /** converts the given <type>Point</type>, which is specified in the given logical unit, into pixels
72
73        @param Point
74            A given Point in the SourceUnit type
75        @param SourceUnit
76            The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Point.
77
78        @return
79            Return a new <type>Point</type> in Pixel type format.
80     */
81    com::sun::star::awt::Point convertPointToPixel( [in] com::sun::star::awt::Point aPoint, [in] short SourceUnit )
82            raises ( com::sun::star::lang::IllegalArgumentException );
83
84
85    /** converts the given <type>Size</type>, which is specified in pixels, into the given logical unit
86
87        @param aSize
88            A given <type>Size</type> in a well known type
89        @param TargetUnit
90            A type from <type scope="com::sun::star::util">MeasureUnit</type> in which the Size will convert to.
91
92        @return
93            Returns a new <type>Size</type> in the TargetUnit type format.
94     */
95    com::sun::star::awt::Size convertSizeToLogic( [in] com::sun::star::awt::Size aSize, [in] short TargetUnit )
96            raises ( com::sun::star::lang::IllegalArgumentException );
97
98    /** converts the given <type>Size</type>, which is specified in the given logical unit, into pixels
99
100        @param Size
101            A given <type>Size</type> in a well known type
102        @param TargetUnit
103            The type from <type scope="com::sun::star::util">MeasureUnit</type> of the Size.
104
105        @return
106            Returns a new <type>Size</type> in the TargetUnit type format.
107     */
108    com::sun::star::awt::Size convertSizeToPixel( [in] com::sun::star::awt::Size aSize, [in] short SourceUnit )
109            raises ( com::sun::star::lang::IllegalArgumentException );
110
111
112};
113
114//=============================================================================
115
116}; }; }; };
117
118#endif
119