wxRuby Documentation Home

Wx::Colour

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 ColourDatabase 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 for different UI elements with SystemSettings.

Derived from

Object

Predefined objects

These predefined colours are defined as constants in wxRuby.

Wx::NULL_COLOUR
Wx::BLACK
Wx::WHITE
Wx::RED
Wx::BLUE
Wx::GREEN
Wx::CYAN
Wx::LIGHT_GREY

See also

ColourDatabase, Pen, Brush, ColourDialog, SystemSettings

Methods

Colour.new

Colour.new(Integer red, Integer green,  Integer blue, Integer alpha = 255)

Constructs a colour from red, green and blue values and an optional alpha value for transparency. Each value should be between 0 and 255; the default value for alpha is 255, which is completely opaque.

Colour.new(String colour_name)

Constructs a colour object using the colour named colour_name, listed in the global colour database Wx::TheColourDatabase.

See also

ColourDatabase

Colour#alpha

Integer alpha()

Returns the alpha value, or opacity, for the colour.

Colour#blue

Integer blue()

Returns the blue intensity.

Colour#get_as_string

String get_as_string(Integer format)

Returns a string representation of this colour, in the format format. Format should be one of the constants:

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

Colour#green

Integer green()

Returns the green intensity.

Colour#is_ok

Boolean is_ok()

Returns if the colour object is valid (the colour has been initialised with valid RGB values).

Colour#red

Integer red()

Returns the red intensity.

Colour#set

set(Integer red,  Integer green,  Integer blue)

Sets the RGB intensity values.

See also

ColourDatabase

Colour#==

Boolean operator ==(Colour colour)

Tests the equality of two colours by comparing individual red, green blue colours.

[This page automatically generated from the Textile source at Wed Sep 09 02:21:03 +0100 2009]