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

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