LibreOffice LibreOffice 26.2 SDK API Reference

Public Member Functions | List of all members
XBitmapCanvas Interface Reference

This is a specialization of the canvas interface for bitmapped canvases. More...

`import"XBitmapCanvas.idl";`

Inheritance diagram for XBitmapCanvas:

## Public Member Functions
void | copyRect ([in] XBitmapCanvas sourceCanvas, [in] ::com::sun::star::geometry::RealRectangle2D sourceRect, [in] ViewState sourceViewState, [in] RenderState sourceRenderState, [in] ::com::sun::star::geometry::RealRectangle2D destRect, [in] ViewState destViewState, [in] RenderState destRenderState) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| This method copies a rectangular area from a place of one canvas to a place on another. More...
Public Member Functions inherited from XCanvas
void | clear ()
| Clear the whole canvas area. More...
void | drawPoint ([in] ::com::sun::star::geometry::RealPoint2D aPoint, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Draw a point in device resolution on the device. More...
void | drawLine ([in] ::com::sun::star::geometry::RealPoint2D aStartPoint, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Draw a line in device resolution width (i.e. More...
void | drawBezier ([in] ::com::sun::star::geometry::RealBezierSegment2D aBezierSegment, [in] ::com::sun::star::geometry::RealPoint2D aEndPoint, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Draw a cubic Bezier curve in device resolution width (i.e. More...
XCachedPrimitive | drawPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Draw a poly-polygon in device resolution line width (i.e. More...
XCachedPrimitive | strokePolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes) raises (com::sun::star::lang::IllegalArgumentException)
| Stroke each polygon of the provided poly-polygon with the specified stroke attributes. More...
XCachedPrimitive | strokeTexturedPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > aTextures, [in] StrokeAttributes aStrokeAttributes) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Stroke each polygon of the provided poly-polygon with the specified stroke attributes, fill the stroked outline with the specified texture graphics. More...
XCachedPrimitive | strokeTextureMappedPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > aTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping, [in] StrokeAttributes aStrokeAttributes) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Stroke each polygon of the provided poly-polygon with the specified stroke attributes, fill the stroked outline with the specified texture graphics, map the texture to the outline via the specified texture mapping. More...
XPolyPolygon2D | queryStrokeShapes ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] StrokeAttributes aStrokeAttributes) raises (com::sun::star::lang::IllegalArgumentException)
| Query the polygonal representation of the stroke outlines, as it would be generated by the strokePolyPolygon methods. More...
XCachedPrimitive | fillPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Fill the given poly-polygon. More...
XCachedPrimitive | fillTexturedPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > xTextures) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Fill the given poly-polygon with a texture. More...
XCachedPrimitive | fillTextureMappedPolyPolygon ([in] XPolyPolygon2D xPolyPolygon, [in] ViewState aViewState, [in] RenderState aRenderState, [in] sequence< Texture > xTextures, [in] ::com::sun::star::geometry::XMapping2D xMapping) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Fill the given poly-polygon with a mapped texture. More...
XCanvasFont | createFont ([in] FontRequest aFontRequest, [in] sequence< ::com::sun::star::beans::PropertyValue > aExtraFontProperties, [in] ::com::sun::star::geometry::Matrix2D aFontMatrix) raises (com::sun::star::lang::IllegalArgumentException)
| Create a suitable font for the specified font description. More...
sequence< FontInfo > | queryAvailableFonts ([in] FontInfo aFilter, [in] sequence< ::com::sun::star::beans::PropertyValue > aFontProperties) raises (com::sun::star::lang::IllegalArgumentException)
| Query font information, specific to this canvas. More...
XCachedPrimitive | drawText ([in] StringContext aText, [in] XCanvasFont xFont, [in] ViewState aViewState, [in] RenderState aRenderState, [in] byte nTextDirection) raises (com::sun::star::lang::IllegalArgumentException)
| Draw the text given by the substring of the specified string with the given font. More...
XCachedPrimitive | drawTextLayout ([in] XTextLayout xLayoutetText, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException)
| Draw the formatted text given by the text layout. More...
XCachedPrimitive | drawBitmap ([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Render the given bitmap. More...
XCachedPrimitive | drawBitmapModulated ([in] XBitmap xBitmap, [in] ViewState aViewState, [in] RenderState aRenderState) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
| Render the given bitmap, with a global color modulation. More...
XGraphicDevice | getDevice ()
| Request the associated graphic device for this canvas. 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

This is a specialization of the canvas interface for bitmapped canvases.

This interface is a specialization of the canvas interface for bitmapped canvases, where additional methods for accessing and moving of bitmap content are provided.

Since
  OOo 2.0

## Member Function Documentation

## ◆ copyRect()

void copyRect | ( | [in] XBitmapCanvas | sourceCanvas,
|  | [in] ::com::sun::star::geometry::RealRectangle2D | sourceRect,
|  | [in] ViewState | sourceViewState,
|  | [in] RenderState | sourceRenderState,
|  | [in] ::com::sun::star::geometry::RealRectangle2D | destRect,
|  | [in] ViewState | destViewState,
|  | [in] RenderState | destRenderState
| ) |  |
raises | ( | com::sun::star::lang::IllegalArgumentException,
|  | VolatileContentDestroyedException
| ) |  |

This method copies a rectangular area from a place of one canvas to a place on another.

This method copies a rectangular area from a place of one canvas to a place on another. Source and destination areas are permitted to overlap. If the source view or render state has a clipping set, the regions clipped away from the source rectangle are regarded fully transparent for the copy operation. The device color for both source and destination render state is ignored, the compositing mode only for the source render state.

Parameters

  sourceCanvas | Canvas from which to copy the bitmap data. Can be identical to the canvas this method is called on, but must be valid.
  sourceRect | Rectangle from which to copy the bitmap data. This rectangle is subject to both view and render transformation, before being applied. Thus, on screen, it does not necessarily resemble a rectangle any more. The rectangle must be non-empty, see com::sun::star::geometry::RealRectangle2D for details.
  sourceViewState | The view state to apply to the source of this copy operation. The view transformation must be non-singular.
  sourceRenderState | The render state to apply to the source of this copy operation. The render transformation must be non-singular, and the compositing mode must be one of the CompositingOperation values.
  destRect | Rectangle into which to copy the bitmap data. This rectangle is subject to both view and render transformation, before being applied. Thus, on screen, it does not necessarily resemble a rectangle any more. The rectangle must be non-empty, see com::sun::star::geometry::RealRectangle2D for details.
  destViewState | The view state to apply to the destination of this copy operation. The view transformation must be non-singular.
  destRenderState |

The render state to apply to the destination of this copy operation. The render transformation must be non-singular, and the compositing mode must be one of the CompositingOperation values.

Exceptions

  com::sun::star::lang::IllegalArgumentException | if one of the parameters are not within the specified range.

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

- com/sun/star/rendering/XBitmapCanvas.idl