LibreOffice LibreOffice 25.8 SDK API Reference

Public Member Functions | List of all members
XGraphics Interface Referencepublished

provides the basic output operation of a device. More...

`import"XGraphics.idl";`

Inheritance diagram for XGraphics:

## Public Member Functions
XDevice | getDevice ()
| returns the device of this graphics. More...
SimpleFontMetric | getFontMetric ()
| returns the font metric of the current font. More...
void | setFont ([in] XFont xNewFont)
| sets the font used by text operations. More...
void | selectFont ([in] FontDescriptor aDescription)
| creates a new font and sets the font. More...
void | setTextColor ([in] com::sun::star::util::Color nColor)
| sets the text color used by text operations. More...
void | setTextFillColor ([in] com::sun::star::util::Color nColor)
| sets the fill color used by text operations. More...
void | setLineColor ([in] com::sun::star::util::Color nColor)
| sets the line color. More...
void | setFillColor ([in] com::sun::star::util::Color nColor)
| sets the fill color. More...
void | setRasterOp ([in] RasterOperation ROP)
| sets the raster operation. More...
void | setClipRegion ([in] XRegion Clipping)
| sets the clip region to specified clipping. More...
void | intersectClipRegion ([in] XRegion xClipping)
| builds the intersection with the current region. More...
void | push ()
| saves all current settings (Font, TextColor, TextFillColor, LineColor, FillColor, RasterOp, ClipRegion). More...
void | pop ()
| restores all previous saved settings. More...
void | copy ([in] XDevice xSource, [in] long nSourceX, [in] long nSourceY, [in] long nSourceWidth, [in] long nSourceHeight, [in] long nDestX, [in] long nDestY, [in] long nDestWidth, [in] long nDestHeight)
| copies a rectangle of pixels from another device into this one. More...
void | draw ([in] XDisplayBitmap xBitmapHandle, [in] long SourceX, [in] long SourceY, [in] long SourceWidth, [in] long SourceHeight, [in] long DestX, [in] long DestY, [in] long DestWidth, [in] long DestHeight)
| draws a part of the specified bitmap to the output device. More...
void | drawPixel ([in] long X, [in] long Y)
| sets a single pixel in the output device. More...
void | drawLine ([in] long X1, [in] long Y1, [in] long X2, [in] long Y2)
| draws a line in the output device. More...
void | drawRect ([in] long X, [in] long Y, [in] long Width, [in] long Height)
| draws a rectangle in the output device. More...
void | drawRoundedRect ([in] long X, [in] long Y, [in] long Width, [in] long Height, [in] long nHorzRound, [in] long nVertRound)
| draws a rectangle with rounded corners in the output device. More...
void | drawPolyLine ([in] sequence< long > DataX, [in] sequence< long > DataY)
| draws multiple lines in the output device at once. More...
void | drawPolygon ([in] sequence< long > DataX, [in] sequence< long > DataY)
| draws a polygon line in the output device. More...
void | drawPolyPolygon ([in] sequence< sequence< long > > DataX, [in] sequence< sequence< long > > DataY)
| draws multiple polygons in the output device at once. More...
void | drawEllipse ([in] long X, [in] long Y, [in] long Width, [in] long Height)
| draws an ellipse in the output device. More...
void | drawArc ([in] long X, [in] long Y, [in] long Width, [in] long Height, [in] long X1, [in] long Y1, [in] long X2, [in] long Y2)
| draws an arc (part of a circle) in the output device. More...
void | drawPie ([in] long X, [in] long Y, [in] long Width, [in] long Height, [in] long X1, [in] long Y1, [in] long X2, [in] long Y2)
| draws a circular area in the output device. More...
void | drawChord ([in] long nX, [in] long nY, [in] long nWidth, [in] long nHeight, [in] long nX1, [in] long nY1, [in] long nX2, [in] long nY2)
| draws a chord of a circular area in the output device. More...
void | drawGradient ([in] long nX, [in] long nY, [in] long nWidth, [in] long Height, [in] Gradient aGradient)
| draws a color dispersion in the output device. More...
void | drawText ([in] long X, [in] long Y, [in] string Text)
| draws text in the output device. More...
void | drawTextArray ([in] long X, [in] long Y, [in] string Text, [in] sequence< long > Longs)
| draws texts in the output device using an explicit kerning table. More...
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object. More...
void | acquire ()
| increases the reference counter by one. More...
void | release ()
| decreases the reference counter by one. More...

## Detailed Description

provides the basic output operation of a device.

## Member Function Documentation

## ◆ copy()

void copy | ( | [in] XDevice | xSource,
|  | [in] long | nSourceX,
|  | [in] long | nSourceY,
|  | [in] long | nSourceWidth,
|  | [in] long | nSourceHeight,
|  | [in] long | nDestX,
|  | [in] long | nDestY,
|  | [in] long | nDestWidth,
|  | [in] long | nDestHeight
| ) |  |

copies a rectangle of pixels from another device into this one.

## ◆ draw()

void draw | ( | [in] XDisplayBitmap | xBitmapHandle,
|  | [in] long | SourceX,
|  | [in] long | SourceY,
|  | [in] long | SourceWidth,
|  | [in] long | SourceHeight,
|  | [in] long | DestX,
|  | [in] long | DestY,
|  | [in] long | DestWidth,
|  | [in] long | DestHeight
| ) |  |

draws a part of the specified bitmap to the output device.

## ◆ drawArc()

void drawArc | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] long | Width,
|  | [in] long | Height,
|  | [in] long | X1,
|  | [in] long | Y1,
|  | [in] long | X2,
|  | [in] long | Y2
| ) |  |

draws an arc (part of a circle) in the output device.

## ◆ drawChord()

void drawChord | ( | [in] long | nX,
|  | [in] long | nY,
|  | [in] long | nWidth,
|  | [in] long | nHeight,
|  | [in] long | nX1,
|  | [in] long | nY1,
|  | [in] long | nX2,
|  | [in] long | nY2
| ) |  |

draws a chord of a circular area in the output device.

A chord is a segment of a circle. You get two chords from a circle if you intersect the circle with a straight line joining two points on the circle.

## ◆ drawEllipse()

void drawEllipse | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] long | Width,
|  | [in] long | Height
| ) |  |

draws an ellipse in the output device.

## ◆ drawGradient()

void drawGradient | ( | [in] long | nX,
|  | [in] long | nY,
|  | [in] long | nWidth,
|  | [in] long | Height,
|  | [in] Gradient | aGradient
| ) |  |

draws a color dispersion in the output device.

## ◆ drawLine()

void drawLine | ( | [in] long | X1,
|  | [in] long | Y1,
|  | [in] long | X2,
|  | [in] long | Y2
| ) |  |

draws a line in the output device.

## ◆ drawPie()

void drawPie | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] long | Width,
|  | [in] long | Height,
|  | [in] long | X1,
|  | [in] long | Y1,
|  | [in] long | X2,
|  | [in] long | Y2
| ) |  |

draws a circular area in the output device.

## ◆ drawPixel()

void drawPixel | ( | [in] long | X,
|  | [in] long | Y
| ) |  |

sets a single pixel in the output device.

## ◆ drawPolygon()

void drawPolygon | ( | [in] sequence< long > | DataX,
|  | [in] sequence< long > | DataY
| ) |  |

draws a polygon line in the output device.

## ◆ drawPolyLine()

void drawPolyLine | ( | [in] sequence< long > | DataX,
|  | [in] sequence< long > | DataY
| ) |  |

draws multiple lines in the output device at once.

## ◆ drawPolyPolygon()

void drawPolyPolygon | ( | [in] sequence< sequence< long > > | DataX,
|  | [in] sequence< sequence< long > > | DataY
| ) |  |

draws multiple polygons in the output device at once.

## ◆ drawRect()

void drawRect | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] long | Width,
|  | [in] long | Height
| ) |  |

draws a rectangle in the output device.

## ◆ drawRoundedRect()

void drawRoundedRect | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] long | Width,
|  | [in] long | Height,
|  | [in] long | nHorzRound,
|  | [in] long | nVertRound
| ) |  |

draws a rectangle with rounded corners in the output device.

## ◆ drawText()

void drawText | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] string | Text
| ) |  |

draws text in the output device.

## ◆ drawTextArray()

void drawTextArray | ( | [in] long | X,
|  | [in] long | Y,
|  | [in] string | Text,
|  | [in] sequence< long > | Longs
| ) |  |

draws texts in the output device using an explicit kerning table.

## ◆ getDevice()

XDevice getDevice | ( |  | ) |

returns the device of this graphics.

## ◆ getFontMetric()

SimpleFontMetric getFontMetric | ( |  | ) |

returns the font metric of the current font.

## ◆ intersectClipRegion()

void intersectClipRegion | ( | [in] XRegion | xClipping | ) |

builds the intersection with the current region.

## ◆ pop()

void pop | ( |  | ) |

restores all previous saved settings.

## ◆ push()

void push | ( |  | ) |

saves all current settings (Font, TextColor, TextFillColor, LineColor, FillColor, RasterOp, ClipRegion).

## ◆ selectFont()

void selectFont | ( | [in] FontDescriptor | aDescription | ) |

creates a new font and sets the font.

## ◆ setClipRegion()

void setClipRegion | ( | [in] XRegion | Clipping | ) |

sets the clip region to specified clipping.

## ◆ setFillColor()

void setFillColor | ( | [in] com::sun::star::util::Color | nColor | ) |

sets the fill color.

## ◆ setFont()

void setFont | ( | [in] XFont | xNewFont | ) |

sets the font used by text operations.

## ◆ setLineColor()

void setLineColor | ( | [in] com::sun::star::util::Color | nColor | ) |

sets the line color.

## ◆ setRasterOp()

void setRasterOp | ( | [in] RasterOperation | ROP | ) |

sets the raster operation.

If the device does not support raster operations then this call is ignored.

## ◆ setTextColor()

void setTextColor | ( | [in] com::sun::star::util::Color | nColor | ) |

sets the text color used by text operations.

## ◆ setTextFillColor()

void setTextFillColor | ( | [in] com::sun::star::util::Color | nColor | ) |

sets the fill color used by text operations.

The documentation for this interface was generated from the following file:

- com/sun/star/awt/XGraphics.idl