xref: /aoo41x/main/offapi/com/sun/star/awt/XDevice.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_XDevice_idl__
28#define __com_sun_star_awt_XDevice_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_DeviceInfo_idl__
35#include <com/sun/star/awt/DeviceInfo.idl>
36#endif
37
38#ifndef __com_sun_star_awt_FontDescriptor_idl__
39#include <com/sun/star/awt/FontDescriptor.idl>
40#endif
41
42//=============================================================================
43
44 module com {  module sun {  module star {  module awt {
45
46 published interface XGraphics;
47 published interface XFont;
48 published interface XBitmap;
49 published interface XDisplayBitmap;
50
51//=============================================================================
52
53/** provides information about a graphical output device and
54	offers a factory for the <em>graphics</em> which provides write
55	operations on the device.
56 */
57published interface XDevice: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60
61	/** creates a new graphics whose output operation is directed to this
62        device.
63	 */
64	XGraphics createGraphics();
65
66	//-------------------------------------------------------------------------
67
68	/** creates a new device which is compatible with this one.
69
70		<p>If the device does not support the GETBITS device capability,
71		this method returns <NULL/>.</p>
72	 */
73	XDevice createDevice( [in] long nWidth,
74			 [in] long nHeight );
75
76	//-------------------------------------------------------------------------
77
78	/** returns information about the device.
79	 */
80	com::sun::star::awt::DeviceInfo getInfo();
81
82	//-------------------------------------------------------------------------
83
84	/** returns the list of available font descriptors.
85	 */
86	sequence<FontDescriptor> getFontDescriptors();
87
88	//-------------------------------------------------------------------------
89
90	/** returns information about a font offered by this device.
91
92        @returns the font of this device.
93
94	    @param aDescriptor
95		specifies the description of a font.
96		The unit of measure is pixel for this device.
97	 */
98	com::sun::star::awt::XFont getFont( [in] FontDescriptor aDescriptor );
99
100	//-------------------------------------------------------------------------
101
102	/** creates a bitmap with the current device depth.
103
104		<p>If the specified area does not lie entirely in the device, the bits
105		outside are not specified.</p>
106	 */
107	XBitmap createBitmap( [in] long nX,
108			 [in] long nY,
109			 [in] long nWidth,
110			 [in] long nHeight );
111
112	//-------------------------------------------------------------------------
113
114	/** creates a device compatible bitmap.
115
116		<p>The data of the bitmap is in process memory instead of in the device,
117		so that the output operation is fast.</p>
118	 */
119	XDisplayBitmap createDisplayBitmap( [in] XBitmap Bitmap );
120
121};
122
123//=============================================================================
124
125}; }; }; };
126
127#endif
128