1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XBitmapPalette_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_rendering_XBitmapPalette_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 34*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 35*cdf0e10cSrcweir#endif 36*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 37*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 38*cdf0e10cSrcweir#endif 39*cdf0e10cSrcweir#ifndef __com_sun_star_rendering_XColorSpace_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/rendering/XColorSpace.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir 44*cdf0e10cSrcweirmodule com { module sun { module star { module rendering { 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir/** Interface to access the palette of a color-indexed bitmap. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir @since OOo 2.0 49*cdf0e10cSrcweir */ 50*cdf0e10cSrcweirinterface XBitmapPalette : ::com::sun::star::uno::XInterface 51*cdf0e10cSrcweir{ 52*cdf0e10cSrcweir /** Request the number of palette entries available. 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir @return the number of entries in this palette. 55*cdf0e10cSrcweir */ 56*cdf0e10cSrcweir long getNumberOfEntries(); 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir //------------------------------------------------------------------------- 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir /** Request the color for the given palette entry. 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @param entry 63*cdf0e10cSrcweir Output parameter for the color components at the given palette 64*cdf0e10cSrcweir entry. 65*cdf0e10cSrcweir 66*cdf0e10cSrcweir @param nIndex 67*cdf0e10cSrcweir The index of the palette entry to be retrieved. Valid range is 68*cdf0e10cSrcweir [0,getNumberOfEntries()-1]. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @return <TRUE/>, if the given palette entry should be displayed 71*cdf0e10cSrcweir opaque, and <FALSE/> if the entry should be displayed 72*cdf0e10cSrcweir transparent. This is sometimes used for so-called mask 73*cdf0e10cSrcweir transparency, by flagging certain palette entries to be fully 74*cdf0e10cSrcweir transparent when displaying the bitmap. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 77*cdf0e10cSrcweir if the index is smaller than zero or larger than 78*cdf0e10cSrcweir <member>XBitmapPalette::getNumberOfEntries()</member>-1. 79*cdf0e10cSrcweir */ 80*cdf0e10cSrcweir boolean getIndex( [out] sequence<ColorComponent> entry, [in] long nIndex ) 81*cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException); 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir //------------------------------------------------------------------------- 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir /** Set the color for the given palette entry. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir @param color 88*cdf0e10cSrcweir Sequence of device color values in the associated bitmap's 89*cdf0e10cSrcweir device color format. 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir @param transparency 92*cdf0e10cSrcweir When <TRUE/>, the specified palette entry is displayed as 93*cdf0e10cSrcweir opaque color. When <FALSE/>, the given entry displays as fully 94*cdf0e10cSrcweir transparent during output. 95*cdf0e10cSrcweir 96*cdf0e10cSrcweir @param nIndex 97*cdf0e10cSrcweir The index of the palette entry to be changed. Valid range is 98*cdf0e10cSrcweir [0,getNumberOfEntries()-1]. 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir @return whether the palette entry was changed. For read-only 101*cdf0e10cSrcweir entries, this method always returns <FALSE/>. 102*cdf0e10cSrcweir 103*cdf0e10cSrcweir @throws <type>com::sun::star::lang::IndexOutOfBoundsException</type> 104*cdf0e10cSrcweir if the index is smaller than zero or larger than 105*cdf0e10cSrcweir <member>XBitmapPalette::getNumberOfEntries()</member>-1. 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir @throws <type>com::sun::star::lang::IllegalArgumentException</type> 108*cdf0e10cSrcweir if the given sequence of color components does not match the 109*cdf0e10cSrcweir associated bitmap's device color format. 110*cdf0e10cSrcweir */ 111*cdf0e10cSrcweir boolean setIndex( [in] sequence<ColorComponent> color, [in] boolean transparency, [in] long nIndex ) 112*cdf0e10cSrcweir raises (com::sun::star::lang::IndexOutOfBoundsException, 113*cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException); 114*cdf0e10cSrcweir 115*cdf0e10cSrcweir //------------------------------------------------------------------------- 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir /** Query associated color space.<p> 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir @return the color space that is associated with this palette. 120*cdf0e10cSrcweir */ 121*cdf0e10cSrcweir XColorSpace getColorSpace( ); 122*cdf0e10cSrcweir}; 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir}; }; }; }; 125*cdf0e10cSrcweir 126*cdf0e10cSrcweir#endif 127