1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_XIntegerBitmap_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_rendering_XIntegerBitmap_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/geometry/IntegerPoint2D.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/geometry/IntegerRectangle2D.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__ 39*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/IntegerBitmapLayout.idl> 40*b1cdbd2cSJim Jagielski#endif 41*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_XIntegerReadOnlyBitmap_idl__ 42*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/XIntegerReadOnlyBitmap.idl> 43*b1cdbd2cSJim Jagielski#endif 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski 46*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module rendering { 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski/** This is a specialized interface for bitmaps having integer color 49*b1cdbd2cSJim Jagielski channels.<p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 52*b1cdbd2cSJim Jagielski */ 53*b1cdbd2cSJim Jagielskiinterface XIntegerBitmap : XIntegerReadOnlyBitmap 54*b1cdbd2cSJim Jagielski{ 55*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 56*b1cdbd2cSJim Jagielski 57*b1cdbd2cSJim Jagielski /** Set raw data of a bitmap.<p> 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski Set raw data of a bitmap, in the format as defined by 60*b1cdbd2cSJim Jagielski getMemoryLayout(). With the given rectangle, a subset of the 61*b1cdbd2cSJim Jagielski bitmap can be changed. If the internal data format's pixel are 62*b1cdbd2cSJim Jagielski not integer multiples of bytes (i.e. if one pixel occupies 63*b1cdbd2cSJim Jagielski less than a byte), the leftover content of the bytes at the 64*b1cdbd2cSJim Jagielski right of each scanline is ignored and left unchanged in the 65*b1cdbd2cSJim Jagielski bitmap. When setting subsets of the bitmap, the same scanline 66*b1cdbd2cSJim Jagielski padding takes place as when the whole bitmap is changed.<p> 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski When setting data on volatile bitmaps, always call isValid() 69*b1cdbd2cSJim Jagielski before, and retrieve a new memory layout via 70*b1cdbd2cSJim Jagielski getMemoryLayout(). At least under Windows, the memory layout 71*b1cdbd2cSJim Jagielski can change for the same bitmap, if the user e.g. switches the 72*b1cdbd2cSJim Jagielski screen resolution. Thus, this method will throw an 73*b1cdbd2cSJim Jagielski IllegalArgumentException, if the memory layout changed between 74*b1cdbd2cSJim Jagielski a call to getMemoryLayout() and setData(). 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski @param data 77*b1cdbd2cSJim Jagielski Data to set 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski @param bitmapLayout 80*b1cdbd2cSJim Jagielski Layout of the data to set. Must match this bitmap's current 81*b1cdbd2cSJim Jagielski layout. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @param rect 84*b1cdbd2cSJim Jagielski Destination rectangle, within the bounds of the bitmap, to set 85*b1cdbd2cSJim Jagielski the data in. 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 88*b1cdbd2cSJim Jagielski if parts of the given rectangle are outside the permissible 89*b1cdbd2cSJim Jagielski bitmap area. 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IllegalArgumentException</type> 92*b1cdbd2cSJim Jagielski if the given memory layout does not match this bitmap's 93*b1cdbd2cSJim Jagielski layout, or if the given data sequence has too few or too many 94*b1cdbd2cSJim Jagielski elements. 95*b1cdbd2cSJim Jagielski */ 96*b1cdbd2cSJim Jagielski void setData( [in] sequence<byte> data, [in] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerRectangle2D rect ) 97*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IllegalArgumentException, 98*b1cdbd2cSJim Jagielski com::sun::star::lang::IndexOutOfBoundsException); 99*b1cdbd2cSJim Jagielski 100*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 101*b1cdbd2cSJim Jagielski 102*b1cdbd2cSJim Jagielski /** Set a single pixel of the bitmap with the given color 103*b1cdbd2cSJim Jagielski value.<p> 104*b1cdbd2cSJim Jagielski 105*b1cdbd2cSJim Jagielski If the internal data format's pixel are not integer multiples 106*b1cdbd2cSJim Jagielski of bytes (i.e. if one pixel occupies less than a byte), the 107*b1cdbd2cSJim Jagielski color value is expected in the least significant bits of the 108*b1cdbd2cSJim Jagielski single byte given as the color.<p> 109*b1cdbd2cSJim Jagielski 110*b1cdbd2cSJim Jagielski When setting data on volatile bitmaps, always call isValid() 111*b1cdbd2cSJim Jagielski before, and retrieve a new memory layout via 112*b1cdbd2cSJim Jagielski getMemoryLayout(). At least under Windows, the memory layout 113*b1cdbd2cSJim Jagielski can change for the same bitmap, if the user e.g. switches the 114*b1cdbd2cSJim Jagielski screen resolution. Thus, this method will throw an 115*b1cdbd2cSJim Jagielski IllegalArgumentException, if the memory layout changed between 116*b1cdbd2cSJim Jagielski a call to getMemoryLayout() and setPixel(). 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski @param color 119*b1cdbd2cSJim Jagielski The color value(s) to set 120*b1cdbd2cSJim Jagielski 121*b1cdbd2cSJim Jagielski @param bitmapLayout 122*b1cdbd2cSJim Jagielski Layout of the color elements to set. Must match this bitmap's 123*b1cdbd2cSJim Jagielski current layout. 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski @param pos 126*b1cdbd2cSJim Jagielski Pixel position with the bounds of the bitmap to set. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 129*b1cdbd2cSJim Jagielski if the given point is outside the permissible bitmap area. 130*b1cdbd2cSJim Jagielski 131*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IllegalArgumentException</type> 132*b1cdbd2cSJim Jagielski if the given memory layout does not match this bitmap's 133*b1cdbd2cSJim Jagielski layout, or if the given data sequence has too few or too many 134*b1cdbd2cSJim Jagielski elements. 135*b1cdbd2cSJim Jagielski */ 136*b1cdbd2cSJim Jagielski void setPixel( [in] sequence<byte> color, [in] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos ) 137*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IllegalArgumentException, 138*b1cdbd2cSJim Jagielski com::sun::star::lang::IndexOutOfBoundsException); 139*b1cdbd2cSJim Jagielski}; 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski}; }; }; }; 142*b1cdbd2cSJim Jagielski 143*b1cdbd2cSJim Jagielski#endif 144