Language
The Free and Open Productivity Suite
:: com :: sun :: star :: rendering ::
|
| unpublished |
interface XBitmapPalette |
|
|
- Base Interfaces
XBitmapPalette
┗ ::com::sun::star::uno::XInterface
| ::com::sun::star::uno::XInterface |
|
|
- Description
- Interface to access the palette of a color-indexed bitmap.
- Since
- OOo 2.0.0
|
| Methods' Details |
getNumberOfEntries
| long |
| getNumberOfEntries(); |
- Description
- Request the number of palette entries available.
- Returns
- the number of entries in this palette.
|
|
getPaletteIndex
| sequence< ColorComponent > |
| getPaletteIndex( |
[in] long |
nIndex ) |
| raises( |
::com::sun::star::lang::IndexOutOfBoundsException ); |
- Description
- Request the color for the given palette entry.
- Parameter nIndex
- The index of the palette entry to be retrieved. Valid range is
[0,getNumberOfEntries()-1].
- Returns
- the device color sequence of the requested palette
entry.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if the index is smaller than zero or larger than
XBitmapPalette::getNumberOfEntries() -1.
|
|
setPaletteIndex
| boolean |
| setPaletteIndex( |
[in] sequence< ColorComponent > |
color, |
| [in] long |
nIndex ) |
| raises( |
::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::lang::IllegalArgumentException ); |
- Description
- Set the color for the given palette entry.
- Parameter color
- Sequence of device color values in the associated bitmap's
device color format.
- Parameter nIndex
- The index of the palette entry to be changed. Valid range is
[0,getNumberOfEntries()-1].
- Returns
- whether the palette entry was changed. For read-only
entries, this method always returns false .
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if the index is smaller than zero or larger than
XBitmapPalette::getNumberOfEntries() -1.
- Throws
- com::sun::star::lang::IllegalArgumentException
if the given sequence of color components does not match the
associated bitmap's device color format.
|
|
getColorSpace
- Description
- Query associated color space.
- Returns
- the color space that is associated with this palette.
|
|
Top of Page
Copyright © 2003 Sun Microsystems, Inc.
