]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/colour.tex
Added wxDataViewTreeCtrl
[wxWidgets.git] / docs / latex / wx / colour.tex
index 16d19ef3a606f092ea85d42412d23e078e44b841..0109378a5bf766ed36b5ed4301a2c9f1a4486d0c 100644 (file)
@@ -28,6 +28,10 @@ You can retrieve the current system colour settings with \helpref{wxSystemSettin
 
 <wx/colour.h>
 
 
 <wx/colour.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Predefined objects}
 
 Objects:
 \wxheading{Predefined objects}
 
 Objects:
@@ -115,20 +119,24 @@ Returns the blue intensity.
 
 \constfunc{wxString}{GetAsString}{\param{long}{ flags}}
 
 
 \constfunc{wxString}{GetAsString}{\param{long}{ flags}}
 
-Converts this colour to a \helpref{wxString}{wxstring}
+Converts this colour to a \helpref{wxString}{wxstring} 
 using the given {\it flags}.
 
 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"}).
+The supported flags are \textbf{wxC2S\_NAME}, to obtain the colour name (e.g.
+wxColour(255,0,0) -> \texttt{``red"}), \textbf{wxC2S\_CSS\_SYNTAX}, to obtain
+the colour in the \texttt{``rgb(r,g,b)"} or \texttt{``rgba(r,g,b,a)"} syntax
+(e.g. wxColour(255,0,0,85) -> \texttt{``rgba(255,0,0,0.333)"}), and 
+\textbf{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.
+This function never fails and always returns a non-empty string but asserts if
+the colour has alpha channel (i.e. is non opaque) but
+\textbf{wxC2S\_CSS\_SYNTAX} (which is the only one supporting alpha) is not
+specified in flags.
 
 \newsince{2.7.0}
 
 
 \newsince{2.7.0}
 
+
 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}
 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
 
 \constfunc{long}{GetPixel}{\void}
@@ -170,7 +178,11 @@ Returns the red intensity.
 
 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 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).
+When using third form, Set() accepts: colour names (those listed in 
+\helpref{wxTheColourDatabase}{wxcolourdatabase}), the CSS-like 
+\texttt{``rgb(r,g,b)"} or \texttt{``rgba(r,g,b,a)"} 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.
 
 
 Returns \true if the conversion was successful, \false otherwise.
 
@@ -217,6 +229,10 @@ This class holds a variety of information related to colour dialogs.
 
 <wx/cmndata.h>
 
 
 <wx/cmndata.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
 \wxheading{See also}
 
 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
@@ -329,6 +345,10 @@ None
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Remarks}
 
 The standard database contains at least the following colours:
 \wxheading{Remarks}
 
 The standard database contains at least the following colours: