X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..e333075415c35d2e869ea585fa41f01a2c938897:/interface/palette.h diff --git a/interface/palette.h b/interface/palette.h index 06273aeec9..6c8d61c460 100644 --- a/interface/palette.h +++ b/interface/palette.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: palette.h -// Purpose: documentation for wxPalette class +// Purpose: interface of wxPalette // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -27,11 +27,9 @@ @category{gdi} @stdobjects - Objects: - wxNullPalette + ::Objects:, ::wxNullPalette, - @seealso - wxDC::SetPalette, wxBitmap + @see wxDC::SetPalette, wxBitmap */ class wxPalette : public wxGDIObject { @@ -40,7 +38,7 @@ public: /** Creates a palette from arrays of size @e n, one for each red, blue or green component. - + @param palette A pointer or reference to the palette to copy. @param n @@ -51,7 +49,7 @@ public: An array of green values. @param blue An array of blue values. - + @see Create() */ wxPalette(); @@ -71,7 +69,7 @@ public: /** Creates a palette from arrays of size @e n, one for each red, blue or green component. - + @param n The number of indices in the palette. @param red @@ -80,9 +78,9 @@ public: An array of green values. @param blue An array of blue values. - + @returns @true if the creation was successful, @false otherwise. - + @see wxPalette() */ bool Create(int n, const unsigned char* red, @@ -96,16 +94,16 @@ public: /** Returns a pixel value (index into the palette) for the given RGB values. - + @param red Red value. @param green Green value. @param blue Blue value. - + @returns The nearest palette index or wxNOT_FOUND for unexpected errors. - + @see GetRGB() */ int GetPixel(unsigned char red, unsigned char green, @@ -113,7 +111,7 @@ public: /** Returns RGB values for a given palette index. - + @param pixel The palette index. @param red @@ -122,9 +120,9 @@ public: Receives the green value. @param blue Receives the blue value. - + @returns @true if the operation was successful. - + @see GetPixel() */ bool GetRGB(int pixel, const unsigned char* red, @@ -141,3 +139,17 @@ public: */ wxPalette operator =(const wxPalette& palette); }; + + +/** + FIXME +*/ +wxPalette Objects: +; + +/** + FIXME +*/ +wxPalette wxNullPalette; + +