Changed version to 2.5.1

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 8625f8e8134807affe9542da6123ef402ac01f73..40437b1cf53de16b37118c1771d0c8fb65310508 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -7,14 +7,36 @@ named colour may be returned instead of creating a new colour.
 
 Valid RGB values are in the range 0 to 255.
 
+You can retrieve the current system colour settings with \helpref{wxSystemSettings}{wxsystemsettings}.
+
 \wxheading{Derived from}
 
 \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
-\helpref{wxColourDialog}{wxcolourdialog}
+\helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxSystemSettings}{wxsystemsettings}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -33,6 +55,10 @@ Constructs a colour from red, green and blue values.
 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.}
@@ -43,10 +69,20 @@ listed in {\bf wxTheColourDatabase}.
 
 \docparam{colourName}{The colour name.}
 
+\docparam{colour}{The colour to copy.}
+
 \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}
@@ -72,7 +108,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}
 
@@ -106,18 +142,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.
@@ -126,6 +156,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}
@@ -137,7 +171,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}}
 
@@ -152,7 +186,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}
 
@@ -164,7 +198,7 @@ The default colour is black.
 
 \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.
@@ -178,7 +212,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}
 
@@ -190,7 +224,7 @@ The default colour is black.
 
 \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.
@@ -201,7 +235,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}
 
@@ -212,8 +246,11 @@ is only one instance of this class: {\bf wxTheColourDatabase}.
 
 \wxheading{Derived from}
 
-\helpref{wxList}{wxlist}\\
-\helpref{wxObject}{wxobject}
+None
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
 
 \wxheading{Remarks}
 
@@ -244,6 +281,13 @@ YELLOW GREEN.
 
 Constructs the colour database.
 
+\membersection{wxColourDatabase::AddColour}\label{wxcolourdatabaseaddcolour}
+
+\func{void}{AddColour}{\param{const wxString\& }{colourName}, \param{wxColour* }{colour}}
+
+Adds a colour to the database. If a colour with the same name already exists,
+it is replaced.
+
 \membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
 
 \func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}