compilation fix after TRUE/FALSE change

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 8625f8e8134807affe9542da6123ef402ac01f73..b3e69e5ee7faa8d70e20088dac31e297c92b03d9 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}
 
 
 \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
 \wxheading{See also}
 
 \helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp


@@ -33,6 +53,10 @@ Constructs a colour from red, green and blue values.
 Constructs a colour object using a colour name
 listed in {\bf wxTheColourDatabase}.
 
 Constructs a colour object using a colour name
 listed in {\bf wxTheColourDatabase}.
 

+\func{}{wxColour}{\param{const wxColour\&}{ colour}}
+
+Copy constructor.
+

 \wxheading{Parameters}
 
 \docparam{red}{The red value.}
 \wxheading{Parameters}
 
 \docparam{red}{The red value.}


@@ -43,10 +67,20 @@ listed in {\bf wxTheColourDatabase}.
 
 \docparam{colourName}{The colour name.}
 
 
 \docparam{colourName}{The colour name.}
 

+\docparam{colour}{The colour to copy.}
+

 \wxheading{See also}
 
 \helpref{wxColourDatabase}{wxcolourdatabase}
 
 \wxheading{See also}
 
 \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}
 \membersection{wxColour::Blue}\label{wxcolourblue}
 
 \constfunc{unsigned char}{Blue}{\void}


@@ -106,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.
 
 
 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.
 
 \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.
 \section{\class{wxColourData}}\label{wxcolourdata}
 
 This class holds a variety of information related to colour dialogs.


@@ -126,6 +154,10 @@ This class holds a variety of information related to colour dialogs.
 
 \helpref{wxObject}{wxobject}
 
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/cmndata.h>
+

 \wxheading{See also}
 
 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
 \wxheading{See also}
 
 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}


@@ -164,7 +196,7 @@ The default colour is black.
 
 \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
 
 
 \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
 

-\constfunc{wxColour\&}{GetCustomColour}{\param{const int}{ i}}
+\constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}}

 
 Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should
 be an integer between 0 and 15.
 
 Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should
 be an integer between 0 and 15.


@@ -190,7 +222,7 @@ The default colour is black.
 
 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 
 
 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 

-\func{void}{SetColour}{\param{const 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.
 
 Sets the {\it i}th custom colour for the colour dialog. {\it i} should
 be an integer between 0 and 15.


@@ -215,6 +247,10 @@ is only one instance of this class: {\bf wxTheColourDatabase}.
 \helpref{wxList}{wxlist}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxList}{wxlist}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/gdicmn.h>
+

 \wxheading{Remarks}
 
 The colours in the standard database are as follows:
 \wxheading{Remarks}
 
 The colours in the standard database are as follows: