X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adaaa68635b4c8a4d8c5284add40366ea3eefb07..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/palette.h diff --git a/interface/wx/palette.h b/interface/wx/palette.h index 2bcf2b0ccc..76a13db7ad 100644 --- a/interface/wx/palette.h +++ b/interface/wx/palette.h @@ -2,8 +2,7 @@ // Name: palette.h // Purpose: interface of wxPalette // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -41,6 +40,9 @@ public: /** Copy constructor, uses @ref overview_refcount. + + @param palette + A reference to the palette to copy. */ wxPalette(const wxPalette& palette); @@ -48,8 +50,6 @@ public: 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 @@ -59,6 +59,11 @@ public: @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, @@ -129,16 +134,20 @@ public: @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.