LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XBitmap Interface Reference

This is a generic interface to a bitmap. More...

import"XBitmap.idl";

Inheritance diagram for XBitmap:
XInterface BitmapCanvas XHalfFloatReadOnlyBitmap XIeeeDoubleReadOnlyBitmap XIeeeFloatReadOnlyBitmap XIntegerReadOnlyBitmap XVolatileBitmap XHalfFloatBitmap XIeeeDoubleBitmap XIeeeFloatBitmap XIntegerBitmap

Public Member Functions

::com::sun::star::geometry::IntegerSize2D getSize ()
 Query the size of the bitmap. More...
 
boolean hasAlpha ()
 Query transparency status of the bitmap. More...
 
XBitmap getScaledBitmap ([in]::com::sun::star::geometry::RealSize2D newSize, [in] boolean beFast) raises (com::sun::star::lang::IllegalArgumentException, VolatileContentDestroyedException)
 Query a scaled copy of the original bitmap. 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 generic interface to a bitmap.

This interface contains the generic functionality to be used on every XCanvas bitmap object. More format-specific methods can be found at the XIntegerBitmap, XIeeeDoubleBitmap, XIeeeFloatBitmap and XHalfFloatBitmap interfaces.

Since
OOo 2.0

Member Function Documentation

Query a scaled copy of the original bitmap.

Parameters
newSizeRequested size of the new bitmap. Both of the two size components must be greater than zero.
beFastWhen set to true, this parameter advises getScaledBitmap to use the fastest available algorithm to scale the bitmap, which might cause visible artifacts.
Returns
the new scaled bitmap.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif the size components are outside the specified range.
VolatileContentDestroyedExceptionif the contents of a volatile bitmap have been destroyed, and thus cannot be read to generate the scaled bitmap.

Query the size of the bitmap.

This method queries the bitmap size in pixel.

Returns
the bitmap size in pixel.
boolean hasAlpha ( )

Query transparency status of the bitmap.

The method checks, whether the bitmap contains any alpha information. The same information is also available at the XColorSpace associated with this bitmap, though much easier to access here (the color space then has a component flagged ColorComponentTag::ALPHA).

Returns
TRUE, if the bitmap has alpha data, or FALSE if not.

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