s/wxHyperLinkCtrl/wxHyperlinkCtrl/

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index f77b1010e80d6c48c38716bcc96855fbec22cbf3..00174d23da42ae2a121096d7053603e36c42acc0 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        colour.tex
+%% Purpose:     wxColour docs
+%% Author:
+%% Modified by: Francesco Montorsi
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxColour}}\label{wxcolour}
 
 A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values,
 \section{\class{wxColour}}\label{wxcolour}
 
 A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values,


@@ -47,14 +58,13 @@ wxLIGHT\_GREY}
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxColour}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
+\func{}{wxColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}

 
 Constructs a colour from red, green and blue values.
 
 \func{}{wxColour}{\param{const wxString\& }{colourNname}}
 
 
 Constructs a colour from red, green and blue 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}{wxcolourset3} for more info.

 
 \func{}{wxColour}{\param{const wxColour\&}{ colour}}
 
 
 \func{}{wxColour}{\param{const wxColour\&}{ colour}}
 


@@ -92,6 +102,24 @@ Copy constructor.
 Returns the blue intensity.
 
 
 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}
 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}


@@ -125,11 +153,30 @@ Returns the red intensity.
 
 \membersection{wxColour::Set}\label{wxcolourset}
 
 
 \membersection{wxColour::Set}\label{wxcolourset}
 

-\func{void}{Set}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
+\func{void}{Set}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}}

 
 Sets the RGB intensity values.
 
 
 
 Sets the RGB intensity values.
 
 

+\membersection{wxColour::Set}\label{wxcolourset2}
+
+\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).
+
+Returns \true if the conversion was successful, \false otherwise.
+
+\newsince{2.7.0}
+
+

 \membersection{wxColour::operator $=$}\label{wxcolourassign}
 
 \func{wxColour\&}{operator $=$}{\param{const wxColour\&}{ colour}}
 \membersection{wxColour::operator $=$}\label{wxcolourassign}
 
 \func{wxColour\&}{operator $=$}{\param{const wxColour\&}{ colour}}


@@ -266,12 +313,12 @@ Assignment operator for the colour data.
 
 wxWidgets maintains a database of standard RGB colours for a predefined
 set of named colours (such as ``BLACK'', ``LIGHT GREY''). The
 
 wxWidgets maintains a database of standard RGB colours for a predefined
 set of named colours (such as ``BLACK'', ``LIGHT GREY''). The

-application may add to this set if desired by using 
+application may add to this set if desired by using

 \helpref{AddColour}{wxcolourdatabaseaddcolour} and may use it to look up
 colours by names using \helpref{Find}{wxcolourdatabasefind} or find the names
 for the standard colour suing \helpref{FindName}{wxcolourdatabasefindname}.
 
 \helpref{AddColour}{wxcolourdatabaseaddcolour} and may use it to look up
 colours by names using \helpref{Find}{wxcolourdatabasefind} or find the names
 for the standard colour suing \helpref{FindName}{wxcolourdatabasefindname}.
 

-There is one predefined instance of this class called 
+There is one predefined instance of this class called

 {\bf wxTheColourDatabase}.
 
 \wxheading{Derived from}
 {\bf wxTheColourDatabase}.
 
 \wxheading{Derived from}


@@ -328,30 +375,16 @@ removed in the next wxWidgets version, please don't use it.
 
 \membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind}
 
 
 \membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind}
 

-\func{wxColour}{FindColour}{\param{const wxString\& }{colourName}}
+\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
 found in the database.
 
 
 
 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
 found in the database.
 
 

-\membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
-
-\func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}
-
-Finds a colour given the name. Returns {\tt NULL} if not found or a pointer which
-must be deleted by the caller otherwise.
-
-Please note that this method is deprecated and will be removed in the next
-wxWidgets version, please use \helpref{Find}{wxcolourdatabasefind} instead of
-it.
-
-

 \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
 
 \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}
 
 Finds a colour name given the colour. Returns an empty string if the colour is
 not found in the database.
 \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
 
 \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}
 
 Finds a colour name given the colour. Returns an empty string if the colour is
 not found in the database.

-
-