xref: /trunk/main/offapi/com/sun/star/awt/XView.idl (revision d1766043)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_XView_idl__
24#define __com_sun_star_awt_XView_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_awt_XGraphics_idl__
31#include <com/sun/star/awt/XGraphics.idl>
32#endif
33
34#ifndef __com_sun_star_awt_Size_idl__
35#include <com/sun/star/awt/Size.idl>
36#endif
37
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module awt {
42
43//=============================================================================
44
45/** makes it possible to attach an oputput device to the object.
46
47	<p>This kind of object is called view-object.</p>
48 */
49published interface XView: com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52
53	/** sets the output device.
54	 */
55	boolean setGraphics( [in] com::sun::star::awt::XGraphics aDevice );
56
57	//-------------------------------------------------------------------------
58
59	/** returns the output device which was set using the method
60		<member>XView::setGraphics</member>.
61	 */
62	com::sun::star::awt::XGraphics getGraphics();
63
64	//-------------------------------------------------------------------------
65
66	/** returns the size of the object in device units.
67
68        <p>A device must be set before.</p>
69	 */
70	com::sun::star::awt::Size getSize();
71
72	//-------------------------------------------------------------------------
73
74	/** draws the object at the specified position.
75
76		<p>If the output should be clipped, the caller has to set the
77		clipping region.</p>
78	 */
79	[oneway] void draw( [in] long nX,
80			 [in] long nY );
81
82	//-------------------------------------------------------------------------
83
84	/** sets the zoom factor.
85
86		<p>The zoom factor only affects the content of the view, not the size.</p>
87	 */
88	[oneway] void setZoom( [in] float fZoomX,
89			 [in] float fZoomY );
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98