added FindFileInPath() (part of an otherwise rejected patch)

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

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

 \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.
 
 \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.
 

-TODO: topic overview for wxPalette.
-
+%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}
 


@@ -26,10 +46,6 @@ Default constructor.
 
 Copy constructor. This uses reference counting so is a cheap operation.
 
 
 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}}
 
 \func{}{wxPalette}{\param{int}{ n}, \param{const unsigned char* }{red},\\
  \param{const unsigned char* }{green}, \param{const unsigned char* }{blue}}
 


@@ -52,7 +68,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}
 


@@ -78,16 +97,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 +126,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 +134,7 @@ The nearest palette index.
 
 \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
 
 
 \membersection{wxPalette::GetRGB}\label{wxpalettegetrgb}
 

-\constfunc{bool}{GetPixel}{\param{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,17 +151,20 @@ 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}
 

+\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}
 
 \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}
 
 
 \membersection{wxPalette::operator $=$}\label{wxpaletteassignment}
 


@@ -160,5 +188,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.

-
-