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
  20
  21  module com {  module sun {  module star {  module awt {
  22
  23  published interface XGraphics;
  24  published interface XFont;
  25  published interface XBitmap;
  26  published interface XDisplayBitmap;
  27
  28
  29 /** provides information about a graphical output device and
  30     offers a factory for the <em>graphics</em> which provides write
  31     operations on the device.
  32  */
  33 published interface XDevice: com::sun::star::uno::XInterface
  34 {
  35
  36     /** creates a new graphics whose output operation is directed to this
  37         device.
  38      */
  39     XGraphics createGraphics();
  40
  41
  42     /** creates a new device which is compatible with this one.
  43
  44         <p>If the device does not support the GETBITS device capability,
  45         this method returns `NULL`.</p>
  46      */
  47     XDevice createDevice( [in] long nWidth,
  48              [in] long nHeight );
  49
  50
  51     /** returns information about the device.
  52      */
  53     com::sun::star::awt::DeviceInfo getInfo();
  54
  55
  56     /** returns the list of available font descriptors.
  57      */
  58     sequence<FontDescriptor> getFontDescriptors();
  59
  60
  61     /** returns information about a font offered by this device.
  62
  63         @returns the font of this device.
  64
  65         @param aDescriptor
  66         specifies the description of a font.
  67         The unit of measure is pixel for this device.
  68      */
  69     com::sun::star::awt::XFont getFont( [in] FontDescriptor aDescriptor );
  70
  71
  72     /** creates a bitmap with the current device depth.
  73
  74         <p>If the specified area does not lie entirely in the device, the bits
  75         outside are not specified.</p>
  76      */
  77     XBitmap createBitmap( [in] long nX,
  78              [in] long nY,
  79              [in] long nWidth,
  80              [in] long nHeight );
  81
  82
  83     /** creates a device compatible bitmap.
  84
  85         <p>The data of the bitmap is in process memory instead of in the device,
  86         so that the output operation is fast.</p>
  87      */
  88     XDisplayBitmap createDisplayBitmap( [in] XBitmap Bitmap );
  89
  90 };
  91
  92
  93 }; }; }; };
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */