Whole bunch of minor doc updates from an external patch.

[wxWidgets.git] / docs / latex / wx / palette.tex

diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex
index ded5bc1d290a427a141e904046d4791d0cfea5cd..ab37cf331761ab2d325a52b0dceef69b9ba3ef39 100644 (file)
--- a/docs/latex/wx/palette.tex
+++ b/docs/latex/wx/palette.tex
@@ -3,20 +3,29 @@
 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}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPalette::wxPalette}\label{wxpaletteconstr}
+\membersection{wxPalette::wxPalette}\label{wxpalettector}
 
 \func{}{wxPalette}{\void}
 
@@ -48,7 +57,10 @@ red, blue or green component.
 
 \helpref{wxPalette::Create}{wxpalettecreate}
 
-\membersection{wxPalette::\destruct{wxPalette}}
+\perlnote{In wxPerl the third constructor form takes as parameters
+  3 array references ( they must be of the same length ).}
+
+\membersection{wxPalette::\destruct{wxPalette}}\label{wxpalettedtor}
 
 \func{}{\destruct{wxPalette}}{\void}
 
@@ -74,11 +86,17 @@ red, blue or green component.
 
 \wxheading{Return value}
 
-TRUE if the creation was successful, FALSE otherwise.
+true if the creation was successful, false otherwise.
 
 \wxheading{See also}
 
-\helpref{wxPalette::wxPalette}{wxpaletteconstr}
+\helpref{wxPalette::wxPalette}{wxpalettector}
+
+\membersection{wxPalette::GetColoursCount}\label{wxpalettegetcolourscount}
+
+\constfunc{int}{GetColoursCount}{\void}
+
+Returns number of entries in palette.
 
 \membersection{wxPalette::GetPixel}\label{wxpalettegetpixel}
 
@@ -122,17 +140,20 @@ Returns RGB values for a given palette index.
 
 \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}