1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmapPalette_idl__ 24cdf0e10cSrcweir#define __com_sun_star_rendering_XBitmapPalette_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 30cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 31cdf0e10cSrcweir#endif 32cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 33cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 34cdf0e10cSrcweir#endif 35cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XColorSpace_idl__ 36cdf0e10cSrcweir#include <com/sun/star/rendering/XColorSpace.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir 40cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 41cdf0e10cSrcweir 42cdf0e10cSrcweir/** Interface to access the palette of a color-indexed bitmap. 43cdf0e10cSrcweir 44*d695a2a0SJürgen Schmidt @since OpenOffice 2.0 45cdf0e10cSrcweir */ 46cdf0e10cSrcweirinterface XBitmapPalette : ::com::sun::star::uno::XInterface 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir /** Request the number of palette entries available. 49cdf0e10cSrcweir 50cdf0e10cSrcweir @return the number of entries in this palette. 51cdf0e10cSrcweir */ 52cdf0e10cSrcweir long getNumberOfEntries(); 53cdf0e10cSrcweir 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir 56cdf0e10cSrcweir /** Request the color for the given palette entry. 57cdf0e10cSrcweir 58cdf0e10cSrcweir @param entry 59cdf0e10cSrcweir Output parameter for the color components at the given palette 60cdf0e10cSrcweir entry. 61cdf0e10cSrcweir 62cdf0e10cSrcweir @param nIndex 63cdf0e10cSrcweir The index of the palette entry to be retrieved. Valid range is 64cdf0e10cSrcweir [0,getNumberOfEntries()-1]. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @return <TRUE/>, if the given palette entry should be displayed 67cdf0e10cSrcweir opaque, and <FALSE/> if the entry should be displayed 68cdf0e10cSrcweir transparent. This is sometimes used for so-called mask 69cdf0e10cSrcweir transparency, by flagging certain palette entries to be fully 70cdf0e10cSrcweir transparent when displaying the bitmap. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 73cdf0e10cSrcweir if the index is smaller than zero or larger than 74cdf0e10cSrcweir <member>XBitmapPalette::getNumberOfEntries()</member>-1. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir boolean getIndex( [out] sequence<ColorComponent> entry, [in] long nIndex ) 77cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException); 78cdf0e10cSrcweir 79cdf0e10cSrcweir //------------------------------------------------------------------------- 80cdf0e10cSrcweir 81cdf0e10cSrcweir /** Set the color for the given palette entry. 82cdf0e10cSrcweir 83cdf0e10cSrcweir @param color 84cdf0e10cSrcweir Sequence of device color values in the associated bitmap's 85cdf0e10cSrcweir device color format. 86cdf0e10cSrcweir 87cdf0e10cSrcweir @param transparency 88cdf0e10cSrcweir When <TRUE/>, the specified palette entry is displayed as 89cdf0e10cSrcweir opaque color. When <FALSE/>, the given entry displays as fully 90cdf0e10cSrcweir transparent during output. 91cdf0e10cSrcweir 92cdf0e10cSrcweir @param nIndex 93cdf0e10cSrcweir The index of the palette entry to be changed. Valid range is 94cdf0e10cSrcweir [0,getNumberOfEntries()-1]. 95cdf0e10cSrcweir 96cdf0e10cSrcweir @return whether the palette entry was changed. For read-only 97cdf0e10cSrcweir entries, this method always returns <FALSE/>. 98cdf0e10cSrcweir 99cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 100cdf0e10cSrcweir if the index is smaller than zero or larger than 101cdf0e10cSrcweir <member>XBitmapPalette::getNumberOfEntries()</member>-1. 102cdf0e10cSrcweir 103cdf0e10cSrcweir @throws <type>com::sun::star::lang::IllegalArgumentException</type> 104cdf0e10cSrcweir if the given sequence of color components does not match the 105cdf0e10cSrcweir associated bitmap's device color format. 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir boolean setIndex( [in] sequence<ColorComponent> color, [in] boolean transparency, [in] long nIndex ) 108cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 109cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException); 110cdf0e10cSrcweir 111cdf0e10cSrcweir //------------------------------------------------------------------------- 112cdf0e10cSrcweir 113cdf0e10cSrcweir /** Query associated color space.<p> 114cdf0e10cSrcweir 115cdf0e10cSrcweir @return the color space that is associated with this palette. 116cdf0e10cSrcweir */ 117cdf0e10cSrcweir XColorSpace getColorSpace( ); 118cdf0e10cSrcweir}; 119cdf0e10cSrcweir 120cdf0e10cSrcweir}; }; }; }; 121cdf0e10cSrcweir 122cdf0e10cSrcweir#endif 123