.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxColour 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxColour \- 
  Represents the red, blue and green elements of a colour
 
.SH DESCRIPTION

  


   A colour is an object representing a combination of Red, Green, and Blue
   (RGB) intensity values, and is used to determine drawing colours. See the
   entry for
   wxColourDatabase
   for how a pointer to a predefined, 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
   wxSystemSettings
   .
  
 
.SH "PARENTS"

  wxObject
 
.SH "INCLUDE FILES"
wx/colour.h
.SH MEMBERS

  
.SS  wxColour ()

     


      Default constructor.
     
    
.SS  wxColour (unsigned char redunsigned char greenunsigned char blue)

     


      Constructs a colour from red, green and blue values.
     
    
.SS  wxColour (const wxString& colourNname)

     


      Constructs a colour object using a colour name listed in
      
       wxTheColourDatabase
      
      .
     
    
.SS  wxColour (const wxColour& colour)

     


      Copy constructor.
     
    
   
  
.SS unsigned char Blue ()

     


      Returns the blue intensity.
     
    
   
  
.SS long GetPixel ()

     


      Returns a pixel value which is platform-dependent. On Windows, a COLORREF
      is returned. On X, an allocated pixel value is returned.
     
     


      -1 is returned if the pixel is invalid (on X, unallocated).
     
    
   
  
.SS unsigned char Green ()

     


      Returns the green intensity.
     
    
   
  
.SS bool Ok ()

     


      Returns true if the colour object is valid (the colour has been
      initialised with RGB values).
     
    
   
  
.SS unsigned char Red ()

     


      Returns the red intensity.
     
    
   
  
.SS void Set (unsigned char redunsigned char greenunsigned char blue)

     


      Sets the RGB intensity values.
     
    
   
  
.SS wxColour& operator = (const wxColour& colour)

     


      Assignment operator, taking another colour object.
     
    
.SS wxColour& operator = (const wxString& colourName)

     


      Assignment operator, using a colour name to be found in the colour
      database.
     
    
   
  
.SS bool operator == (const wxColour& colour)

     


      Tests the equality of two colours by comparing individual red, green blue
      colours.
     
    
   
  
.SS bool operator != (const wxColour& colour)

     


      Tests the inequality of two colours by comparing individual red, green
      blue colours.
     
    
 
.SH "SEE ALSO"

  wxObject
 
  wxColourDatabase
  wxPen
  wxBrush
  , 
  wxColourDialog
  wxSystemSettings
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.