.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxColourDatabase 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxColourDatabase \- 
.SH DESCRIPTION

  


   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
   AddColour
   and may use it to look up colours by names using
   Find
   or find the names for the standard colour suing
   FindName
   .
  
  


   There is one predefined instance of this class called
   
    wxTheColourDatabase
   
   .
  
 
.SH REMARKS

  
   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 ORCHID, DARK SLATE
   BLUE, DARK SLATE GREY DARK TURQUOISE, DIM GREY, FIREBRICK, FOREST GREEN,
   GOLD, GOLDENROD, GREY, GREEN, GREEN YELLOW, INDIAN RED, KHAKI, LIGHT BLUE,
   LIGHT GREY, LIGHT STEEL BLUE, LIME GREEN, MAGENTA, MAROON, MEDIUM AQUAMARINE,
   MEDIUM BLUE, MEDIUM FOREST GREEN, MEDIUM GOLDENROD, MEDIUM ORCHID, MEDIUM SEA
   GREEN, MEDIUM SLATE BLUE, MEDIUM SPRING GREEN, MEDIUM TURQUOISE, MEDIUM
   VIOLET RED, MIDNIGHT BLUE, NAVY, ORANGE, ORANGE RED, ORCHID, PALE GREEN,
   PINK, PLUM, PURPLE, RED, SALMON, SEA GREEN, SIENNA, SKY BLUE, SLATE BLUE,
   SPRING GREEN, STEEL BLUE, TAN, THISTLE, TURQUOISE, VIOLET, VIOLET RED, WHEAT,
   WHITE, YELLOW, YELLOW GREEN.
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/gdicmn.h
.SH MEMBERS

  
.SS  wxColourDatabase ()

     


      Constructs the colour database. It will be initialized at the first use.
     
    
   
  
.SS void AddColour (const wxString& colourNameconst wxColour&colour)

.SS void AddColour (const wxString& colourNamewxColour* 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 wxWidgets version, please don't use it.
     
    
   
  
.SS wxColour Find (const wxString& colourName)

     


      Finds a colour given the name. Returns an invalid colour object (that is,
      such that its
      Ok()
      method returns false) if the colour wasn't found in the database.
     
    
   
  
.SS wxString FindName (const wxColour& colour)

     


      Finds a colour name given the colour. Returns an empty string if the
      colour is not found in the database.
     
    
 
.SH "SEE ALSO"

  wxColour
 
.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.