Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / palette.h

diff --git a/interface/wx/palette.h b/interface/wx/palette.h
index f1a9a4bdc09bb585db2e3411180636ff0767f3c1..76a13db7ad99fb060407b87f864427f57499fb9e 100644 (file)
--- a/interface/wx/palette.h
+++ b/interface/wx/palette.h
@@ -2,13 +2,11 @@
 // Name:        palette.h
 // Purpose:     interface of wxPalette
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @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
@@ -42,6 +40,9 @@ public:
 
     /**
         Copy constructor, uses @ref overview_refcount.
+
+        @param palette
+            A reference to the palette to copy.
     */
     wxPalette(const wxPalette& palette);
 
@@ -49,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
@@ -60,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,
@@ -71,7 +75,7 @@ public:
 
         @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
@@ -97,7 +101,7 @@ public:
     /**
         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.
@@ -130,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.