:: 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 © 2000, 2014 LibreOffice contributors and/or their affiliates. All rights reserved.
LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.
The Document Foundation acknowledges all community members, please find more info at our website.
Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "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 trademark policy.