Fix "depreciated" to "deprecated".

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

diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex
index bf6c5e0994c1aaad15b8ebdda80de8d321f43513..fca6264a1e2afdfdfe4a6afdbe3029219b5e8198 100644 (file)
--- a/docs/latex/wx/palette.tex
+++ b/docs/latex/wx/palette.tex
@@ -1,7 +1,28 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% 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. 
+
+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}
 
 %TODO: topic overview for wxPalette.
 \wxheading{Derived from}


@@ -33,7 +54,7 @@ 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.
+Copy constructor, uses \helpref{reference counting}{trefcount}.

 
 \func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\
  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 
 \func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\
  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}


@@ -65,6 +86,7 @@ red, blue or green component.
 \func{}{\destruct{wxPalette}}{\void}
 
 Destructor.
 \func{}{\destruct{wxPalette}}{\void}
 
 Destructor.

+See \helpref{reference-counted object destruction}{refcountdestruct} for more info.

 
 \membersection{wxPalette::Create}\label{wxpalettecreate}
 
 
 \membersection{wxPalette::Create}\label{wxpalettecreate}
 


@@ -100,8 +122,8 @@ 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.
 


@@ -115,7 +137,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}
 


@@ -149,9 +171,9 @@ true if the operation was successful.
 \perlnote{In wxPerl this method takes only the {\tt pixel} parameter and
   returns a 3-element list ( or the empty list upon failure ).}
 
 \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}
+\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.
 


@@ -159,23 +181,5 @@ Returns true if palette data is present.
 
 \func{wxPalette\&}{operator $=$}{\param{const wxPalette\& }{palette}}
 
 
 \func{wxPalette\&}{operator $=$}{\param{const wxPalette\& }{palette}}
 

-Assignment operator, using reference counting. Returns a reference
-to `this'.
-
-\membersection{wxPalette::operator $==$}\label{wxpaletteequals}
-
-\func{bool}{operator $==$}{\param{const wxPalette\& }{palette}}
-
-Equality operator. Two palettes are equal if they contain pointers
-to the same underlying palette data. It does not compare each attribute,
-so two independently-created palettes using the same parameters will
-fail the test.
-
-\membersection{wxPalette::operator $!=$}\label{wxpalettenotequals}
-
-\func{bool}{operator $!=$}{\param{const wxPalette\& }{palette}}
-
-Inequality operator. Two palettes are not equal if they contain pointers
-to different underlying palette data. It does not compare each attribute.
-
+Assignment operator, using \helpref{reference counting}{trefcount}.