Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adjusted indentation with astyle; added Id keyword

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-08 14:43:31 +00:00
parent aa6ec1d787
commit 7c913512a4
269 changed files with 9052 additions and 9058 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
interface/palette.h
View File

@@ -9,27 +9,27 @@
/**
@class wxPalette
@wxheader{palette.h}
A palette is a table that maps pixel values to RGB colours. It allows the
colours of a low-depth bitmap, for example, to be mapped to the available
colours in a display. The notion of palettes is becoming more and more
obsolete nowadays and only the MSW port is still using a native palette.
All other ports use generic code which is basically just an array of
colours.
colours.
It is likely that in the future the only use for palettes within wxWidgets
will be for representing colour indeces from images (such as GIF or PNG).
The image handlers for these formats have been modified to create a palette
if there is such information in the original image file (usually 256 or less
colour images). See wxImage for more information.
@library{wxcore}
@category{gdi}
@stdobjects
Objects:
wxNullPalette
@seealso
wxDC::SetPalette, wxBitmap
*/
@@ -41,28 +41,28 @@ public:
Creates a palette from arrays of size @e n, one for each
red, blue or green component.
@param palette
@param palette
A pointer or reference to the palette to copy.
@param n
@param n
The number of indices in the palette.
@param red
@param red
An array of red values.
@param green
@param green
An array of green values.
@param blue
@param blue
An array of blue values.
@sa Create()
*/
wxPalette();
wxPalette(const wxPalette& palette);
wxPalette(int n, const unsigned char* red,
const unsigned char* green,
const unsigned char* blue);
wxPalette(const wxPalette& palette);
wxPalette(int n, const unsigned char* red,
const unsigned char* green,
const unsigned char* blue);
//@}
/**
@@ -76,16 +76,16 @@ public:
Creates a palette from arrays of size @e n, one for each
red, blue or green component.
@param n
@param n
The number of indices in the palette.
@param red
@param red
An array of red values.
@param green
@param green
An array of green values.
@param blue
@param blue
An array of blue values.
@returns @true if the creation was successful, @false otherwise.
@@ -104,13 +104,13 @@ public:
/**
Returns a pixel value (index into the palette) for the given RGB values.
@param red
@param red
Red value.
@param green
@param green
Green value.
@param blue
@param blue
Blue value.
@returns The nearest palette index or wxNOT_FOUND for unexpected errors.
@@ -123,16 +123,16 @@ public:
/**
Returns RGB values for a given palette index.
@param pixel
@param pixel
The palette index.
@param red
@param red
Receives the red value.
@param green
@param green
Receives the green value.
@param blue
@param blue
Receives the blue value.
@returns @true if the operation was successful.
@@ -140,8 +140,8 @@ public:
@sa GetPixel()
*/
#define bool GetRGB(int pixel, const unsigned char* red,
const unsigned char* green,
const unsigned char* blue) /* implementation is private */
const unsigned char* green,
const unsigned char* blue) /* implementation is private */
/**
Returns @true if palette data is present.