offapi/com/sun/star/awt/XGraphics.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_XGraphics_idl__
  20 #define __com_sun_star_awt_XGraphics_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23 #include <com/sun/star/util/Color.idl>
  24 #include <com/sun/star/awt/SimpleFontMetric.idl>
  25 #include <com/sun/star/awt/FontDescriptor.idl>
  26 #include <com/sun/star/awt/RasterOperation.idl>
  27 #include <com/sun/star/awt/Gradient.idl>
  28
  29
  30 module com {  module sun {  module star {  module awt {
  31
  32 published interface XRegion;
  33 published interface XDisplayBitmap;
  34 published interface XFont;
  35 published interface XDevice;
  36
  37
  38 /** provides the basic output operation of a device.
  39  */
  40 published interface XGraphics: com::sun::star::uno::XInterface
  41 {
  42     /** returns the device of this graphics.
  43      */
  44     XDevice getDevice();
  45
  46     /** returns the font metric of the current font.
  47      */
  48     SimpleFontMetric getFontMetric();
  49
  50     /** sets the font used by text operations.
  51      */
  52     void setFont( [in] XFont xNewFont );
  53
  54     /** creates a new font and sets the font.
  55      */
  56     void selectFont( [in] FontDescriptor aDescription );
  57
  58     /** sets the text color used by text operations.
  59      */
  60     void setTextColor( [in] com::sun::star::util::Color nColor );
  61
  62     /** sets the fill color used by text operations.
  63      */
  64     void setTextFillColor( [in] com::sun::star::util::Color nColor );
  65
  66     /** sets the line color.
  67      */
  68     void setLineColor( [in] com::sun::star::util::Color nColor );
  69
  70     /** sets the fill color.
  71      */
  72     void setFillColor( [in] com::sun::star::util::Color nColor );
  73
  74     /** sets the raster operation.
  75
  76         <p>If the device does not support raster operations
  77         then this call is ignored.</p>
  78      */
  79     void setRasterOp( [in] RasterOperation ROP );
  80
  81     /** sets the clip region to specified clipping.
  82      */
  83     void setClipRegion( [in] XRegion Clipping );
  84
  85     /** builds the intersection with the current region.
  86      */
  87     void intersectClipRegion( [in] XRegion xClipping );
  88
  89     /** saves all current settings (Font, TextColor, TextFillColor,
  90         LineColor, FillColor, RasterOp, ClipRegion).
  91      */
  92     void push();
  93
  94     /** restores all previous saved settings.
  95      */
  96     void pop();
  97
  98     /** copies a rectangle of pixels from another device into this one.
  99      */
 100     void copy( [in] XDevice xSource,
 101              [in] long nSourceX,
 102              [in] long nSourceY,
 103              [in] long nSourceWidth,
 104              [in] long nSourceHeight,
 105              [in] long nDestX,
 106              [in] long nDestY,
 107              [in] long nDestWidth,
 108              [in] long nDestHeight );
 109
 110     /** draws a part of the specified bitmap to the output device.
 111      */
 112     void draw( [in] XDisplayBitmap xBitmapHandle,
 113              [in] long SourceX,
 114              [in] long SourceY,
 115              [in] long SourceWidth,
 116              [in] long SourceHeight,
 117              [in] long DestX,
 118              [in] long DestY,
 119              [in] long DestWidth,
 120              [in] long DestHeight );
 121
 122     /** sets a single pixel in the output device.
 123      */
 124     void drawPixel( [in] long X,
 125              [in] long Y );
 126
 127     /** draws a line in the output device.
 128      */
 129     void drawLine( [in] long X1,
 130              [in] long Y1,
 131              [in] long X2,
 132              [in] long Y2 );
 133
 134     /** draws a rectangle in the output device.
 135      */
 136     void drawRect( [in] long X,
 137              [in] long Y,
 138              [in] long Width,
 139              [in] long Height );
 140
 141     /** draws a rectangle with rounded corners in the output device.
 142      */
 143     void drawRoundedRect( [in] long X,
 144              [in] long Y,
 145              [in] long Width,
 146              [in] long Height,
 147              [in] long nHorzRound,
 148              [in] long nVertRound );
 149
 150     /** draws multiple lines in the output device at once.
 151      */
 152     void drawPolyLine( [in] sequence<long> DataX,
 153              [in] sequence<long> DataY );
 154
 155     /** draws a polygon line in the output device.
 156      */
 157     void drawPolygon( [in] sequence<long> DataX,
 158              [in] sequence<long> DataY );
 159
 160     /** draws multiple polygons in the output device at once.
 161      */
 162     void drawPolyPolygon( [in] sequence< sequence<long> > DataX,
 163              [in] sequence< sequence<long> > DataY );
 164
 165     /** draws an ellipse in the output device.
 166      */
 167     void drawEllipse( [in] long X,
 168              [in] long Y,
 169              [in] long Width,
 170              [in] long Height );
 171
 172     /** draws an arc (part of a circle) in the output device.
 173      */
 174     void drawArc( [in] long X,
 175              [in] long Y,
 176              [in] long Width,
 177              [in] long Height,
 178              [in] long X1,
 179              [in] long Y1,
 180              [in] long X2,
 181              [in] long Y2 );
 182
 183     /** draws a circular area in the output device.
 184      */
 185     void drawPie( [in] long X,
 186              [in] long Y,
 187              [in] long Width,
 188              [in] long Height,
 189              [in] long X1,
 190              [in] long Y1,
 191              [in] long X2,
 192              [in] long Y2 );
 193
 194     /** draws a chord of a circular area in the output device.
 195
 196         <p>A chord is a segment of a circle. You get two chords from a
 197         circle if you intersect the circle with a straight line
 198         joining two points on the circle.</p>
 199      */
 200     void drawChord( [in] long nX,
 201              [in] long nY,
 202              [in] long nWidth,
 203              [in] long nHeight,
 204              [in] long nX1,
 205              [in] long nY1,
 206              [in] long nX2,
 207              [in] long nY2 );
 208
 209     /** draws a color dispersion in the output device.
 210      */
 211     void drawGradient( [in] long nX,
 212              [in] long nY,
 213              [in] long nWidth,
 214              [in] long Height,
 215              [in] Gradient aGradient );
 216
 217     /** draws text in the output device.
 218      */
 219     void drawText( [in] long X,
 220              [in] long Y,
 221              [in] string Text );
 222
 223     /** draws texts in the output device using an explicit kerning table.
 224      */
 225     void drawTextArray( [in] long X,
 226              [in] long Y,
 227              [in] string Text,
 228              [in] sequence<long> Longs );
 229 };
 230
 231
 232 }; }; }; };
 233
 234 #endif
 235
 236 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */