mention that ChangeValue() is for wx 2.7.1+; don't use abbreviations like 'info'...

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

diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex
index 5bee9c9b6afab4f63cf3bbf4f59e7f875259f5c2..3524bf599ffd0e4539bdbcd89d4e1fe3456cbe7d 100644 (file)
--- a/docs/latex/wx/palette.tex
+++ b/docs/latex/wx/palette.tex
@@ -1,22 +1,52 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        palette.tex
+%% Purpose:     wxPalette docs
+%% Author:
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxPalette}}\label{wxpalette}
 
 \section{\class{wxPalette}}\label{wxpalette}
 

-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.
+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. The notion of palettes is becoming more and more
+obsolete nowadays and only the MSW port is still using a native palette.
+All other ports use generic code which is basically just an array of
+colours. 

 
 

-TODO: topic overview for wxPalette.
+It is likely that in the future the only use for palettes within wxWidgets
+will be for representing colour indeces from images (such as GIF or PNG).
+The image handlers for these formats have been modified to create a palette
+if there is such information in the original image file (usually 256 or less
+colour images). See \helpref{wxImage}{wximage} for more information.

 
 

+%TODO: topic overview for wxPalette.

 \wxheading{Derived from}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
 \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}}}
 
 \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}
 
 
 \func{}{wxPalette}{\void}
 


@@ -24,13 +54,9 @@ Default constructor.
 
 \func{}{wxPalette}{\param{const wxPalette\&}{ palette}}
 
 
 \func{}{wxPalette}{\param{const wxPalette\&}{ palette}}
 

-Copy constructor. This uses reference counting so is a cheap operation.
-
-\func{}{wxPalette}{\param{const wxPalette*}{ palette}}
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 

-Copy constructor. This uses reference counting so is a cheap operation.
-
-\func{}{wxPalette}{\param{const int}{ n}, \param{const unsigned char* }{red},\\
+\func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\

  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 
 Creates a palette from arrays of size {\it n}, one for each
  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 
 Creates a palette from arrays of size {\it n}, one for each


@@ -52,7 +78,10 @@ red, blue or green component.
 
 \helpref{wxPalette::Create}{wxpalettecreate}
 
 
 \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}
 
 
 \func{}{\destruct{wxPalette}}{\void}
 


@@ -60,7 +89,7 @@ Destructor.
 
 \membersection{wxPalette::Create}\label{wxpalettecreate}
 
 
 \membersection{wxPalette::Create}\label{wxpalettecreate}
 

-\func{bool}{Create}{\param{const int}{ n}, \param{const unsigned char* }{red},\rtfsp
+\func{bool}{Create}{\param{int}{ n}, \param{const unsigned char* }{red},\rtfsp

  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 
 Creates a palette from arrays of size {\it n}, one for each
  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 
 Creates a palette from arrays of size {\it n}, one for each


@@ -78,16 +107,22 @@ red, blue or green component.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the creation was successful, FALSE otherwise.
+true if the creation was successful, false otherwise.

 
 \wxheading{See also}
 
 
 \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}
 
 
 \membersection{wxPalette::GetPixel}\label{wxpalettegetpixel}
 

-\constfunc{int}{GetPixel}{\param{const unsigned char }{red}, \param{const unsigned char }{green},\rtfsp
- \param{const unsigned char }{blue}}
+\constfunc{int}{GetPixel}{\param{unsigned char }{red}, \param{unsigned char }{green},\rtfsp
+ \param{unsigned char }{blue}}

 
 Returns a pixel value (index into the palette) for the given RGB values.
 
 
 Returns a pixel value (index into the palette) for the given RGB values.
 


@@ -101,7 +136,7 @@ Returns a pixel value (index into the palette) for the given RGB values.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-The nearest palette index.
+The nearest palette index or {\tt wxNOT\_FOUND} for unexpected errors.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -109,7 +144,7 @@ The nearest palette index.
 
 \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
 
 
 \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
 

-\constfunc{bool}{GetPixel}{\param{const int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp
+\constfunc{bool}{GetRGB}{\param{int}{ pixel}, \param{const unsigned char* }{red}, \param{const unsigned char* }{green},\rtfsp

  \param{const unsigned char* }{blue}}
 
 Returns RGB values for a given palette index.
  \param{const unsigned char* }{blue}}
 
 Returns RGB values for a given palette index.


@@ -126,24 +161,26 @@ Returns RGB values for a given palette index.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the operation was successful.
+true if the operation was successful.

 
 \wxheading{See also}
 
 \helpref{wxPalette::GetPixel}{wxpalettegetpixel}
 
 
 \wxheading{See also}
 
 \helpref{wxPalette::GetPixel}{wxpalettegetpixel}
 

-\membersection{wxPalette::Ok}\label{wxpaletteok}
+\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::IsOk}\label{wxpaletteisok}

 
 

-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}

 
 

-Returns TRUE if palette data is present.
+Returns true if palette data is present.

 
 \membersection{wxPalette::operator $=$}\label{wxpaletteassignment}
 
 \func{wxPalette\&}{operator $=$}{\param{const wxPalette\& }{palette}}
 
 
 \membersection{wxPalette::operator $=$}\label{wxpaletteassignment}
 
 \func{wxPalette\&}{operator $=$}{\param{const wxPalette\& }{palette}}
 

-Assignment operator, using reference counting. Returns a reference
-to `this'.
+Assignment operator, using \helpref{reference counting}{trefcount}.

 
 \membersection{wxPalette::operator $==$}\label{wxpaletteequals}
 
 
 \membersection{wxPalette::operator $==$}\label{wxpaletteequals}
 


@@ -161,4 +198,3 @@ fail the test.
 Inequality operator. Two palettes are not equal if they contain pointers
 to different underlying palette data. It does not compare each attribute.
 
 Inequality operator. Two palettes are not equal if they contain pointers
 to different underlying palette data. It does not compare each attribute.
 

-