1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_rendering_XIntegerBitmap_idl__
#define __com_sun_star_rendering_XIntegerBitmap_idl__
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__
#include <com/sun/star/lang/IndexOutOfBoundsException.idl>
#endif
#ifndef __com_sun_star_geometry_IntegerPoint2D_idl__
#include <com/sun/star/geometry/IntegerPoint2D.idl>
#endif
#ifndef __com_sun_star_geometry_IntegerRectangle2D_idl__
#include <com/sun/star/geometry/IntegerRectangle2D.idl>
#endif
#ifndef __com_sun_star_rendering_IntegerBitmapLayout_idl__
#include <com/sun/star/rendering/IntegerBitmapLayout.idl>
#endif
#ifndef __com_sun_star_rendering_XIntegerReadOnlyBitmap_idl__
#include <com/sun/star/rendering/XIntegerReadOnlyBitmap.idl>
#endif
module com { module sun { module star { module rendering {
/** This is a specialized interface for bitmaps having integer color
channels.<p>
@since OOo 2.0.0
*/
interface XIntegerBitmap : XIntegerReadOnlyBitmap
{
//-------------------------------------------------------------------------
/** 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. If the internal data format's pixel are
not integer multiples of bytes (i.e. if one pixel occupies
less than a byte), the leftover content of the bytes at the
right of each scanline is ignored and left unchanged in the
bitmap. 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().
@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 <type>com::sun::star::lang::IndexOutOfBoundsException</type>
if parts of the given rectangle are outside the permissible
bitmap area.
@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 many
elements.
*/
void setData( [in] sequence<byte> data, [in] IntegerBitmapLayout 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>
If the internal data format's pixel are not integer multiples
of bytes (i.e. if one pixel occupies less than a byte), the
color value is expected in the least significant bits of the
single byte given as the color.<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().
@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 <type>com::sun::star::lang::IndexOutOfBoundsException</type>
if the given point is outside the permissible bitmap area.
@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 many
elements.
*/
void setPixel( [in] sequence<byte> color, [in] IntegerBitmapLayout bitmapLayout, [in] ::com::sun::star::geometry::IntegerPoint2D pos )
raises (com::sun::star::lang::IllegalArgumentException,
com::sun::star::lang::IndexOutOfBoundsException);
};
}; }; }; };
#endif
|
