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 colours in a display.
-TODO: topic overview for wxPalette.
-
+%TODO: topic overview for wxPalette.
\wxheading{Derived from}
\helpref{wxGDIObject}{wxgdiobject}\\
\helpref{wxObject}{wxobject}
+\wxheading{Include files}
+
+<wx/palette.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullPalette}
+
\wxheading{See also}
\helpref{wxDC::SetPalette}{wxdcsetpalette}, \helpref{wxBitmap}{wxbitmap}
Copy constructor. This uses reference counting so is a cheap operation.
-\func{}{wxPalette}{\param{const wxPalette*}{ palette}}
-
-Copy constructor. This uses reference counting so is a cheap operation.
-
\func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\
\param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
\helpref{wxPalette::Create}{wxpalettecreate}
+\perlnote{In wxPerl the third constructor form takes as parameters
+ 3 array references ( they must be of the same length ).}
+
\membersection{wxPalette::\destruct{wxPalette}}
\func{}{\destruct{wxPalette}}{\void}
\wxheading{Return value}
-TRUE if the creation was successful, FALSE otherwise.
+true if the creation was successful, false otherwise.
\wxheading{See also}
\wxheading{Return value}
-TRUE if the operation was successful.
+true if the operation was successful.
\wxheading{See also}
\helpref{wxPalette::GetPixel}{wxpalettegetpixel}
+\perlnote{In wxPerl this method takes only the {\tt pixel} parameter and
+ returns a 3-element list ( or the empty list upon failure ).}
+
\membersection{wxPalette::Ok}\label{wxpaletteok}
\constfunc{bool}{Ok}{\void}
-Returns TRUE if palette data is present.
+Returns true if palette data is present.
\membersection{wxPalette::operator $=$}\label{wxpaletteassignment}