X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..65baafba0e8cd74f2264b7e2f7625ff5bea84864:/docs/latex/wx/palette.tex?ds=inline diff --git a/docs/latex/wx/palette.tex b/docs/latex/wx/palette.tex index f2192f5efe..f46329e085 100644 --- a/docs/latex/wx/palette.tex +++ b/docs/latex/wx/palette.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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 @@ -25,7 +36,7 @@ Objects: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxPalette::wxPalette}\label{wxpaletteconstr} +\membersection{wxPalette::wxPalette}\label{wxpalettector} \func{}{wxPalette}{\void} @@ -60,7 +71,7 @@ red, blue or green component. \perlnote{In wxPerl the third constructor form takes as parameters 3 array references ( they must be of the same length ).} -\membersection{wxPalette::\destruct{wxPalette}} +\membersection{wxPalette::\destruct{wxPalette}}\label{wxpalettedtor} \func{}{\destruct{wxPalette}}{\void} @@ -90,12 +101,18 @@ 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} -\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. @@ -109,7 +126,7 @@ Returns a pixel value (index into the palette) for the given RGB values. \wxheading{Return value} -The nearest palette index. +The nearest palette index or {\tt wxNOT\_FOUND} for unexpected errors. \wxheading{See also} @@ -117,7 +134,7 @@ The nearest palette index. \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. @@ -171,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. - -