Google Git
Sign in
apache / openoffice-org / refs/heads/services_https / . / content / gsl / canvas / api / rendering / XBitmapPalette.html
blob: 415a08b7a74d7d4a28febe486d5842ca4e987267 [file] [log] [blame]
<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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</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><dl>
<dt><b>Base Interfaces</b></dt>
<dd><pre style="font-family:monospace;"><strong>XBitmapPalette</strong>
&#x2517 ::com::sun::star::uno::XInterface
</pre></dd>
<dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle">
<tr>
<td class="imsum_left">::com::sun::star::uno::XInterface</td>
<td class="imsum_right"><dl></dl>
</td>
</tr>
</table>
</dd>
</dl>
</td>
</tr>
<tr>
<td><dl>
<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.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.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getPaletteIndex">getPaletteIndex</a></td>
<td class="imsum_right">Request the color for the given palette entry.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#setPaletteIndex">setPaletteIndex</a></td>
<td class="imsum_right">Set the color for the given palette entry.
&nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#getColorSpace">getColorSpace</a></td>
<td class="imsum_right">Query associated color space. &nbsp;</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="getPaletteIndex" class="membertitle">getPaletteIndex</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">sequence&lt; <a href="ColorComponent.html">ColorComponent</a> &gt;</td>
</tr>
<tr>
<td valign="top"><b>getPaletteIndex</b>(</td>
<td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>Request the color for 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>the device color sequence of the requested palette
entry.
</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="setPaletteIndex" class="membertitle">setPaletteIndex</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>setPaletteIndex</b>(</td>
<td valign="top">[in] sequence&lt; <a href="ColorComponent.html">ColorComponent</a> &gt;</td>
<td valign="bottom">&nbsp;color,</td>
</tr>
<tr>
<td/><td valign="top">[in] long</td>
<td valign="bottom">&nbsp;nIndex )</td>
</tr>
<tr>
<td valign="top" align="right">raises( </td>
<td valign="top" colspan="2">::com::sun::star::lang::IndexOutOfBoundsException,<br>
::com::sun::star::lang::IllegalArgumentException );</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 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 &copy; 2003 Sun Microsystems, Inc.</p>
</div> <!-- id="adc-idlref" -->
</body>
</html>