// Purpose: interface of wxPalette
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
/**
Copy constructor, uses @ref overview_refcount.
+
+ @param palette
+ A reference to the palette to copy.
*/
wxPalette(const wxPalette& palette);
Creates a palette from arrays of size @a n, one for each red, blue or
green component.
- @param palette
- A pointer or reference to the palette to copy.
@param n
The number of indices in the palette.
@param red
@param blue
An array of blue values.
+ @beginWxPerlOnly
+ In wxPerl this method takes as parameters
+ 3 array references (they must be of the same length).
+ @endWxPerlOnly
+
@see Create()
*/
wxPalette(int n, const unsigned char* red,
@see @ref overview_refcount_destruct "reference-counted object destruction"
*/
- ~wxPalette();
+ virtual ~wxPalette();
/**
Creates a palette from arrays of size @a n, one for each red, blue or
/**
Returns number of entries in palette.
*/
- int GetColoursCount() const;
+ virtual int GetColoursCount() const;
/**
Returns a pixel value (index into the palette) for the given RGB values.
@return @true if the operation was successful.
+ @beginWxPerlOnly
+ In wxPerl this method takes only the @a pixel parameter and
+ returns a 3-element list (or the empty list upon failure).
+ @endWxPerlOnly
+
@see GetPixel()
*/
- bool GetRGB(int pixel, const unsigned char* red,
- const unsigned char* green,
- const unsigned char* blue) const;
+ bool GetRGB(int pixel, unsigned char* red, unsigned char* green,
+ unsigned char* blue) const;
/**
Returns @true if palette data is present.
*/
- bool IsOk() const;
+ virtual bool IsOk() const;
/**
Assignment operator, using @ref overview_refcount.