X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f510b7b2f386afe6c3705c2cdbc9208435984dac..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/colour.tex diff --git a/docs/latex/wx/colour.tex b/docs/latex/wx/colour.tex index 7cad445d00..16d19ef3a6 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}, \param{unsigned char}{ alpha=wxALPHA\_OPAQUE}} -Constructs a colour from red, green and blue values. +Constructs a colour from red, green, blue and alpha 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}{wxcolourset} for more info. \func{}{wxColour}{\param{const wxColour\&}{ colour}} @@ -68,6 +78,8 @@ Copy constructor. \docparam{blue}{The blue value.} +\docparam{alpha}{The alpha value. Alpha values range from 0 (wxALPHA\_TRANSPARENT) to 255 (wxALPHA\_OPAQUE).} + \docparam{colourName}{The colour name.} \docparam{colour}{The colour to copy.} @@ -85,6 +97,13 @@ Copy constructor. +\membersection{wxColour::Alpha}\label{wxcolouralpha} + +\constfunc{unsigned char}{Alpha}{\void} + +Returns the alpha value, on platforms where alpha is not yet supported, this always returns wxALPHA\_OPAQUE. + + \membersection{wxColour::Blue}\label{wxcolourblue} \constfunc{unsigned char}{Blue}{\void} @@ -92,6 +111,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} @@ -109,9 +146,9 @@ On X, an allocated pixel value is returned. Returns the green intensity. -\membersection{wxColour::Ok}\label{wxcolourok} +\membersection{wxColour::IsOk}\label{wxcolourisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns \true if the colour object is valid (the colour has been initialised with RGB values). @@ -125,9 +162,19 @@ 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}, \param{unsigned char}{ alpha=wxALPHA\_OPAQUE}} -Sets the RGB intensity values. +\func{void}{Set}{\param{unsigned long}{ RGB}} + +\func{bool}{Set}{\param{const wxString \&}{ str}} + +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} @@ -149,14 +196,14 @@ Assignment operator, using a colour name to be found in the colour database. \func{bool}{operator $==$}{\param{const wxColour\&}{ colour}} -Tests the equality of two colours by comparing individual red, green blue colours. +Tests the equality of two colours by comparing individual red, green, blue colours and alpha values. \membersection{wxColour::operator $!=$}\label{wxcolourinequality} \func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}} -Tests the inequality of two colours by comparing individual red, green blue colours. +Tests the inequality of two colours by comparing individual red, green, blue colours and alpha values. \section{\class{wxColourData}}\label{wxcolourdata} @@ -198,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. @@ -264,12 +313,12 @@ Assignment operator for the colour data. 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} @@ -326,25 +375,13 @@ 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 +that its \helpref{Ok()}{wxcolourisok} 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 -wxWidgets version, please use \helpref{Find}{wxcolourdatabasefind} instead of -it. - - \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname} \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}} @@ -352,4 +389,3 @@ it. Finds a colour name given the colour. Returns an empty string if the colour is not found in the database. -