xref: /trunk/main/offapi/com/sun/star/awt/XView.idl (revision cdf0e10c)
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_XView_idl__
28#define __com_sun_star_awt_XView_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_XGraphics_idl__
35#include <com/sun/star/awt/XGraphics.idl>
36#endif
37
38#ifndef __com_sun_star_awt_Size_idl__
39#include <com/sun/star/awt/Size.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module awt {
46
47//=============================================================================
48
49/** makes it possible to attach an oputput device to the object.
50
51	<p>This kind of object is called view-object.</p>
52 */
53published interface XView: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56
57	/** sets the output device.
58	 */
59	boolean setGraphics( [in] com::sun::star::awt::XGraphics aDevice );
60
61	//-------------------------------------------------------------------------
62
63	/** returns the output device which was set using the method
64		<member>XView::setGraphics</member>.
65	 */
66	com::sun::star::awt::XGraphics getGraphics();
67
68	//-------------------------------------------------------------------------
69
70	/** returns the size of the object in device units.
71
72        <p>A device must be set before.</p>
73	 */
74	com::sun::star::awt::Size getSize();
75
76	//-------------------------------------------------------------------------
77
78	/** draws the object at the specified position.
79
80		<p>If the output should be clipped, the caller has to set the
81		clipping region.</p>
82	 */
83	[oneway] void draw( [in] long nX,
84			 [in] long nY );
85
86	//-------------------------------------------------------------------------
87
88	/** sets the zoom factor.
89
90		<p>The zoom factor only affects the content of the view, not the size.</p>
91	 */
92	[oneway] void setZoom( [in] float fZoomX,
93			 [in] float fZoomY );
94
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102