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_XBitmapPalette_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_rendering_XBitmapPalette_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 30*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IllegalArgumentException.idl> 31*b1cdbd2cSJim Jagielski#endif 32*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 33*b1cdbd2cSJim Jagielski#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 34*b1cdbd2cSJim Jagielski#endif 35*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_rendering_XColorSpace_idl__ 36*b1cdbd2cSJim Jagielski#include <com/sun/star/rendering/XColorSpace.idl> 37*b1cdbd2cSJim Jagielski#endif 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module rendering { 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski/** Interface to access the palette of a color-indexed bitmap. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski @since OpenOffice 2.0 45*b1cdbd2cSJim Jagielski */ 46*b1cdbd2cSJim Jagielskiinterface XBitmapPalette : ::com::sun::star::uno::XInterface 47*b1cdbd2cSJim Jagielski{ 48*b1cdbd2cSJim Jagielski /** Request the number of palette entries available. 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski @return the number of entries in this palette. 51*b1cdbd2cSJim Jagielski */ 52*b1cdbd2cSJim Jagielski long getNumberOfEntries(); 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski /** Request the color for the given palette entry. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @param entry 59*b1cdbd2cSJim Jagielski Output parameter for the color components at the given palette 60*b1cdbd2cSJim Jagielski entry. 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski @param nIndex 63*b1cdbd2cSJim Jagielski The index of the palette entry to be retrieved. Valid range is 64*b1cdbd2cSJim Jagielski [0,getNumberOfEntries()-1]. 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski @return <TRUE/>, if the given palette entry should be displayed 67*b1cdbd2cSJim Jagielski opaque, and <FALSE/> if the entry should be displayed 68*b1cdbd2cSJim Jagielski transparent. This is sometimes used for so-called mask 69*b1cdbd2cSJim Jagielski transparency, by flagging certain palette entries to be fully 70*b1cdbd2cSJim Jagielski transparent when displaying the bitmap. 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 73*b1cdbd2cSJim Jagielski if the index is smaller than zero or larger than 74*b1cdbd2cSJim Jagielski <member>XBitmapPalette::getNumberOfEntries()</member>-1. 75*b1cdbd2cSJim Jagielski */ 76*b1cdbd2cSJim Jagielski boolean getIndex( [out] sequence<ColorComponent> entry, [in] long nIndex ) 77*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IndexOutOfBoundsException); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 80*b1cdbd2cSJim Jagielski 81*b1cdbd2cSJim Jagielski /** Set the color for the given palette entry. 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski @param color 84*b1cdbd2cSJim Jagielski Sequence of device color values in the associated bitmap's 85*b1cdbd2cSJim Jagielski device color format. 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski @param transparency 88*b1cdbd2cSJim Jagielski When <TRUE/>, the specified palette entry is displayed as 89*b1cdbd2cSJim Jagielski opaque color. When <FALSE/>, the given entry displays as fully 90*b1cdbd2cSJim Jagielski transparent during output. 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski @param nIndex 93*b1cdbd2cSJim Jagielski The index of the palette entry to be changed. Valid range is 94*b1cdbd2cSJim Jagielski [0,getNumberOfEntries()-1]. 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski @return whether the palette entry was changed. For read-only 97*b1cdbd2cSJim Jagielski entries, this method always returns <FALSE/>. 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 100*b1cdbd2cSJim Jagielski if the index is smaller than zero or larger than 101*b1cdbd2cSJim Jagielski <member>XBitmapPalette::getNumberOfEntries()</member>-1. 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski @throws <type>com::sun::star::lang::IllegalArgumentException</type> 104*b1cdbd2cSJim Jagielski if the given sequence of color components does not match the 105*b1cdbd2cSJim Jagielski associated bitmap's device color format. 106*b1cdbd2cSJim Jagielski */ 107*b1cdbd2cSJim Jagielski boolean setIndex( [in] sequence<ColorComponent> color, [in] boolean transparency, [in] long nIndex ) 108*b1cdbd2cSJim Jagielski raises (com::sun::star::lang::IndexOutOfBoundsException, 109*b1cdbd2cSJim Jagielski com::sun::star::lang::IllegalArgumentException); 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /** Query associated color space.<p> 114*b1cdbd2cSJim Jagielski 115*b1cdbd2cSJim Jagielski @return the color space that is associated with this palette. 116*b1cdbd2cSJim Jagielski */ 117*b1cdbd2cSJim Jagielski XColorSpace getColorSpace( ); 118*b1cdbd2cSJim Jagielski}; 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski}; }; }; }; 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski#endif 123