X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..f973828cd9b31d3b80386fab5e6f7c4a106d97fc:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 8625f8e813..74526a993c 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -7,17 +7,40 @@ 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} +\wxheading{Include files} + + + +\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}}} + \membersection{wxColour::wxColour}\label{wxcolourconstr} \func{}{wxColour}{\void} @@ -33,6 +56,10 @@ Constructs a colour from red, green and blue values. Constructs a colour object using a colour name listed in {\bf wxTheColourDatabase}. +\func{}{wxColour}{\param{const wxColour\&}{ colour}} + +Copy constructor. + \wxheading{Parameters} \docparam{red}{The red value.} @@ -43,16 +70,28 @@ listed in {\bf wxTheColourDatabase}. \docparam{colourName}{The colour name.} +\docparam{colour}{The colour to copy.} + \wxheading{See also} \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} Returns the blue intensity. + \membersection{wxColour::GetPixel}\label{wxcolourgetpixel} \constfunc{long}{GetPixel}{\void} @@ -62,17 +101,20 @@ On X, an allocated pixel value is returned. -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::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} @@ -80,12 +122,14 @@ Returns TRUE if the colour object is valid (the colour has been initialised with 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::operator $=$}\label{wxcolourassign} \func{wxColour\&}{operator $=$}{\param{const wxColour\&}{ colour}} @@ -100,14 +144,13 @@ Assignment operator, using a colour name to be found in the colour database. \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. -TODO: this may be different on platforms other than Windows - no reference counting -is done on Windows. \membersection{wxColour::operator $!=$}\label{wxcolourinequality} @@ -115,9 +158,6 @@ is done on Windows. Tests the inequality of two colours by comparing individual red, green blue colours. -TODO: this may be different on platforms other than Windows - no reference counting -is done on Windows. - \section{\class{wxColourData}}\label{wxcolourdata} This class holds a variety of information related to colour dialogs. @@ -126,18 +166,24 @@ This class holds a variety of information related to colour dialogs. \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview} \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxColourData::wxColourData}\label{wxcolourdataconstr} \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}} @@ -145,6 +191,7 @@ to black, and the {\it choose full} setting to TRUE. Destructor. + \membersection{wxColourData::GetChooseFull}\label{wxcolourdatagetchoosefull} \constfunc{bool}{GetChooseFull}{\void} @@ -152,7 +199,8 @@ 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} @@ -162,15 +210,17 @@ Gets the current colour associated with the colour dialog. The default colour is black. + \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour} -\constfunc{wxColour\&}{GetCustomColour}{\param{const int}{ i}} +\constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}} Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should be an integer between 0 and 15. The default custom colours are all white. + \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull} \func{void}{SetChooseFull}{\param{const bool }{flag}} @@ -178,7 +228,8 @@ 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} @@ -188,36 +239,49 @@ Sets the default colour for the colour dialog. The default colour is black. + \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour} -\func{void}{SetColour}{\param{const 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. The default custom colours are all white. + \membersection{wxColourData::operator $=$}\label{wxcolourdataassign} \func{void}{operator $=$}{\param{const wxColourData\&}{ data}} -Assingment operator for the colour 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 -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} -\helpref{wxList}{wxlist}\\ -\helpref{wxObject}{wxobject} +None + +\wxheading{Include files} + + \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 @@ -238,29 +302,53 @@ YELLOW GREEN. \latexignore{\rtfignore{\wxheading{Members}}} + \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} + +\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. + +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}} -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.