X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/adaaa68635b4c8a4d8c5284add40366ea3eefb07..d3fa4bc22e84e3ca4d88cc1772f2d414140a1017:/interface/wx/palette.h?ds=sidebyside diff --git a/interface/wx/palette.h b/interface/wx/palette.h index 2bcf2b0ccc..8dde732ed7 100644 --- a/interface/wx/palette.h +++ b/interface/wx/palette.h @@ -3,7 +3,7 @@ // Purpose: interface of wxPalette // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -41,6 +41,9 @@ public: /** Copy constructor, uses @ref overview_refcount. + + @param palette + A reference to the palette to copy. */ wxPalette(const wxPalette& palette); @@ -48,8 +51,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 +60,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 +135,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.