X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/40989e46b86777dd211faeb3e5d2366cdcc6d8cd..3ab6fcee36cb08428581fbff5f5de81699c3e342:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 9aa8957686..4ba28808cd 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -64,7 +64,7 @@ Constructs a colour from red, green and blue 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}} @@ -109,15 +109,16 @@ Returns the blue intensity. 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 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 +(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} @@ -154,25 +155,18 @@ Returns the red intensity. \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 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. +\newsince{2.7.0} + \membersection{wxColour::operator $=$}\label{wxcolourassign}