Spacing tweak

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 7921a0642d53f480fd4d32f7f235f68017932c5b..1f43a32678ff5771ceb135a7204d379e967a3340 100644 (file)
--- 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.
 
@@ -177,15 +188,16 @@ This class holds a variety of information related to colour dialogs.
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxColourData::wxColourData}\label{wxcolourdataconstr}
+\membersection{wxColourData::wxColourData}\label{wxcolourdatactor}
 
 \func{}{wxColourData}{\void}
 
-Constructor. Initializes the custom colours to white, the {\it data colour} setting
+Constructor. Initializes the custom colours to {\tt wxNullColour},
+the {\it data colour} setting
 to black, and the {\it choose full} setting to true.
 
 
-\membersection{wxColourData::\destruct{wxColourData}}
+\membersection{wxColourData::\destruct{wxColourData}}\label{wxcolourdatadtor}
 
 \func{}{\destruct{wxColourData}}{\void}
 
@@ -197,7 +209,9 @@ Destructor.
 \constfunc{bool}{GetChooseFull}{\void}
 
 Under Windows, determines whether the Windows colour dialog will display the full dialog
-with custom colour selection controls. Has no meaning under other platforms.
+with custom colour selection controls. Under PalmOS, determines whether colour dialog
+will display full rgb colour picker or only available palette indexer.
+Has no meaning under other platforms.
 
 The default value is true.
 
@@ -218,7 +232,7 @@ The default colour is black.
 Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should
 be an integer between 0 and 15.
 
-The default custom colours are all white.
+The default custom colours are invalid colours.
 
 
 \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull}
@@ -247,7 +261,7 @@ The default colour is black.
 Sets the {\it i}th custom colour for the colour dialog. {\it i} should
 be an integer between 0 and 15.
 
-The default custom colours are all white.
+The default custom colours are invalid colours.
 
 
 \membersection{wxColourData::operator $=$}\label{wxcolourdataassign}
@@ -261,14 +275,14 @@ Assignment operator for the colour data.
 
 \section{\class{wxColourDatabase}}\label{wxcolourdatabase}
 
-wxWindows maintains a database of standard RGB colours for a predefined
+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}
@@ -320,30 +334,18 @@ Adds a colour to the database. If a colour with the same name already exists,
 it is replaced.
 
 Please note that the overload taking a pointer is deprecated and will be
-removed in the next wxWindows version, please don't use it.
+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 \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
-wxWindows version, please use \helpref{Find}{wxcolourdatabasefind} instead of
-it.
-
-
 \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
 
 \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}