gui::gradient Class Reference

An helper to make gradients. More...

#include <gui_gradient.hpp>

List of all members.

Public Types
enum	orientation { HORIZONTAL, VERTICAL }
Public Member Functions
	gradient ()
	Default constructor.
	gradient (orientation mOrientation, const color &mMinColor, const color &mMaxColor)
	Constructor.
const color &	get_min_color () const
	Returns the gradient's min colors.
const color &	get_max_color () const
	Returns the gradient's max colors.
orientation	get_orientation () const
	Returns the gradient's orientation.
bool	is_empty () const
	Checks if this gradient is an empty one.
Static Public Attributes
static const gradient	NONE = gradient()

---

Detailed Description

An helper to make gradients.

Definition at line 10 of file gui_gradient.hpp.

---

Member Enumeration Documentation

enum gui::gradient::orientation

Enumerator:

HORIZONTAL
VERTICAL

Definition at line 14 of file gui_gradient.hpp.

---

Constructor & Destructor Documentation

gui::gradient::gradient

(

)

Default constructor.

Note:

Makes an empty gradient.

Definition at line 7 of file gui_gradient.cpp.

gui::gradient::gradient	(	orientation	mOrientation,
		const color &	mMinColor,
		const color &	mMaxColor
	)

Constructor.

Parameters:

	mOrientation	This gradient's orientation
	mMinColor	This gradient's min color
	mMaxColor	This gradient's max color

Definition at line 13 of file gui_gradient.cpp.

---

Member Function Documentation

const color & gui::gradient::get_max_color

(

)

const

Returns the gradient's max colors.

Returns:

The gradient's max colors

Note:

In horizontal mode, this is the right color, and in vertical mode this is the bottom one.

Definition at line 23 of file gui_gradient.cpp.

const color & gui::gradient::get_min_color

(

)

const

Returns the gradient's min colors.

Returns:

The gradient's min colors

Note:

In horizontal mode, this is the left color, and in vertical mode this is the top one.

Definition at line 18 of file gui_gradient.cpp.

gradient::orientation gui::gradient::get_orientation

(

)

const

Returns the gradient's orientation.

Returns:

The gradient's orientation

Definition at line 28 of file gui_gradient.cpp.

bool gui::gradient::is_empty

(

)

const

Checks if this gradient is an empty one.

Returns:

'true' if this gradient is an empty one

Definition at line 33 of file gui_gradient.cpp.

---

Member Data Documentation

const gradient gui::gradient::NONE = gradient() [static]

Definition at line 56 of file gui_gradient.hpp.

---

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

• D:/Programmation/Sources/lxgui/bak/lxgui/gui/include/gui_gradient.hpp
• D:/Programmation/Sources/lxgui/bak/lxgui/gui/src/gui_gradient.cpp