Updated note about wxWANTS_CHARS

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

diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex
index 40437b1cf53de16b37118c1771d0c8fb65310508..74526a993c0eec8f28f40cb2d0b418620e522d4e 100644 (file)
--- a/docs/latex/wx/colour.tex
+++ b/docs/latex/wx/colour.tex
@@ -40,6 +40,7 @@ wxLIGHT\_GREY}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxColour::wxColour}\label{wxcolourconstr}
 
 \func{}{wxColour}{\void}
 \membersection{wxColour::wxColour}\label{wxcolourconstr}
 
 \func{}{wxColour}{\void}


@@ -83,12 +84,14 @@ Copy constructor.
 }
 
 
 }
 
 

+

 \membersection{wxColour::Blue}\label{wxcolourblue}
 
 \constfunc{unsigned char}{Blue}{\void}
 
 Returns the blue intensity.
 
 \membersection{wxColour::Blue}\label{wxcolourblue}
 
 \constfunc{unsigned char}{Blue}{\void}
 
 Returns the blue intensity.
 

+

 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}
 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}


@@ -98,17 +101,20 @@ On X, an allocated pixel value is returned.
 
 -1 is returned if the pixel is invalid (on X, unallocated).
 
 
 -1 is returned if the pixel is invalid (on X, unallocated).
 

+

 \membersection{wxColour::Green}\label{wxcolourgreen}
 
 \constfunc{unsigned char}{Green}{\void}
 
 Returns the green intensity.
 
 \membersection{wxColour::Green}\label{wxcolourgreen}
 
 \constfunc{unsigned char}{Green}{\void}
 
 Returns the green intensity.
 

+

 \membersection{wxColour::Ok}\label{wxcolourok}
 
 \constfunc{bool}{Ok}{\void}
 
 \membersection{wxColour::Ok}\label{wxcolourok}
 
 \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}
 
 
 \membersection{wxColour::Red}\label{wxcolourred}
 


@@ -116,12 +122,14 @@ Returns true if the colour object is valid (the colour has been initialised with
 
 Returns the red intensity.
 
 
 Returns the red intensity.
 

+

 \membersection{wxColour::Set}\label{wxcolourset}
 
 \func{void}{Set}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
 
 Sets the RGB intensity values.
 
 \membersection{wxColour::Set}\label{wxcolourset}
 
 \func{void}{Set}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
 
 Sets the RGB intensity values.
 

+

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


@@ -136,12 +144,14 @@ Assignment operator, using a colour name to be found in the colour database.
 
 \helpref{wxColourDatabase}{wxcolourdatabase}
 
 
 \helpref{wxColourDatabase}{wxcolourdatabase}
 

+

 \membersection{wxColour::operator $==$}\label{wxcolourequality}
 
 \func{bool}{operator $==$}{\param{const wxColour\&}{ colour}}
 
 Tests the equality of two colours by comparing individual red, green blue colours.
 
 \membersection{wxColour::operator $==$}\label{wxcolourequality}
 
 \func{bool}{operator $==$}{\param{const wxColour\&}{ colour}}
 
 Tests the equality of two colours by comparing individual red, green blue colours.
 

+

 \membersection{wxColour::operator $!=$}\label{wxcolourinequality}
 
 \func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}}
 \membersection{wxColour::operator $!=$}\label{wxcolourinequality}
 
 \func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}}


@@ -166,6 +176,7 @@ This class holds a variety of information related to colour dialogs.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxColourData::wxColourData}\label{wxcolourdataconstr}
 
 \func{}{wxColourData}{\void}
 \membersection{wxColourData::wxColourData}\label{wxcolourdataconstr}
 
 \func{}{wxColourData}{\void}


@@ -173,12 +184,14 @@ This class holds a variety of information related to colour dialogs.
 Constructor. Initializes the custom colours to white, the {\it data colour} setting
 to black, and the {\it choose full} setting to true.
 
 Constructor. Initializes the custom colours to white, the {\it data colour} setting
 to black, and the {\it choose full} setting to true.
 

+

 \membersection{wxColourData::\destruct{wxColourData}}
 
 \func{}{\destruct{wxColourData}}{\void}
 
 Destructor.
 
 \membersection{wxColourData::\destruct{wxColourData}}
 
 \func{}{\destruct{wxColourData}}{\void}
 
 Destructor.
 

+

 \membersection{wxColourData::GetChooseFull}\label{wxcolourdatagetchoosefull}
 
 \constfunc{bool}{GetChooseFull}{\void}
 \membersection{wxColourData::GetChooseFull}\label{wxcolourdatagetchoosefull}
 
 \constfunc{bool}{GetChooseFull}{\void}


@@ -188,6 +201,7 @@ 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}
 
 \constfunc{wxColour\&}{GetColour}{\void}
 \membersection{wxColourData::GetColour}\label{wxcolourdatagetcolour}
 
 \constfunc{wxColour\&}{GetColour}{\void}


@@ -196,6 +210,7 @@ Gets the current colour associated with the colour dialog.
 
 The default colour is black.
 
 
 The default colour is black.
 

+

 \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
 
 \constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}}
 \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
 
 \constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}}


@@ -205,6 +220,7 @@ be an integer between 0 and 15.
 
 The default custom colours are all white.
 
 
 The default custom colours are all white.
 

+

 \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull}
 
 \func{void}{SetChooseFull}{\param{const bool }{flag}}
 \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull}
 
 \func{void}{SetChooseFull}{\param{const bool }{flag}}


@@ -214,6 +230,7 @@ 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}
 
 \func{void}{SetColour}{\param{const wxColour\&}{ colour}}
 \membersection{wxColourData::SetColour}\label{wxcolourdatasetcolour}
 
 \func{void}{SetColour}{\param{const wxColour\&}{ colour}}


@@ -222,6 +239,7 @@ Sets the default colour for the colour dialog.
 
 The default colour is black.
 
 
 The default colour is black.
 

+

 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 
 \func{void}{SetCustomColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}
 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 
 \func{void}{SetCustomColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}


@@ -231,18 +249,27 @@ be an integer between 0 and 15.
 
 The default custom colours are all white.
 
 
 The default custom colours are all white.
 

+

 \membersection{wxColourData::operator $=$}\label{wxcolourdataassign}
 
 \func{void}{operator $=$}{\param{const wxColourData\&}{ data}}
 
 Assignment operator for the colour data.
 
 \membersection{wxColourData::operator $=$}\label{wxcolourdataassign}
 
 \func{void}{operator $=$}{\param{const wxColourData\&}{ data}}
 
 Assignment operator for the colour data.
 

+
+
+

 \section{\class{wxColourDatabase}}\label{wxcolourdatabase}
 
 wxWindows maintains a database of standard RGB colours for a predefined
 set of named colours (such as ``BLACK'', ``LIGHT GREY''). The
 \section{\class{wxColourDatabase}}\label{wxcolourdatabase}
 
 wxWindows 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 {\it Append}.  There
-is only one instance of this class: {\bf wxTheColourDatabase}.
+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}.
+
+There is one predefined instance of this class called 
+{\bf wxTheColourDatabase}.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -254,7 +281,7 @@ None
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-The colours in the standard database are as follows:
+The standard database contains at least the following colours:

 
 AQUAMARINE, BLACK, BLUE, BLUE VIOLET, BROWN, CADET BLUE, CORAL,
 CORNFLOWER BLUE, CYAN, DARK GREY, DARK GREEN, DARK OLIVE GREEN, DARK
 
 AQUAMARINE, BLACK, BLUE, BLUE VIOLET, BROWN, CADET BLUE, CORAL,
 CORNFLOWER BLUE, CYAN, DARK GREY, DARK GREEN, DARK OLIVE GREEN, DARK


@@ -275,36 +302,53 @@ YELLOW GREEN.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxColourDatabase::wxColourDatabase}\label{wxcolourdatabaseconstr}
 
 \func{}{wxColourDatabase}{\void}
 
 \membersection{wxColourDatabase::wxColourDatabase}\label{wxcolourdatabaseconstr}
 
 \func{}{wxColourDatabase}{\void}
 

-Constructs the colour database.
+Constructs the colour database. It will be initialized at the first use.
+

 
 \membersection{wxColourDatabase::AddColour}\label{wxcolourdatabaseaddcolour}
 
 
 \membersection{wxColourDatabase::AddColour}\label{wxcolourdatabaseaddcolour}
 

+\func{void}{AddColour}{\param{const wxString\& }{colourName}, \param{const wxColour\&}{colour}}
+

 \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.
 
 \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.
 

+Please note that the overload taking a pointer is deprecated and will be
+removed in the next wxWindows version, please don't use it.
+
+
+\membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind}
+
+\func{wxColour}{FindColour}{\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.
+
+

 \membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
 
 \func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}
 
 \membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
 
 \func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}
 

-Finds a colour given the name. Returns NULL if not found.
+Finds a colour given the name. Returns \tt{NULL} if not found or a pointer which
+must be deleted by the caller otherwise.

 
 

-\membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
+Please note that this method is deprecated and will be removed in the next
+wxWindows version, please use \helpref{Find}{wxcolourdatabasefind} instead of
+it.

 
 

-\constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}
-
-Finds a colour name given the colour. Returns NULL if not found.

 
 

-\membersection{wxColourDatabase::Initialize}\label{wxcolourdatabaseinitialize}
+\membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}

 
 

-\func{void}{Initialize}{\void}
+\constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}

 
 

-Initializes the database with a number of stock colours.  Called by wxWindows
-on start-up.
+Finds a colour name given the colour. Returns an empty string if the colour is
+not found in the database.