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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_awt_XDevice_idl__
  20 #define __com_sun_star_awt_XDevice_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/awt/DeviceInfo.idl>
  25
  26 #include <com/sun/star/awt/FontDescriptor.idl>
  27
  28
  29  module com {  module sun {  module star {  module awt {
  30
  31  published interface XGraphics;
  32  published interface XFont;
  33  published interface XBitmap;
  34  published interface XDisplayBitmap;
  35
  36
  37 /** provides information about a graphical output device and
  38     offers a factory for the <em>graphics</em> which provides write
  39     operations on the device.
  40  */
  41 published interface XDevice: com::sun::star::uno::XInterface
  42 {
  43
  44     /** creates a new graphics whose output operation is directed to this
  45         device.
  46      */
  47     XGraphics createGraphics();
  48
  49
  50     /** creates a new device which is compatible with this one.
  51
  52         <p>If the device does not support the GETBITS device capability,
  53         this method returns `NULL`.</p>
  54      */
  55     XDevice createDevice( [in] long nWidth,
  56              [in] long nHeight );
  57
  58
  59     /** returns information about the device.
  60      */
  61     com::sun::star::awt::DeviceInfo getInfo();
  62
  63
  64     /** returns the list of available font descriptors.
  65      */
  66     sequence<FontDescriptor> getFontDescriptors();
  67
  68
  69     /** returns information about a font offered by this device.
  70
  71         @returns the font of this device.
  72
  73         @param aDescriptor
  74         specifies the description of a font.
  75         The unit of measure is pixel for this device.
  76      */
  77     com::sun::star::awt::XFont getFont( [in] FontDescriptor aDescriptor );
  78
  79
  80     /** creates a bitmap with the current device depth.
  81
  82         <p>If the specified area does not lie entirely in the device, the bits
  83         outside are not specified.</p>
  84      */
  85     XBitmap createBitmap( [in] long nX,
  86              [in] long nY,
  87              [in] long nWidth,
  88              [in] long nHeight );
  89
  90
  91     /** creates a device compatible bitmap.
  92
  93         <p>The data of the bitmap is in process memory instead of in the device,
  94         so that the output operation is fast.</p>
  95      */
  96     XDisplayBitmap createDisplayBitmap( [in] XBitmap Bitmap );
  97
  98 };
  99
 100
 101 }; }; }; };
 102
 103 #endif
 104
 105 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */