<html> <head> <title>Interface XBitmapPalette</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XBitmapPalette-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">rendering</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XBitmapPalette</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>Interface to access the palette of a color-indexed bitmap. </dd> <dt><b>Since </b></dt> <dd>OOo 2.0 </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getNumberOfEntries">getNumberOfEntries</a></td> <td class="imsum_right">Request the number of palette entries available. </td> </tr> <tr> <td class="imsum_left"><a href="#getIndex">getIndex</a></td> <td class="imsum_right">Request the color for the given palette entry. </td> </tr> <tr> <td class="imsum_left"><a href="#setIndex">setIndex</a></td> <td class="imsum_right">Set the color for the given palette entry. </td> </tr> <tr> <td class="imsum_left"><a href="#getColorSpace">getColorSpace</a></td> <td class="imsum_right">Query associated color space. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getNumberOfEntries" class="membertitle">getNumberOfEntries</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>getNumberOfEntries</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Request the number of palette entries available. </dd> <dt><b>Returns</b></dt> <dd>the number of entries in this palette. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getIndex" class="membertitle">getIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>getIndex</b>(</td> <td valign="top">[out] sequence< <a href="ColorComponent.html">ColorComponent</a> ></td> <td valign="bottom"> entry,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Request the color for the given palette entry. </dd> <dt><b>Parameter entry</b></dt> <dd>Output parameter for the color components at the given palette entry. </dd> <dt><b>Parameter nIndex</b></dt> <dd>The index of the palette entry to be retrieved. Valid range is [0,getNumberOfEntries()-1]. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if the given palette entry should be displayed opaque, and <b>false</b> if the entry should be displayed transparent. This is sometimes used for so-called mask transparency, by flagging certain palette entries to be fully transparent when displaying the bitmap. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than <a href="XBitmapPalette.html">XBitmapPalette</a>::<a href="XBitmapPalette.html#getNumberOfEntries">getNumberOfEntries()</a>-1. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setIndex" class="membertitle">setIndex</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>setIndex</b>(</td> <td valign="top">[in] sequence< <a href="ColorComponent.html">ColorComponent</a> ></td> <td valign="bottom"> color,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> transparency,</td> </tr> <tr> <td/><td valign="top">[in] long</td> <td valign="bottom"> nIndex )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IndexOutOfBoundsException.html">IndexOutOfBoundsException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Set the color for the given palette entry. </dd> <dt><b>Parameter color</b></dt> <dd>Sequence of device color values in the associated bitmap's device color format. </dd> <dt><b>Parameter transparency</b></dt> <dd>When <b>true</b>, the specified palette entry is displayed as opaque color. When <b>false</b>, the given entry displays as fully transparent during output. </dd> <dt><b>Parameter nIndex</b></dt> <dd>The index of the palette entry to be changed. Valid range is [0,getNumberOfEntries()-1]. </dd> <dt><b>Returns</b></dt> <dd>whether the palette entry was changed. For read-only entries, this method always returns <b>false</b>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IndexOutOfBoundsException if the index is smaller than zero or larger than <a href="XBitmapPalette.html">XBitmapPalette</a>::<a href="XBitmapPalette.html#getNumberOfEntries">getNumberOfEntries()</a>-1. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the given sequence of color components does not match the associated bitmap's device color format. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getColorSpace" class="membertitle">getColorSpace</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XColorSpace.html">XColorSpace</a></td> </tr> <tr> <td valign="top"><b>getColorSpace</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Query associated color space.</dd> <dd><p> </dd> <dt><b>Returns</b></dt> <dd>the color space that is associated with this palette. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
