diff options
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl new file mode 100644 index 000000000..92a1547f1 --- /dev/null +++ b/offapi/com/sun/star/rendering/XIeeeFloatBitmap.idl @@ -0,0 +1,118 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_rendering_XIeeeFloatBitmap_idl__ +#define __com_sun_star_rendering_XIeeeFloatBitmap_idl__ + +#include <com/sun/star/lang/IllegalArgumentException.idl> +#include <com/sun/star/lang/IndexOutOfBoundsException.idl> +#include <com/sun/star/rendering/FloatingPointBitmapLayout.idl> +#include <com/sun/star/geometry/IntegerPoint2D.idl> +#include <com/sun/star/geometry/IntegerRectangle2D.idl> +#include <com/sun/star/rendering/XIeeeFloatReadOnlyBitmap.idl> +#include <com/sun/star/rendering/VolatileContentDestroyedException.idl> + + +module com { module sun { module star { module rendering { + +/** Specialized interface for bitmaps containing IEEE floats as their + color components.<p> + */ +interface XIeeeFloatBitmap : XIeeeFloatReadOnlyBitmap +{ + + /** 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 + bitmap can be changed. When setting subsets of the bitmap, the + same scanline padding takes place as when the whole bitmap is + changed.<p> + + When setting data on volatile bitmaps, always call isValid() + before, and retrieve a new memory layout via + getMemoryLayout(). At least under Windows, the memory layout + 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().<p> + + @param data + Data to set + + @param bitmapLayout + Layout of the data to set. Must match this bitmap's current + layout. + + @param rect + Destination rectangle, within the bounds of the bitmap, to set + the data in. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if parts of the given rectangle are outside the permissible + bitmap area. + + @throws com::sun::star::lang::IllegalArgumentException + 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 setData( [in] sequence<float> data, [in] FloatingPointBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) + raises (com::sun::star::lang::IllegalArgumentException, + com::sun::star::lang::IndexOutOfBoundsException); + + + /** Set a single pixel of the bitmap with the given color + value.<p> + + When setting data on volatile bitmaps, always call isValid() + before, and retrieve a new memory layout via + getMemoryLayout(). At least under Windows, the memory layout + 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().<p> + + @param color + The color value(s) to set + + @param bitmapLayout + Layout of the color elements to set. Must match this bitmap's + current layout. + + @param pos + Pixel position with the bounds of the bitmap to set. + + @throws com::sun::star::lang::IndexOutOfBoundsException + if the given point is outside the permissible bitmap area. + + @throws com::sun::star::lang::IllegalArgumentException + 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); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |