GG::HueSaturationPicker Class Reference

A control specifically designed for ColorDlg that allows the user to select a point in the Hue-Saturation subspace of the HSV color space. More...

#include <ColorDlg.h>

Inheritance diagram for GG::HueSaturationPicker:

GG::Control GG::Wnd

List of all members.

Public Attributes

ChangedSignalType ChangedSignal

Signal Types



typedef boost::signal< void(double,
double)> 
ChangedSignalType

Structors



 HueSaturationPicker (X x, Y y, X w, Y h)

Mutators



virtual void Render ()
virtual void LButtonDown (const Pt &pt, Flags< ModKey > mod_keys)
virtual void LDrag (const Pt &pt, const Pt &move, Flags< ModKey > mod_keys)
void SetHueSaturation (double hue, double saturation)

Structors



 HueSaturationPicker ()


Detailed Description

A control specifically designed for ColorDlg that allows the user to select a point in the Hue-Saturation subspace of the HSV color space.

Definition at line 60 of file ColorDlg.h.


Member Typedef Documentation

typedef boost::signal<void (double, double)> GG::HueSaturationPicker::ChangedSignalType

emitted whenever the hue or saturation in the picker changes

Definition at line 64 of file ColorDlg.h.


Constructor & Destructor Documentation

GG::HueSaturationPicker::HueSaturationPicker ( X  x,
Y  y,
X  w,
Y  h 
)

basic ctor

GG::HueSaturationPicker::HueSaturationPicker (  )  [protected]

default ctor


Member Function Documentation

virtual void GG::HueSaturationPicker::Render (  )  [virtual]

Draws this Wnd. Note that Wnds being dragged for a drag-and-drop operation are rendered twice -- once in-place as normal, once in the location of the drag operation, attached to the cursor. Such Wnds may wish to render themselves differently in those two cases. To determine which render is being performed, they can call GUI::GetGUI()->RenderingDragDropWnds().

Implements GG::Control.

virtual void GG::HueSaturationPicker::LButtonDown ( const Pt pt,
Flags< ModKey >  mod_keys 
) [virtual]

Respond to left button down msg. A window receives this whenever any input device button changes from up to down while over the window.

Note:
If this Wnd was created with the REPEAT_BUTTON_DOWN flag, this method may be called multiple times during a single button press-release cycle.
See also:
GG::GUI

Reimplemented from GG::Wnd.

virtual void GG::HueSaturationPicker::LDrag ( const Pt pt,
const Pt move,
Flags< ModKey >  mod_keys 
) [virtual]

Respond to left button drag msg (even if this Wnd is not dragable). Drag messages are only sent to the window over which the button was pressed at the beginning of the drag. A window receives this whenever any input device button is down and the cursor is moving while over the window. The window will also receive drag messages when the mouse is being dragged outside the window's area.

Reimplemented from GG::Wnd.

void GG::HueSaturationPicker::SetHueSaturation ( double  hue,
double  saturation 
)

sets the current hue and saturation. Note that this does not cause a signal to be emitted.


Member Data Documentation

emitted whenever the hue or saturation in the picker changes

Definition at line 79 of file ColorDlg.h.


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

Generated on Sat Mar 26 07:08:37 2011 for GG by  doxygen 1.5.9