+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: colour.tex
+%% Purpose: wxColour docs
+%% Author:
+%% Modified by:
+%% 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,
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.
\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.
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}
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/cocoa/colour.h
// Purpose: wxColour class
// Author: David Elliott
// Modified by:
class WXDLLEXPORT wxColour: public wxObject
{
public:
+ // constructors
+ // ------------
+
+ // default
wxColour() { Init(); }
- // from RGB
+ // from separate RGB
wxColour( unsigned char red, unsigned char green, unsigned char blue )
: m_cocoaNSColor(NULL)
{ Set(red,green,blue); }
+
+ // from packed RGB
wxColour( unsigned long colRGB )
: m_cocoaNSColor(NULL)
{ Set(colRGB); }
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/gtk/colour.h
// Purpose:
// Author: Robert Roebling
// Id: $Id$
class WXDLLIMPEXP_CORE wxColour: public wxGDIObject
{
public:
+ // constructors
+ // ------------
+
+ // default
wxColour() { }
- // Construct from RGB
+ // from separate RGB
wxColour( unsigned char red, unsigned char green, unsigned char blue );
+
+ // from packed RGB
wxColour( unsigned long colRGB ) { Set(colRGB); }
// Implicit conversion from the colour name
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/gtk/colour.h
// Purpose:
// Author: Robert Roebling
// Id: $Id$
class WXDLLIMPEXP_CORE wxColour: public wxGDIObject
{
public:
+ // constructors
+ // ------------
+
+ // default
wxColour() { }
- // Construct from RGB
+ // from separate RGB
wxColour( unsigned char red, unsigned char green, unsigned char blue );
+
+ // from packed RGB
wxColour( unsigned long colRGB ) { Set(colRGB); }
// Implicit conversion from the colour name
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/mac/carbon/colour.h
// Purpose: wxColour class
// Author: Stefan Csomor
// Modified by:
class WXDLLEXPORT wxColour: public wxObject
{
public:
- // ctors
+ // constructors
+ // ------------
+
// default
- wxColour() { Init(); }
- // from RGB
- wxColour( unsigned char red, unsigned char green, unsigned char blue )
- { Set(red, green, blue); }
- wxColour( unsigned long colRGB )
- { Set(colRGB); }
+ wxColour() { Init(); }
+
+ // from separate RGB
+ wxColour( unsigned char red, unsigned char green, unsigned char blue )
+ { Set(red, green, blue); }
+
+ // from packed RGB
+ wxColour( unsigned long colRGB )
+ { Set(colRGB); }
// implicit conversion from the colour name
- wxColour( const wxString &colourName )
- { InitFromName(colourName); }
- wxColour( const wxChar *colourName )
- { InitFromName(colourName); }
+ wxColour( const wxString &colourName )
+ { InitFromName(colourName); }
+ wxColour( const wxChar *colourName )
+ { InitFromName(colourName); }
// copy ctors and assignment operators
- wxColour( const wxColour& col );
- wxColour& operator = ( const wxColour& col );
+ wxColour( const wxColour& col );
+ wxColour& operator = ( const wxColour& col );
// dtor
- ~wxColour();
-
- // Set() functions
- void Set( unsigned char red, unsigned char green, unsigned char blue );
- void Set( unsigned long colRGB )
- {
- // we don't need to know sizeof(long) here because we assume that the three
- // least significant bytes contain the R, G and B values
- Set((unsigned char)colRGB,
- (unsigned char)(colRGB >> 8),
- (unsigned char)(colRGB >> 16));
- }
-
- // accessors
- bool Ok() const {return m_isInit; }
-
- unsigned char Red() const { return m_red; }
- unsigned char Green() const { return m_green; }
- unsigned char Blue() const { return m_blue; }
-
- // comparison
- bool operator == (const wxColour& colour) const
- {
- return (m_isInit == colour.m_isInit
- && m_red == colour.m_red
- && m_green == colour.m_green
- && m_blue == colour.m_blue);
- }
- bool operator != (const wxColour& colour) const { return !(*this == colour); }
-
- const WXCOLORREF& GetPixel() const { return m_pixel; };
+ ~wxColour();
+
+ // Set() functions
+ void Set( unsigned char red, unsigned char green, unsigned char blue );
+ void Set( unsigned long colRGB )
+ {
+ // we don't need to know sizeof(long) here because we assume that the three
+ // least significant bytes contain the R, G and B values
+ Set((unsigned char)colRGB,
+ (unsigned char)(colRGB >> 8),
+ (unsigned char)(colRGB >> 16));
+ }
+
+ // accessors
+ bool Ok() const {return m_isInit; }
+
+ unsigned char Red() const { return m_red; }
+ unsigned char Green() const { return m_green; }
+ unsigned char Blue() const { return m_blue; }
+
+ // comparison
+ bool operator == (const wxColour& colour) const
+ {
+ return (m_isInit == colour.m_isInit
+ && m_red == colour.m_red
+ && m_green == colour.m_green
+ && m_blue == colour.m_blue);
+ }
+ bool operator != (const wxColour& colour) const { return !(*this == colour); }
+
+ const WXCOLORREF& GetPixel() const { return m_pixel; };
void InitFromName(const wxString& col);
void Init();
private:
- bool m_isInit;
- unsigned char m_red;
- unsigned char m_blue;
- unsigned char m_green;
+ bool m_isInit;
+ unsigned char m_red;
+ unsigned char m_blue;
+ unsigned char m_green;
public:
- WXCOLORREF m_pixel ;
- void Set( const WXCOLORREF* color ) ;
+ WXCOLORREF m_pixel ;
+ void Set( const WXCOLORREF* color ) ;
private:
- DECLARE_DYNAMIC_CLASS(wxColour)
+ DECLARE_DYNAMIC_CLASS(wxColour)
};
#endif
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/mac/classic/colour.h
// Purpose: wxColour class
// Author: Stefan Csomor
// Modified by:
class WXDLLEXPORT wxColour: public wxObject
{
public:
- // ctors
+ // constructors
+ // ------------
+
// default
- wxColour() { Init(); }
- // from RGB
- wxColour( unsigned char red, unsigned char green, unsigned char blue )
- { Set(red, green, blue); }
- wxColour( unsigned long colRGB )
- { Set(colRGB); }
+ wxColour() { Init(); }
+
+ // from separate RGB
+ wxColour( unsigned char red, unsigned char green, unsigned char blue )
+ { Set(red, green, blue); }
+
+ // from packed RGB
+ wxColour( unsigned long colRGB )
+ { Set(colRGB); }
// implicit conversion from the colour name
- wxColour( const wxString &colourName )
- { InitFromName(colourName); }
- wxColour( const wxChar *colourName )
- { InitFromName(colourName); }
+ wxColour( const wxString &colourName )
+ { InitFromName(colourName); }
+ wxColour( const wxChar *colourName )
+ { InitFromName(colourName); }
// copy ctors and assignment operators
- wxColour( const wxColour& col );
- wxColour( const wxColour* col );
- wxColour& operator = ( const wxColour& col );
+ wxColour( const wxColour& col );
+ wxColour( const wxColour* col );
+ wxColour& operator = ( const wxColour& col );
// dtor
- ~wxColour();
-
- // Set() functions
- void Set( unsigned char red, unsigned char green, unsigned char blue );
- void Set( unsigned long colRGB )
- {
- // we don't need to know sizeof(long) here because we assume that the three
- // least significant bytes contain the R, G and B values
- Set((unsigned char)colRGB,
- (unsigned char)(colRGB >> 8),
- (unsigned char)(colRGB >> 16));
- }
-
- // accessors
- bool Ok() const {return m_isInit; }
-
- unsigned char Red() const { return m_red; }
- unsigned char Green() const { return m_green; }
- unsigned char Blue() const { return m_blue; }
-
- // comparison
- bool operator == (const wxColour& colour) const
- {
- return (m_isInit == colour.m_isInit
- && m_red == colour.m_red
- && m_green == colour.m_green
- && m_blue == colour.m_blue);
- }
- bool operator != (const wxColour& colour) const { return !(*this == colour); }
-
- const WXCOLORREF& GetPixel() const { return m_pixel; };
+ ~wxColour();
+
+ // Set() functions
+ void Set( unsigned char red, unsigned char green, unsigned char blue );
+ void Set( unsigned long colRGB )
+ {
+ // we don't need to know sizeof(long) here because we assume that the three
+ // least significant bytes contain the R, G and B values
+ Set((unsigned char)colRGB,
+ (unsigned char)(colRGB >> 8),
+ (unsigned char)(colRGB >> 16));
+ }
+
+ // accessors
+ bool Ok() const {return m_isInit; }
+
+ unsigned char Red() const { return m_red; }
+ unsigned char Green() const { return m_green; }
+ unsigned char Blue() const { return m_blue; }
+
+ // comparison
+ bool operator == (const wxColour& colour) const
+ {
+ return (m_isInit == colour.m_isInit
+ && m_red == colour.m_red
+ && m_green == colour.m_green
+ && m_blue == colour.m_blue);
+ }
+ bool operator != (const wxColour& colour) const { return !(*this == colour); }
+
+ const WXCOLORREF& GetPixel() const { return m_pixel; };
void InitFromName(const wxString& col);
void Init();
private:
- bool m_isInit;
- unsigned char m_red;
- unsigned char m_blue;
- unsigned char m_green;
+ bool m_isInit;
+ unsigned char m_red;
+ unsigned char m_blue;
+ unsigned char m_green;
public:
- WXCOLORREF m_pixel ;
- void Set( const WXCOLORREF* color ) ;
+ WXCOLORREF m_pixel ;
+ void Set( const WXCOLORREF* color ) ;
private:
- DECLARE_DYNAMIC_CLASS(wxColour)
+ DECLARE_DYNAMIC_CLASS(wxColour)
};
#endif
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/mgl/colour.h
// Purpose: wxColour class
// Author: Julian Smart
// Modified by:
class WXDLLEXPORT wxColour: public wxObject
{
public:
- // ctors
- // default
+ // constructors
+ // ------------
+
+ // default
wxColour();
- // from RGB
+
+ // from separate RGB
wxColour(unsigned char red, unsigned char green, unsigned char blue)
{ Set(red, green, blue); }
+
+ // from packed RGB
wxColour(unsigned long colRGB) { Set(colRGB); }
- // implicit conversion from the colour name
+ // implicit conversion from the colour name
wxColour(const wxString &colourName) { InitFromName(colourName); }
wxColour(const char *colourName) { InitFromName(colourName); }
- // copy ctors and assignment operators
+ // copy ctors and assignment operators
wxColour(const wxColour& col);
wxColour& operator = (const wxColour& col);
- // dtor
+ // dtor
~wxColour();
// Set() functions
void Set(unsigned char red, unsigned char green, unsigned char blue);
void Set(unsigned long colRGB)
{
- // we don't need to know sizeof(long) here because we assume that the three
- // least significant bytes contain the R, G and B values
- Set((unsigned char)colRGB,
- (unsigned char)(colRGB >> 8),
- (unsigned char)(colRGB >> 16));
+ // we don't need to know sizeof(long) here because we assume that the three
+ // least significant bytes contain the R, G and B values
+ Set((unsigned char)colRGB,
+ (unsigned char)(colRGB >> 8),
+ (unsigned char)(colRGB >> 16));
}
// accessors
// comparison
bool operator == (const wxColour& colour) const
{
- return (m_red == colour.m_red &&
- m_green == colour.m_green &&
- m_blue == colour.m_blue &&
- m_isInit == colour.m_isInit);
+ return (m_red == colour.m_red &&
+ m_green == colour.m_green &&
+ m_blue == colour.m_blue &&
+ m_isInit == colour.m_isInit);
}
bool operator != (const wxColour& colour) const { return !(*this == colour); }
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/motif/colour.h
// Purpose: wxColour class
// Author: Julian Smart
// Modified by:
// Created: 17/09/98
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_COLOUR_H_
{
DECLARE_DYNAMIC_CLASS(wxColour)
public:
- // ctors
+ // constructors
+ // ------------
+
// default
wxColour();
- // from RGB
+
+ // from separate RGB
wxColour( unsigned char red, unsigned char green, unsigned char blue )
{ Set(red, green, blue); }
+
+ // from packed RGB
wxColour( unsigned long colRGB ) { Set(colRGB); }
// implicit conversion from the colour name
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/os2/colour.h
// Purpose: wxColour class
// Author: David Webster
// Modified by:
class WXDLLEXPORT wxColour: public wxObject
{
public:
- //
- // Ctors
- //
+ // constructors
+ // ------------
- //
- // Default
- //
+ // default
wxColour();
- //
- // from RGB
- //
- wxColour( unsigned char cRed
- ,unsigned char cGreen
- ,unsigned char cBlue
- );
+ // from separate RGB
+ wxColour( unsigned char cRed, unsigned char cGreen, unsigned char cBlue );
+ // from packed RGB
wxColour( unsigned long colRGB ) { Set(colRGB); }
- //
// Implicit conversion from the colour name
- //
wxColour(const wxString& rColourName) { InitFromName(rColourName); }
wxColour(const wxChar *zColourName) { InitFromName(zColourName); }
- //
// Copy ctors and assignment operators
- //
wxColour(const wxColour& rCol);
wxColour(const wxColour* pCol);
wxColour&operator = (const wxColour& rCol);
- //
// Dtor
- //
~wxColour();
- //
// Set functions
- //
- void Set( unsigned char cRed
- ,unsigned char cGreen
- ,unsigned char cBlue
- );
- void Set(unsigned long lColRGB)
+ void Set( unsigned char cRed, unsigned char cGreen, unsigned char cBlue);
+ void Set( unsigned long lColRGB)
{
- //
// We don't need to know sizeof(long) here because we assume that the three
// least significant bytes contain the R, G and B values
- //
Set( (unsigned char)lColRGB
,(unsigned char)(lColRGB >> 8)
,(unsigned char)(lColRGB >> 16)
InitFromName(rsColour);
}
- //
// Accessors
- //
bool Ok(void) const {return m_bIsInit; }
unsigned char Red(void) const { return m_cRed; }
unsigned char Green(void) const { return m_cGreen; }
unsigned char Blue(void) const { return m_cBlue; }
- //
// Comparison
- //
bool operator == (const wxColour& rColour) const
{
return (m_bIsInit == rColour.m_bIsInit
public:
WXCOLORREF m_vPixel ;
private:
- DECLARE_DYNAMIC_CLASS(wxColour)
+ DECLARE_DYNAMIC_CLASS(wxColour)
}; // end of class wxColour
#endif
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.h
+// Name: wx/x11/colour.h
// Purpose: wxColour class
// Author: Julian Smart, Robert Roebling
// Modified by:
// Created: 17/09/98
// RCS-ID: $Id$
// Copyright: (c) Julian Smart, Robert Roebling
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_COLOUR_H_
class WXDLLEXPORT wxColour: public wxGDIObject
{
public:
+ // constructors
+ // ------------
+
+ // default
wxColour() { }
- // Construct from RGB
+ // from separate RGB
wxColour( unsigned char red, unsigned char green, unsigned char blue );
+
+ // from packed RGB
wxColour( unsigned long colRGB ) { Set(colRGB); }
// Implicit conversion from the colour name
#endif
// _WX_COLOUR_H_
-
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.mm
+// Name: src/cococa/colour.mm
// Purpose: wxColour class
// Author: David Elliott
// Modified by:
// Created: 2003/06/17
// RCS-ID: $Id$
// Copyright: (c) 2003 David Elliott
-// Licence: wxWidgets licence
+// Licence: wxWidgets licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/wxprec.h"
unless the color was actually RGB to begin with it's likely that
these will be fairly bogus. Particulary if the color is a pattern. */
NSColor *rgbColor = [m_cocoaNSColor colorUsingColorSpaceName:NSCalibratedRGBColorSpace];
- m_red = (wxUint8) ([rgbColor redComponent] * 255.0);
+ m_red = (wxUint8) ([rgbColor redComponent] * 255.0);
m_green = (wxUint8) ([rgbColor greenComponent] * 255.0);
- m_blue = (wxUint8) ([rgbColor blueComponent] * 255.0);
+ m_blue = (wxUint8) ([rgbColor blueComponent] * 255.0);
}
-
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/gtk/colour.cpp
// Purpose:
// Author: Robert Roebling
// Id: $Id$
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/gtk/colour.cpp
// Purpose:
// Author: Robert Roebling
// Id: $Id$
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/mac/carbon/colour.cpp
// Purpose: wxColour class
// Author: Stefan Csomor
// Modified by:
// Created: 1998-01-01
// RCS-ID: $Id$
// Copyright: (c) Stefan Csomor
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/wxprec.h"
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/mac/classic/colour.cpp
// Purpose: wxColour class
// Author: Stefan Csomor
// Modified by:
// Created: 1998-01-01
// RCS-ID: $Id$
// Copyright: (c) Stefan Csomor
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/gdicmn.h"
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/mgl/colour.cpp
// Purpose: wxColour class
// Author: Julian Smart
// Modified by:
// Created: 01/02/97
// RCS-ID: $Id$
// Copyright: (c) Julian Smart
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// For compilers that support precompilation, includes "wx.h".
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/msw/colour.cpp
// Purpose: wxColour class
// Author: Julian Smart
// Modified by:
m_isInit = true;
m_pixel = PALETTERGB(m_red, m_green, m_blue);
}
-
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/os2/colour.cpp
// Purpose: wxColour class
// Author: David Webster
// Modified by:
void wxColour::Set(unsigned char r, unsigned char g, unsigned char b)
{
+ m_red = r;
+ m_green = g;
+ m_blue = b;
+ m_isInit = true;
}
-
/////////////////////////////////////////////////////////////////////////////
-// Name: colour.cpp
+// Name: src/x11/colour.cpp
// Purpose: wxColour class
// Author: Julian Smart, Robert Roebling
// Modified by:
// Created: 17/09/98
// RCS-ID: $Id$
// Copyright: (c) Julian Smart, Robert Roebling
-// Licence: wxWindows licence
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/gdicmn.h"
projects / wxWidgets.git / commitdiff
