Public Member Functions | Protected Attributes | Related Functions

Gdk::RGBA Class Reference

TODO. More...

List of all members.

Public Member Functions

 RGBA (GdkRGBA* gobject, bool make_a_copy=true)
 RGBA (const RGBA& other)
RGBAoperator= (const RGBA& other)
 ~RGBA ()
void swap (RGBA& other)
GdkRGBA* gobj ()
 Provides access to the underlying C instance.
const GdkRGBA* gobj () const
 Provides access to the underlying C instance.
GdkRGBA* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
 RGBA ()
 Instantiate a new Gdk::RGBA.
 RGBA (const Glib::ustring&value)
 Instantiate a new Gdk::RGBA.
void set_grey_u (gushort value, gushort alpha=1)
 Set a grey color, by using the same value for all color components.
void set_grey (double g, double alpha=65535.0)
void set_rgba_u (gushort red_, gushort green_, gushort blue_, gushort alpha_=65535.0)
 Set the color, by specifying red, green, and blue color component values.
void set_rgba (double red_, double green_, double blue_, double alpha_=1)
 Set the color, by specifying red, green, and blue color component values, as percentages.
void set_hsv (double h, double s, double v)
void set_hsl (double h, double s, double l)
bool set (const Glib::ustring&value)
gushort get_red_u () const
 Get the red component of the color.
gushort get_green_u () const
 Get the green component of the color.
gushort get_blue_u () const
 Get the blue component of the color.
gushort get_alpha_u () const
 Get the alpha component of the color.
void set_red_u (gushort value)
 Set the red component of the color.
void set_green_u (gushort value)
 Set the green component of the color.
void set_blue_u (gushort value)
 Set the blue component of the color.
void set_alpha_u (gushort value)
 Set the alpha component of the color.
double get_red () const
 Get the red component of the color, as a percentage.
double get_green () const
 Get the green component of the color, as a percentage.
double get_blue () const
 Get the blue component of the color, as a percentage.
double get_alpha () const
 Get the alpha component of the color, as a percentage.
void set_red (double value)
 Set the red component of the color, as a percentage.
void set_green (double value)
 Set the green component of the color, as a percentage.
void set_blue (double value)
 Set the blue component of the color, as a percentage.
void set_alpha (double value)
 Set the alpha component of the color, as a percentage.
Glib::ustring to_string () const
 Set the alpha component of the color.

Protected Attributes

GdkRGBA* gobject_

Related Functions

(Note that these are not member functions.)


bool operator== (const RGBA& lhs, const RGBA& rhs)
bool operator!= (const RGBA& lhs, const RGBA& rhs)
void swap (RGBA& lhs, RGBA& rhs)
Gdk::RGBA wrap (GdkRGBA* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

TODO.


Constructor & Destructor Documentation

Gdk::RGBA::RGBA ( GdkRGBA *  gobject,
bool  make_a_copy = true 
) [explicit]
Gdk::RGBA::RGBA ( const RGBA other )
Gdk::RGBA::~RGBA (  )
Gdk::RGBA::RGBA (  )

Instantiate a new Gdk::RGBA.

Gdk::RGBA::RGBA ( const Glib::ustring value ) [explicit]

Instantiate a new Gdk::RGBA.

The text string can be in any of the forms accepted by XParseRGBA; these include names for a color from rgb.txt, such as DarkSlateGray, or a hex specification such as 305050.

Parameters:
valuethe string specifying the color..

Member Function Documentation

double Gdk::RGBA::get_alpha (  ) const

Get the alpha component of the color, as a percentage.

Returns:
The alpha component of the color, as a percentage.
gushort Gdk::RGBA::get_alpha_u (  ) const

Get the alpha component of the color.

Returns:
The alpha component of the color.
double Gdk::RGBA::get_blue (  ) const

Get the blue component of the color, as a percentage.

Returns:
The blue component of the color, as a percentage.
gushort Gdk::RGBA::get_blue_u (  ) const

Get the blue component of the color.

Returns:
The blue component of the color.
double Gdk::RGBA::get_green (  ) const

Get the green component of the color, as a percentage.

Returns:
The green component of the color, as a percentage.
gushort Gdk::RGBA::get_green_u (  ) const

Get the green component of the color.

Returns:
The green component of the color.
double Gdk::RGBA::get_red (  ) const

Get the red component of the color, as a percentage.

Returns:
The red component of the color, as a percentage.
gushort Gdk::RGBA::get_red_u (  ) const

Get the red component of the color.

Returns:
The red component of the color.
const GdkRGBA* Gdk::RGBA::gobj (  ) const [inline]

Provides access to the underlying C instance.

GdkRGBA* Gdk::RGBA::gobj (  ) [inline]

Provides access to the underlying C instance.

GdkRGBA* Gdk::RGBA::gobj_copy (  ) const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

RGBA& Gdk::RGBA::operator= ( const RGBA other )
bool Gdk::RGBA::set ( const Glib::ustring value )
void Gdk::RGBA::set_alpha ( double  value )

Set the alpha component of the color, as a percentage.

Parameters:
valueThe blue component of the color.
void Gdk::RGBA::set_alpha_u ( gushort  value )

Set the alpha component of the color.

Parameters:
valueThe alpha component of the color.
void Gdk::RGBA::set_blue ( double  value )

Set the blue component of the color, as a percentage.

Parameters:
valueThe blue component of the color.
void Gdk::RGBA::set_blue_u ( gushort  value )

Set the blue component of the color.

Parameters:
valueThe blue component of the color.
void Gdk::RGBA::set_green ( double  value )

Set the green component of the color, as a percentage.

Parameters:
valueThe green component of the color.
void Gdk::RGBA::set_green_u ( gushort  value )

Set the green component of the color.

Parameters:
valueThe green component of the color.
void Gdk::RGBA::set_grey ( double  g,
double  alpha = 65535.0 
)
void Gdk::RGBA::set_grey_u ( gushort  value,
gushort  alpha = 1 
)

Set a grey color, by using the same value for all color components.

Parameters:
valueThe value to be used for the red, green, and blue components.
void Gdk::RGBA::set_hsl ( double  h,
double  s,
double  l 
)
void Gdk::RGBA::set_hsv ( double  h,
double  s,
double  v 
)
void Gdk::RGBA::set_red ( double  value )

Set the red component of the color, as a percentage.

Parameters:
valueThe red component of the color.
void Gdk::RGBA::set_red_u ( gushort  value )

Set the red component of the color.

Parameters:
valueThe red component of the color.
void Gdk::RGBA::set_rgba ( double  red_,
double  green_,
double  blue_,
double  alpha_ = 1 
)

Set the color, by specifying red, green, and blue color component values, as percentages.

Parameters:
red_The red component of the color, as a percentage.
green_The green component of the color, as a percentage.
blue_The blue component of the color, as a percentage.
void Gdk::RGBA::set_rgba_u ( gushort  red_,
gushort  green_,
gushort  blue_,
gushort  alpha_ = 65535.0 
)

Set the color, by specifying red, green, and blue color component values.

Parameters:
red_The red component of the color.
green_The green component of the color.
blue_The blue component of the color.
void Gdk::RGBA::swap ( RGBA other )
Glib::ustring Gdk::RGBA::to_string (  ) const

Set the alpha component of the color.

Parameters:
valueThe alpha component of the color.

Friends And Related Function Documentation

bool operator!= ( const RGBA lhs,
const RGBA rhs 
) [related]
Parameters:
lhsThe left-hand side
rhsThe right-hand side
Returns:
The result
bool operator== ( const RGBA lhs,
const RGBA rhs 
) [related]
Parameters:
lhsThe left-hand side
rhsThe right-hand side
Returns:
The result
void swap ( RGBA lhs,
RGBA rhs 
) [related]
Parameters:
lhsThe left-hand side
rhsThe right-hand side
Gdk::RGBA wrap ( GdkRGBA *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

Member Data Documentation

GdkRGBA* Gdk::RGBA::gobject_ [protected]

The documentation for this class was generated from the following file: