Avoid missing ref

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 00174d23da42ae2a121096d7053603e36c42acc0..16d19ef3a606f092ea85d42412d23e078e44b841 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -58,13 +58,13 @@ wxLIGHT\_GREY}
 
 Default constructor.
 
-\func{}{wxColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}
+\func{}{wxColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}, \param{unsigned char}{ alpha=wxALPHA\_OPAQUE}}
 
-Constructs a colour from red, green and blue values.
+Constructs a colour from red, green, blue and alpha values.
 
 \func{}{wxColour}{\param{const wxString\& }{colourNname}}
 
-Constructs a colour using the given string. See \helpref{Set}{wxcolourset3} for more info.
+Constructs a colour using the given string. See \helpref{Set}{wxcolourset} for more info.
 
 \func{}{wxColour}{\param{const wxColour\&}{ colour}}
 
@@ -78,6 +78,8 @@ Copy constructor.
 
 \docparam{blue}{The blue value.}
 
+\docparam{alpha}{The alpha value. Alpha values range from 0 (wxALPHA\_TRANSPARENT) to 255 (wxALPHA\_OPAQUE).}
+
 \docparam{colourName}{The colour name.}
 
 \docparam{colour}{The colour to copy.}
@@ -95,6 +97,13 @@ Copy constructor.
 
 
 
+\membersection{wxColour::Alpha}\label{wxcolouralpha}
+
+\constfunc{unsigned char}{Alpha}{\void}
+
+Returns the alpha value, on platforms where alpha is not yet supported, this always returns wxALPHA\_OPAQUE.
+
+
 \membersection{wxColour::Blue}\label{wxcolourblue}
 
 \constfunc{unsigned char}{Blue}{\void}
@@ -137,9 +146,9 @@ On X, an allocated pixel value is returned.
 Returns the green intensity.
 
 
-\membersection{wxColour::Ok}\label{wxcolourok}
+\membersection{wxColour::IsOk}\label{wxcolourisok}
 
-\constfunc{bool}{Ok}{\void}
+\constfunc{bool}{IsOk}{\void}
 
 Returns \true if the colour object is valid (the colour has been initialised with RGB values).
 
@@ -153,24 +162,15 @@ Returns the red intensity.
 
 \membersection{wxColour::Set}\label{wxcolourset}
 
-\func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}
-
-Sets the RGB intensity values.
-
-
-\membersection{wxColour::Set}\label{wxcolourset2}
+\func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}, \param{unsigned char}{ alpha=wxALPHA\_OPAQUE}}
 
 \func{void}{Set}{\param{unsigned long}{ RGB}}
 
-Sets the RGB intensity values extracting them from the packed long.
-
-
-\membersection{wxColour::Set}\label{wxcolourset3}
-
 \func{bool}{Set}{\param{const wxString \&}{ str}}
 
-Sets the colour using the given string.
-Accepts colour names (those listed in \helpref{wxTheColourDatabase}{wxcolourdatabase}), the CSS-like \texttt{``RGB(r,g,b)"} syntax (case insensitive) and the HTML-like syntax (i.e. \texttt{``\#"} followed by 6 hexadecimal digits for red, green, blue components).
+Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overloard).
+
+When using third form, Set() accepts: colour names (those listed in \helpref{wxTheColourDatabase}{wxcolourdatabase}), the CSS-like \texttt{``RGB(r,g,b)"} syntax (case insensitive) and the HTML-like syntax (i.e. \texttt{``\#"} followed by 6 hexadecimal digits for red, green, blue components).
 
 Returns \true if the conversion was successful, \false otherwise.
 
@@ -196,14 +196,14 @@ Assignment operator, using a colour name to be found in the colour database.
 
 \func{bool}{operator $==$}{\param{const wxColour\&}{ colour}}
 
-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 and alpha values.
 
 
 \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.
+Tests the inequality of two colours by comparing individual red, green, blue colours and alpha values.
 
 \section{\class{wxColourData}}\label{wxcolourdata}
 
@@ -378,7 +378,7 @@ removed in the next wxWidgets version, please don't use it.
 \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
+that its \helpref{Ok()}{wxcolourisok} method returns \false) if the colour wasn't
 found in the database.
 
 
@@ -388,3 +388,4 @@ found in the database.
 
 Finds a colour name given the colour. Returns an empty string if the colour is
 not found in the database.
+