X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0fee8cc4fa859c0abd523e9d24dadacf7b141025..db67d86dd1de506a5bb14dd59e9c45230120758a:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 74526a993c..00174d23da 100644 --- a/docs/latex/wx/colour.tex +++ b/docs/latex/wx/colour.tex @@ -1,3 +1,14 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: colour.tex +%% Purpose: wxColour docs +%% Author: +%% Modified by: Francesco Montorsi +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxWidgets +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxColour}}\label{wxcolour} A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values, @@ -47,14 +58,13 @@ wxLIGHT\_GREY} Default constructor. -\func{}{wxColour}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}} +\func{}{wxColour}{\param{unsigned char}{ red}, \param{unsigned char}{ green}, \param{unsigned char}{ blue}} Constructs a colour from red, green and blue values. \func{}{wxColour}{\param{const wxString\& }{colourNname}} -Constructs a colour object using a colour name -listed in {\bf wxTheColourDatabase}. +Constructs a colour using the given string. See \helpref{Set}{wxcolourset3} for more info. \func{}{wxColour}{\param{const wxColour\&}{ colour}} @@ -92,6 +102,24 @@ Copy constructor. Returns the blue intensity. +\membersection{wxColour::GetAsString}\label{wxcolourgetasstring} + +\constfunc{wxString}{GetAsString}{\param{long}{ flags}} + +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 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"}). + +This function never fails and always returns a non-empty string. + +\newsince{2.7.0} + \membersection{wxColour::GetPixel}\label{wxcolourgetpixel} \constfunc{long}{GetPixel}{\void} @@ -125,11 +153,30 @@ 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}} +\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). + +Returns \true if the conversion was successful, \false otherwise. + +\newsince{2.7.0} + + \membersection{wxColour::operator $=$}\label{wxcolourassign} \func{wxColour\&}{operator $=$}{\param{const wxColour\&}{ colour}} @@ -177,15 +224,16 @@ This class holds a variety of information related to colour dialogs. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxColourData::wxColourData}\label{wxcolourdataconstr} +\membersection{wxColourData::wxColourData}\label{wxcolourdatactor} \func{}{wxColourData}{\void} -Constructor. Initializes the custom colours to white, the {\it data colour} setting +Constructor. Initializes the custom colours to {\tt wxNullColour}, +the {\it data colour} setting to black, and the {\it choose full} setting to true. -\membersection{wxColourData::\destruct{wxColourData}} +\membersection{wxColourData::\destruct{wxColourData}}\label{wxcolourdatadtor} \func{}{\destruct{wxColourData}}{\void} @@ -197,7 +245,9 @@ Destructor. \constfunc{bool}{GetChooseFull}{\void} Under Windows, determines whether the Windows colour dialog will display the full dialog -with custom colour selection controls. Has no meaning under other platforms. +with custom colour selection controls. Under PalmOS, determines whether colour dialog +will display full rgb colour picker or only available palette indexer. +Has no meaning under other platforms. The default value is true. @@ -218,7 +268,7 @@ The default colour is black. 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. +The default custom colours are invalid colours. \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull} @@ -247,7 +297,7 @@ The default colour is black. 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. +The default custom colours are invalid colours. \membersection{wxColourData::operator $=$}\label{wxcolourdataassign} @@ -261,14 +311,14 @@ Assignment operator for the colour data. \section{\class{wxColourDatabase}}\label{wxcolourdatabase} -wxWindows maintains a database of standard RGB colours for a predefined +wxWidgets 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 +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 +There is one predefined instance of this class called {\bf wxTheColourDatabase}. \wxheading{Derived from} @@ -320,35 +370,21 @@ 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. +removed in the next wxWidgets version, please don't use it. \membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind} -\func{wxColour}{FindColour}{\param{const wxString\& }{colourName}} +\func{wxColour}{Find}{\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 \tt{NULL} if not found or a pointer which -must be deleted by the caller otherwise. - -Please note that this method is deprecated and will be removed in the next -wxWindows version, please use \helpref{Find}{wxcolourdatabasefind} instead of -it. - - \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname} \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}} Finds a colour name given the colour. Returns an empty string if the colour is not found in the database. - -