:: com :: sun :: star :: rendering ::
|
unpublished |
interface XBitmapPalette |
|
|
|
- Usage Restrictions
- not published
- Description
- Interface to access the palette of a color-indexed bitmap.
- Since
- OOo 2.0
|
Methods' Summary |
getNumberOfEntries |
Request the number of palette entries available.
|
getIndex |
Request the color for the given palette entry.
|
setIndex |
Set the color for the given palette entry.
|
getColorSpace |
Query associated color space. |
Methods' Details |
getNumberOfEntries
long |
getNumberOfEntries(); |
- Description
- Request the number of palette entries available.
- Returns
- the number of entries in this palette.
|
|
getIndex
- Description
- Request the color for the given palette entry.
- Parameter entry
- Output parameter for the color components at the given palette
entry.
- Parameter nIndex
- The index of the palette entry to be retrieved. Valid range is
[0,getNumberOfEntries()-1].
- Returns
- true, if the given palette entry should be displayed
opaque, and false 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.
- Throws
- com::sun::star::lang::IndexOutOfBoundsException
if the index is smaller than zero or larger than
XBitmapPalette::getNumberOfEntries()-1.
|
|
setIndex
- 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 transparency
- When true, the specified palette entry is displayed as
opaque color. When false, the given entry displays as fully
transparent during output.
- 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 © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.