offapi/com/sun/star/awt/XDevice.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDevice.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XDevice_idl__
  31 #define __com_sun_star_awt_XDevice_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_DeviceInfo_idl__
  38 #include <com/sun/star/awt/DeviceInfo.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  42 #include <com/sun/star/awt/FontDescriptor.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47  module com {  module sun {  module star {  module awt {
  48
  49  published interface XGraphics;
  50  published interface XFont;
  51  published interface XBitmap;
  52  published interface XDisplayBitmap;
  53
  54 //=============================================================================
  55
  56 /** provides information about a graphical output device and
  57     offers a factory for the <em>graphics</em> which provides write
  58     operations on the device.
  59  */
  60 published interface XDevice: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** creates a new graphics whose output operation is directed to this
  65         device.
  66      */
  67     XGraphics createGraphics();
  68
  69     //-------------------------------------------------------------------------
  70
  71     /** creates a new device which is compatible with this one.
  72
  73         <p>If the device does not support the GETBITS device capability,
  74         this method returns <NULL/>.</p>
  75      */
  76     XDevice createDevice( [in] long nWidth,
  77              [in] long nHeight );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns information about the device.
  82      */
  83     com::sun::star::awt::DeviceInfo getInfo();
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** returns the list of available font descriptors.
  88      */
  89     sequence<FontDescriptor> getFontDescriptors();
  90
  91     //-------------------------------------------------------------------------
  92
  93     /** returns information about a font offered by this device.
  94
  95         @returns the font of this device.
  96
  97         @param aDescriptor
  98         specifies the description of a font.
  99         The unit of measure is pixel for this device.
 100      */
 101     com::sun::star::awt::XFont getFont( [in] FontDescriptor aDescriptor );
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** creates a bitmap with the current device depth.
 106
 107         <p>If the specified area does not lie entirely in the device, the bits
 108         outside are not specified.</p>
 109      */
 110     XBitmap createBitmap( [in] long nX,
 111              [in] long nY,
 112              [in] long nWidth,
 113              [in] long nHeight );
 114
 115     //-------------------------------------------------------------------------
 116
 117     /** creates a device compatible bitmap.
 118
 119         <p>The data of the bitmap is in process memory instead of in the device,
 120         so that the output operation is fast.</p>
 121      */
 122     XDisplayBitmap createDisplayBitmap( [in] XBitmap Bitmap );
 123
 124 };
 125
 126 //=============================================================================
 127
 128 }; }; }; };
 129
 130 #endif