X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..5c5428f9132822d5d39b02c46dd89464adff9f1f:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 8896abf0ab..c5fee6e53e 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -7,6 +7,8 @@ named colour may be returned instead of creating a new colour. Valid RGB values are in the range 0 to 255. +You can retrieve the current system colour settings with \helpref{wxSystemSettings}{wxsystemsettings}. + \wxheading{Derived from} \helpref{wxObject}{wxobject} @@ -15,10 +17,26 @@ Valid RGB values are in the range 0 to 255. +\wxheading{Predefined objects} + +Objects: + +{\bf wxNullColour} + +Pointers: + +{\bf wxBLACK\\ +wxWHITE\\ +wxRED\\ +wxBLUE\\ +wxGREEN\\ +wxCYAN\\ +wxLIGHT\_GREY} + \wxheading{See also} \helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp -\helpref{wxColourDialog}{wxcolourdialog} +\helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxSystemSettings}{wxsystemsettings} \latexignore{\rtfignore{\wxheading{Members}}} @@ -57,6 +75,14 @@ Copy constructor. \helpref{wxColourDatabase}{wxcolourdatabase} +\pythonnote{Constructors supported by wxPython are:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf wxColour(red=0, green=0, blue=0)}}{} +\twocolitem{{\bf wxNamedColour(name)}}{} +\end{twocollist}} +} + + \membersection{wxColour::Blue}\label{wxcolourblue} \constfunc{unsigned char}{Blue}{\void} @@ -82,7 +108,7 @@ Returns the green intensity. \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} @@ -145,7 +171,7 @@ This class holds a variety of information related to colour dialogs. \func{}{wxColourData}{\void} Constructor. Initializes the custom colours to white, the {\it data colour} setting -to black, and the {\it choose full} setting to TRUE. +to black, and the {\it choose full} setting to true. \membersection{wxColourData::\destruct{wxColourData}} @@ -160,7 +186,7 @@ Destructor. Under Windows, determines whether the Windows colour dialog will display the full dialog 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} @@ -186,7 +212,7 @@ The default custom colours are all white. Under Windows, tells the Windows colour dialog to display the full dialog 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} @@ -198,7 +224,7 @@ The default colour is black. \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour} -\func{void}{SetColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}} +\func{void}{SetCustomColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}} Sets the {\it i}th custom colour for the colour dialog. {\it i} should be an integer between 0 and 15. @@ -209,7 +235,7 @@ The default custom colours are all white. \func{void}{operator $=$}{\param{const wxColourData\&}{ data}} -Assingment operator for the colour data. +Assignment operator for the colour data. \section{\class{wxColourDatabase}}\label{wxcolourdatabase}