offapi/com/sun/star/awt/XGraphics.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: XGraphics.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_XGraphics_idl__
  31 #define __com_sun_star_awt_XGraphics_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_util_Color_idl__
  38 #include <com/sun/star/util/Color.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_awt_SimpleFontMetric_idl__
  42 #include <com/sun/star/awt/SimpleFontMetric.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_awt_FontDescriptor_idl__
  46 #include <com/sun/star/awt/FontDescriptor.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_awt_RasterOperation_idl__
  50 #include <com/sun/star/awt/RasterOperation.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_awt_Gradient_idl__
  54 #include <com/sun/star/awt/Gradient.idl>
  55 #endif
  56
  57 //=============================================================================
  58
  59  module com {  module sun {  module star {  module awt {
  60
  61  published interface XRegion;
  62  published interface XDisplayBitmap;
  63  published interface XFont;
  64  published interface XDevice;
  65
  66 //=============================================================================
  67
  68 /** provides the basic output operation of a device.
  69  */
  70 published interface XGraphics: com::sun::star::uno::XInterface
  71 {
  72     //-------------------------------------------------------------------------
  73
  74     /** returns the device of this graphics.
  75      */
  76     XDevice getDevice();
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** returns the font metric of the current font.
  81      */
  82     SimpleFontMetric getFontMetric();
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** sets the font used by text operations.
  87      */
  88     [oneway] void setFont( [in] XFont xNewFont );
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** creates a new font and sets the font.
  93      */
  94     [oneway] void selectFont( [in] FontDescriptor aDescription );
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** sets the text color used by text operations.
  99      */
 100     [oneway] void setTextColor( [in] com::sun::star::util::Color nColor );
 101
 102     //-------------------------------------------------------------------------
 103
 104     /** sets the fill color used by text operations.
 105      */
 106     [oneway] void setTextFillColor( [in] com::sun::star::util::Color nColor );
 107
 108     //-------------------------------------------------------------------------
 109
 110     /** sets the line color.
 111      */
 112     [oneway] void setLineColor( [in] com::sun::star::util::Color nColor );
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** sets the fill color.
 117      */
 118     [oneway] void setFillColor( [in] com::sun::star::util::Color nColor );
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** sets the raster operation.
 123
 124         <p>If the device does not support raster operations
 125         then this call is ignored.</p>
 126      */
 127     [oneway] void setRasterOp( [in] RasterOperation ROP );
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** sets the clip region to specified clipping.
 132      */
 133     [oneway] void setClipRegion( [in] XRegion Clipping );
 134
 135     //-------------------------------------------------------------------------
 136
 137     /** builds the intersection with the current region.
 138      */
 139     [oneway] void intersectClipRegion( [in] XRegion xClipping );
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** saves all current settings (Font, TextColor, TextFillColor,
 144         LineColor, FillColor, RasterOp, ClipRegion).
 145      */
 146     [oneway] void push();
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** restores all previous saved settings.
 151      */
 152     [oneway] void pop();
 153
 154     //-------------------------------------------------------------------------
 155
 156     /** copies a rectangle of pixels from another device into this one.
 157      */
 158     [oneway] void copy( [in] XDevice xSource,
 159              [in] long nSourceX,
 160              [in] long nSourceY,
 161              [in] long nSourceWidth,
 162              [in] long nSourceHeight,
 163              [in] long nDestX,
 164              [in] long nDestY,
 165              [in] long nDestWidth,
 166              [in] long nDestHeight );
 167
 168     //-------------------------------------------------------------------------
 169
 170     /** draws a part of the specified bitmap to the output device.
 171      */
 172     [oneway] void draw( [in] XDisplayBitmap xBitmapHandle,
 173              [in] long SourceX,
 174              [in] long SourceY,
 175              [in] long SourceWidth,
 176              [in] long SourceHeight,
 177              [in] long DestX,
 178              [in] long DestY,
 179              [in] long DestWidth,
 180              [in] long DestHeight );
 181
 182     //-------------------------------------------------------------------------
 183
 184     /** sets a single pixel in the output device.
 185      */
 186     [oneway] void drawPixel( [in] long X,
 187              [in] long Y );
 188
 189     //-------------------------------------------------------------------------
 190
 191     /** draws a line in the output device.
 192      */
 193     [oneway] void drawLine( [in] long X1,
 194              [in] long Y1,
 195              [in] long X2,
 196              [in] long Y2 );
 197
 198     //-------------------------------------------------------------------------
 199
 200     /** draws a rectangle in the output device.
 201      */
 202     [oneway] void drawRect( [in] long X,
 203              [in] long Y,
 204              [in] long Width,
 205              [in] long Height );
 206
 207     //-------------------------------------------------------------------------
 208
 209     /** draws a rectangle with rounded corners in the output device.
 210      */
 211     [oneway] void drawRoundedRect( [in] long X,
 212              [in] long Y,
 213              [in] long Width,
 214              [in] long Height,
 215              [in] long nHorzRound,
 216              [in] long nVertRound );
 217
 218     //-------------------------------------------------------------------------
 219
 220     /** draws multiple lines in the output device at once.
 221      */
 222     [oneway] void drawPolyLine( [in] sequence<long> DataX,
 223              [in] sequence<long> DataY );
 224
 225     //-------------------------------------------------------------------------
 226
 227     /** draws a polygon line in the output device.
 228      */
 229     [oneway] void drawPolygon( [in] sequence<long> DataX,
 230              [in] sequence<long> DataY );
 231
 232     //-------------------------------------------------------------------------
 233
 234     /** draws multiple polygons in the output device at once.
 235      */
 236     [oneway] void drawPolyPolygon( [in] sequence< sequence<long> > DataX,
 237              [in] sequence< sequence<long> > DataY );
 238
 239     //-------------------------------------------------------------------------
 240
 241     /** draws an ellipse in the output device.
 242      */
 243     [oneway] void drawEllipse( [in] long X,
 244              [in] long Y,
 245              [in] long Width,
 246              [in] long Height );
 247
 248     //-------------------------------------------------------------------------
 249
 250     /** draws an arc (part of a circle) in the output device.
 251      */
 252     [oneway] void drawArc( [in] long X,
 253              [in] long Y,
 254              [in] long Width,
 255              [in] long Height,
 256              [in] long X1,
 257              [in] long Y1,
 258              [in] long X2,
 259              [in] long Y2 );
 260
 261     //-------------------------------------------------------------------------
 262
 263     /** draws a circular area in the output device.
 264      */
 265     [oneway] void drawPie( [in] long X,
 266              [in] long Y,
 267              [in] long Width,
 268              [in] long Height,
 269              [in] long X1,
 270              [in] long Y1,
 271              [in] long X2,
 272              [in] long Y2 );
 273
 274     //-------------------------------------------------------------------------
 275
 276     /** draws a chord of a circular area in the output device.
 277
 278         <p>A chord is a segment of a circle. You get two chords from a
 279         circle if you intersect the circle with a straight line
 280         joining two points on the circle.</p>
 281      */
 282     [oneway] void drawChord( [in] long nX,
 283              [in] long nY,
 284              [in] long nWidth,
 285              [in] long nHeight,
 286              [in] long nX1,
 287              [in] long nY1,
 288              [in] long nX2,
 289              [in] long nY2 );
 290
 291     //-------------------------------------------------------------------------
 292
 293     /** draws a color dispersion in the output device.
 294      */
 295     [oneway] void drawGradient( [in] long nX,
 296              [in] long nY,
 297              [in] long nWidth,
 298              [in] long Height,
 299              [in] Gradient aGradient );
 300
 301     //-------------------------------------------------------------------------
 302
 303     /** draws text in the output device.
 304      */
 305     [oneway] void drawText( [in] long X,
 306              [in] long Y,
 307              [in] string Text );
 308
 309     //-------------------------------------------------------------------------
 310
 311     /** draws texts in the output device using an explicit kerning table.
 312      */
 313     [oneway] void drawTextArray( [in] long X,
 314              [in] long Y,
 315              [in] string Text,
 316              [in] sequence<long> Longs );
 317
 318 };
 319
 320 //=============================================================================
 321
 322 }; }; }; };
 323
 324 #endif