X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/edc536d358374987326d93adb1012b6eda9435a0..6500a868fe571da49a36487a1942b12e5393ab4a:/docs/latex/wx/colour.tex

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 1f43a32678..341d51e153 100644
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -2,7 +2,7 @@
 %% Name:        colour.tex
 %% Purpose:     wxColour docs
 %% Author:
-%% Modified by:
+%% Modified by: Francesco Montorsi
 %% Created:
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWidgets
@@ -58,14 +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 object using a colour name
-listed in {\bf wxTheColourDatabase}.
+Constructs a colour using the given string. See \helpref{Set}{wxcolourset} for more info.
 
 \func{}{wxColour}{\param{const wxColour\&}{ colour}}
 
@@ -79,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.}
@@ -96,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}
@@ -103,6 +111,24 @@ Copy constructor.
 Returns the blue intensity.
 
 
+\membersection{wxColour::GetAsString}\label{wxcolourgetasstring}
+
+\constfunc{wxString}{GetAsString}{\param{long}{ flags}}
+
+Converts this colour to a \helpref{wxString}{wxstring}
+using the given {\it flags}.
+
+The supported flags are {\bf wxC2S\_NAME}, to obtain the colour
+name (e.g. wxColour(255,0,0) -> \texttt{``red"}), {\bf wxC2S\_CSS\_SYNTAX}, to obtain
+the colour in the \texttt{``rgb(r,g,b)"} syntax
+(e.g. wxColour(255,0,0) -> \texttt{``rgb(255,0,0)"}), and {\bf wxC2S\_HTML\_SYNTAX}, to obtain
+the colour as  \texttt{``\#"} followed by 6 hexadecimal digits
+(e.g. wxColour(255,0,0) -> \texttt{``\#FF0000"}).
+
+This function never fails and always returns a non-empty string.
+
+\newsince{2.7.0}
+
 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}
@@ -120,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).
 
@@ -136,9 +162,19 @@ Returns the red intensity.
 
 \membersection{wxColour::Set}\label{wxcolourset}
 
-\func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}
+\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}}
+
+\func{bool}{Set}{\param{const wxString \&}{ str}}
+
+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).
 
-Sets the RGB intensity values.
+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.
+
+\newsince{2.7.0}
 
 
 \membersection{wxColour::operator $=$}\label{wxcolourassign}
@@ -160,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}
 
@@ -342,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.
 
 
@@ -352,5 +388,3 @@ found in the database.
 
 Finds a colour name given the colour. Returns an empty string if the colour is
 not found in the database.
-
-
