X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f5d9cc735c3222fcbea9cb5a55a3de61fa12e146..65afac3fbc6115b899045d767af823fc3abd7322:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index f77b1010e8..1f43a32678 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: colour.tex +%% Purpose: wxColour docs +%% Author: +%% Modified by: +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxColour}}\label{wxcolour} A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values, @@ -47,7 +58,7 @@ wxLIGHT\_GREY} Default constructor. -\func{}{wxColour}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}} +\func{}{wxColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}} Constructs a colour from red, green and blue values. @@ -125,7 +136,7 @@ Returns the red intensity. \membersection{wxColour::Set}\label{wxcolourset} -\func{void}{Set}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}} +\func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}} Sets the RGB intensity values. @@ -266,12 +277,12 @@ Assignment operator for the colour data. wxWidgets maintains a database of standard RGB colours for a predefined set of named colours (such as ``BLACK'', ``LIGHT GREY''). The -application may add to this set if desired by using +application may add to this set if desired by using \helpref{AddColour}{wxcolourdatabaseaddcolour} and may use it to look up colours by names using \helpref{Find}{wxcolourdatabasefind} or find the names for the standard colour suing \helpref{FindName}{wxcolourdatabasefindname}. -There is one predefined instance of this class called +There is one predefined instance of this class called {\bf wxTheColourDatabase}. \wxheading{Derived from} @@ -328,25 +339,13 @@ removed in the next wxWidgets version, please don't use it. \membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind} -\func{wxColour}{FindColour}{\param{const wxString\& }{colourName}} +\func{wxColour}{Find}{\param{const wxString\& }{colourName}} Finds a colour given the name. Returns an invalid colour object (that is, such that its \helpref{Ok()}{wxcolourok} method returns \false) if the colour wasn't found in the database. -\membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour} - -\func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}} - -Finds a colour given the name. Returns {\tt NULL} if not found or a pointer which -must be deleted by the caller otherwise. - -Please note that this method is deprecated and will be removed in the next -wxWidgets version, please use \helpref{Find}{wxcolourdatabasefind} instead of -it. - - \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname} \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}