944eb99027
Doxygen does not know type element and will recognize strings that contain capital letter (all API types do) automatically as type. This patch removes 15k doxygen warnings. git ls-files | grep \\.idl | xargs sed -i "s,<type>\([^<]\+\)</type>,\1," Change-Id: I45c07cf0b115d5fb5353f4aa9719839615ea1150
119 lines
4.8 KiB
Text
119 lines
4.8 KiB
Text
/* -*- 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_XIeeeDoubleBitmap_idl__
|
|
#define __com_sun_star_rendering_XIeeeDoubleBitmap_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/XIeeeDoubleReadOnlyBitmap.idl>
|
|
#include <com/sun/star/rendering/VolatileContentDestroyedException.idl>
|
|
|
|
|
|
module com { module sun { module star { module rendering {
|
|
|
|
/** This is a specialized interface for bitmaps containing IEEE
|
|
doubles for their color components.<p>
|
|
*/
|
|
interface XIeeeDoubleBitmap : XIeeeDoubleReadOnlyBitmap
|
|
{
|
|
|
|
/** 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<double> 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<double> 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: */
|