summaryrefslogtreecommitdiff
path: root/offapi/com/sun
diff options
context:
space:
mode:
authorKurt Zenker <kz@openoffice.org>2008-06-24 10:27:59 +0000
committerKurt Zenker <kz@openoffice.org>2008-06-24 10:27:59 +0000
commit3eeaaeef40c21f447b43ec842dbd532320a17369 (patch)
treea30d0ff25bf7136683f46c52b11aad60c7007675 /offapi/com/sun
parent6034c756722273f9f058375d5c394ef493646651 (diff)
INTEGRATION: CWS canvas05 (1.4.366); FILE MERGED
2008/04/21 07:37:41 thb 1.4.366.2: RESYNC: (1.4-1.5); FILE MERGED 2007/10/01 13:33:53 thb 1.4.366.1: #i79437# Merge from CWS picom
Diffstat (limited to 'offapi/com/sun')
-rw-r--r--offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl91
1 files changed, 14 insertions, 77 deletions
diff --git a/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl
index 3eb0d363e..3abd9d1ce 100644
--- a/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl
+++ b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl
@@ -7,7 +7,7 @@
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XIeeeFloatBitmap.idl,v $
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
* This file is part of OpenOffice.org.
*
@@ -45,8 +45,8 @@
#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
#include <com/sun/star/geometry/IntegerRectangle2D.idl>
#endif
-#ifndef __com_sun_star_rendering_XBitmap_idl__
-#include <com/sun/star/rendering/XBitmap.idl>
+#ifndef __com_sun_star_rendering_XIeeeFloatReadOnlyBitmap_idl__
+#include <com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl>
#endif
#ifndef __com_sun_star_rendering_VolatileContentDestroyedException_idl__
#include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
@@ -56,42 +56,13 @@
module com { module sun { module star { module rendering {
/** Specialized interface for bitmaps containing IEEE floats as their
- color components.
+ color components.<p>
*/
-interface XIeeeFloatBitmap : XBitmap
+interface XIeeeFloatBitmap : XIeeeFloatReadOnlyBitmap
{
- /** Query the raw data of this bitmap.
-
- Query the raw data of this bitmap, in the format as defined by
- getMemoryLayout(). With the given rectangle, a subset of the
- whole bitmap can be queried. When querying subsets of the
- bitmap, the same scanline padding takes place as when the
- whole bitmap is requested.
-
- Note that the bitmap memory layout might change for volatile
- bitmaps.<p>
-
- @param bitmapLayout
- The memory layout the returned data is in.
-
- @param rect
- A rectangle, within the bounds of the bitmap, to retrieve the
- contens from.
-
- @throws VolatileContentDestroyedException
- if the bitmap is volatile, and the content has been destroyed by the system.
-
- @throws com::sun::star::lang::IndexOutOfBoundsException
- if parts of the given rectangle are outside the permissible
- bitmap area.
- */
- sequence<float> getData( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect )
- raises (com::sun::star::lang::IndexOutOfBoundsException,
- VolatileContentDestroyedException);
-
//-------------------------------------------------------------------------
- /** Set raw data of a bitmap.
+ /** Set raw data of a bitmap.<p>
Set raw data of a bitmap, in the format as defined by
getMemoryLayout(). With the given rectangle, a subset of the
@@ -105,7 +76,7 @@ interface XIeeeFloatBitmap : XBitmap
can change for the same bitmap, if the user e.g. switches the
screen resolution. Thus, this method will throw an
IllegalArgumentException, if the memory layout changed between
- a call to getMemoryLayout() and setData().
+ a call to getMemoryLayout() and setData().<p>
@param data
Data to set
@@ -118,11 +89,11 @@ interface XIeeeFloatBitmap : XBitmap
Destination rectangle, within the bounds of the bitmap, to set
the data in.
- @throws com::sun::star::lang::IndexOutOfBoundsException
+ @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
if parts of the given rectangle are outside the permissible
bitmap area.
- @throws com::sun::star::lang::IllegalArgumentException
+ @throws <type>com::sun::star::lang::IllegalArgumentException</type>
if the given memory layout does not match this bitmap's
layout, or if the given data sequence has too few or too much
elements.
@@ -134,7 +105,7 @@ interface XIeeeFloatBitmap : XBitmap
//-------------------------------------------------------------------------
/** Set a single pixel of the bitmap with the given color
- value.
+ value.<p>
When setting data on volatile bitmaps, always call isValid()
before, and retrieve a new memory layout via
@@ -142,7 +113,7 @@ interface XIeeeFloatBitmap : XBitmap
can change for the same bitmap, if the user e.g. switches the
screen resolution. Thus, this method will throw an
IllegalArgumentException, if the memory layout changed between
- a call to getMemoryLayout() and setPixel().
+ a call to getMemoryLayout() and setPixel().<p>
@param color
The color value(s) to set
@@ -154,51 +125,17 @@ interface XIeeeFloatBitmap : XBitmap
@param pos
Pixel position with the bounds of the bitmap to set.
- @throws com::sun::star::lang::IndexOutOfBoundsException
+ @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type>
if the given point is outside the permissible bitmap area.
- @throws com::sun::star::lang::IllegalArgumentException
+ @throws <type>com::sun::star::lang::IllegalArgumentException</type>
if the given memory layout does not match this bitmap's
layout, or if the given data sequence has too few or too much
elements.
*/
void setPixel( [in] sequence<float> color, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
raises (com::sun::star::lang::IllegalArgumentException,
- com::sun::star::lang::IndexOutOfBoundsException);
-
- //-------------------------------------------------------------------------
-
- /** Get a single pixel of the bitmap, returning its color
- value.
-
- Note that the bitmap memory layout might change for volatile
- bitmaps.<p>
-
- @param bitmapLayout
- The memory layout the returned data is in.
-
- @param pos
- A position, within the bounds of the bitmap, to retrieve the
- color from.
-
- @throws VolatileContentDestroyedException
- if the bitmap is volatile, and the content has been destroyed by the system.
-
- @throws com::sun::star::lang::IndexOutOfBoundsException
- if the given position is outside the permissible bitmap area.
- */
- sequence<float> getPixel( [out] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
- raises (com::sun::star::lang::IndexOutOfBoundsException,
- VolatileContentDestroyedException);
-
- //-------------------------------------------------------------------------
-
- /** Query the memory layout for this bitmap
-
- Please note that for volatile bitmaps, the memory layout might
- change between subsequent calls.
- */
- FloatingPointBitmapLayout getMemoryLayout();
+ com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };