fixed typo

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 48690ef40e8e07693a1b690c5f356b959a6a9224..6e52405916dd1c9f0bdde60ad50c3b8be31f64b7 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -11,6 +11,26 @@ Valid RGB values are in the range 0 to 255.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/colour.h>
+
+\wxheading{Predefined objects}
+
+Objects:
+
+{\bf wxNullColour}
+
+Pointers:
+
+{\bf wxBLACK\\
+wxWHITE\\
+wxRED\\
+wxBLUE\\
+wxGREEN\\
+wxCYAN\\
+wxLIGHT\_GREY}
+
 \wxheading{See also}
 
 \helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp
@@ -53,6 +73,14 @@ Copy constructor.
 
 \helpref{wxColourDatabase}{wxcolourdatabase}
 
+\pythonnote{Constructors supported by wxPython are:\par
+\indented{2cm}{\begin{twocollist}
+\twocolitem{{\bf wxColour(red=0, green=0, blue=0)}}{}
+\twocolitem{{\bf wxNamedColour(name)}}{}
+\end{twocollist}}
+}
+
+
 \membersection{wxColour::Blue}\label{wxcolourblue}
 
 \constfunc{unsigned char}{Blue}{\void}
@@ -78,7 +106,7 @@ Returns the green intensity.
 
 \constfunc{bool}{Ok}{\void}
 
-Returns TRUE if the colour object is valid (the colour has been initialised with RGB values).
+Returns true if the colour object is valid (the colour has been initialised with RGB values).
 
 \membersection{wxColour::Red}\label{wxcolourred}
 
@@ -112,18 +140,12 @@ Assignment operator, using a colour name to be found in the colour database.
 
 Tests the equality of two colours by comparing individual red, green blue colours.
 
-TODO: this may be different on platforms other than Windows - no reference counting
-is done on Windows.
-
 \membersection{wxColour::operator $!=$}\label{wxcolourinequality}
 
 \func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}}
 
 Tests the inequality of two colours by comparing individual red, green blue colours.
 
-TODO: this may be different on platforms other than Windows - no reference counting
-is done on Windows.
-
 \section{\class{wxColourData}}\label{wxcolourdata}
 
 This class holds a variety of information related to colour dialogs.
@@ -132,6 +154,10 @@ This class holds a variety of information related to colour dialogs.
 
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/cmndata.h>
+
 \wxheading{See also}
 
 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
@@ -143,7 +169,7 @@ This class holds a variety of information related to colour dialogs.
 \func{}{wxColourData}{\void}
 
 Constructor. Initializes the custom colours to white, the {\it data colour} setting
-to black, and the {\it choose full} setting to TRUE.
+to black, and the {\it choose full} setting to true.
 
 \membersection{wxColourData::\destruct{wxColourData}}
 
@@ -158,7 +184,7 @@ Destructor.
 Under Windows, determines whether the Windows colour dialog will display the full dialog
 with custom colour selection controls. Has no meaning under other platforms.
 
-The default value is TRUE.
+The default value is true.
 
 \membersection{wxColourData::GetColour}\label{wxcolourdatagetcolour}
 
@@ -184,7 +210,7 @@ The default custom colours are all white.
 Under Windows, tells the Windows colour dialog to display the full dialog
 with custom colour selection controls. Under other platforms, has no effect.
 
-The default value is TRUE.
+The default value is true.
 
 \membersection{wxColourData::SetColour}\label{wxcolourdatasetcolour}
 
@@ -196,7 +222,7 @@ The default colour is black.
 
 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 
-\func{void}{SetColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}
+\func{void}{SetCustomColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}
 
 Sets the {\it i}th custom colour for the colour dialog. {\it i} should
 be an integer between 0 and 15.
@@ -207,7 +233,7 @@ The default custom colours are all white.
 
 \func{void}{operator $=$}{\param{const wxColourData\&}{ data}}
 
-Assingment operator for the colour data.
+Assignment operator for the colour data.
 
 \section{\class{wxColourDatabase}}\label{wxcolourdatabase}
 
@@ -221,6 +247,10 @@ is only one instance of this class: {\bf wxTheColourDatabase}.
 \helpref{wxList}{wxlist}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \wxheading{Remarks}
 
 The colours in the standard database are as follows: