FX::FXColorRing Class Reference

A Color Ring widget provides an intuitive way to specify a color. More...

#include <FXColorRing.h>

Inheritance diagram for FX::FXColorRing:

List of all members.

Public Member Functions
	FXColorRing (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=FRAME_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)
virtual void	create ()
virtual void	detach ()
virtual void	layout ()
virtual FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
void	setHue (FXfloat h)
FXfloat	getHue () const
void	setSat (FXfloat s)
FXfloat	getSat () const
void	setVal (FXfloat v)
FXfloat	getVal () const
void	setHueSatVal (FXfloat h, FXfloat s, FXfloat v)
void	setRingWidth (FXint rw)
FXint	getRingWidth () const
void	setHelpText (const FXString &text)
const FXString &	getHelpText () const
void	setTipText (const FXString &text)
const FXString &	getTipText () const
virtual void	save (FXStream &store) const
virtual void	load (FXStream &store)
virtual	~FXColorRing ()

---

Detailed Description

A Color Ring widget provides an intuitive way to specify a color.

The outer ring of the widget is rotated to control the hue of the color being specified, while the inner triangle varies the color saturation and the brightness of the color. The color saturation axis of the triangle goes from a fully saturated "pure" color to "pastel" color; the brightness goes from black to a bright color.

---

Constructor & Destructor Documentation

FX::FXColorRing::FXColorRing (  FXComposite *  p, FXObject *  tgt = NULL, FXSelector  sel = 0, FXuint  opts = FRAME_NORMAL, FXint  x = 0, FXint  y = 0, FXint  w = 0, FXint  h = 0, FXint  pl = DEFAULT_PAD, FXint  pr = DEFAULT_PAD, FXint  pt = DEFAULT_PAD, FXint  pb = DEFAULT_PAD )

Construct color ring with initial color clr.

virtual FX::FXColorRing::~FXColorRing (   )  [virtual]

Destructor.

---

Member Function Documentation

virtual void FX::FXColorRing::create (   )  [virtual]

Create server-side resources. Reimplemented from FX::FXWindow.

virtual void FX::FXColorRing::detach (   )  [virtual]

Detach server-side resources. Reimplemented from FX::FXWindow.

virtual void FX::FXColorRing::layout (   )  [virtual]

Perform layout. Reimplemented from FX::FXWindow.

virtual FXint FX::FXColorRing::getDefaultWidth (   )  [virtual]

Return default width. Reimplemented from FX::FXFrame.

virtual FXint FX::FXColorRing::getDefaultHeight (   )  [virtual]

Return default height. Reimplemented from FX::FXFrame.

void FX::FXColorRing::setHue (  FXfloat  h  )

Change hue.

FXfloat FX::FXColorRing::getHue (   )  const [inline]

Return hue.

void FX::FXColorRing::setSat (  FXfloat  s  )

Change saturation.

FXfloat FX::FXColorRing::getSat (   )  const [inline]

Return saturation.

void FX::FXColorRing::setVal (  FXfloat  v  )

Change value.

FXfloat FX::FXColorRing::getVal (   )  const [inline]

Return value.

void FX::FXColorRing::setHueSatVal (  FXfloat  h, FXfloat  s, FXfloat  v )

Set hue, saturation, value.

void FX::FXColorRing::setRingWidth (  FXint  rw  )

Change width of hue ring.

FXint FX::FXColorRing::getRingWidth (   )  const [inline]

Return width of hue ring.

void FX::FXColorRing::setHelpText (  const FXString &  text  )  [inline]

Set status line help text for this color well.

const FXString& FX::FXColorRing::getHelpText (   )  const [inline]

Get status line help text for this color well.

void FX::FXColorRing::setTipText (  const FXString &  text  )  [inline]

Set tool tip message for this color well.

const FXString& FX::FXColorRing::getTipText (   )  const [inline]

Get tool tip message for this color well.

virtual void FX::FXColorRing::save (  FXStream &  store  )  const [virtual]

Save color well to a stream. Reimplemented from FX::FXFrame.

virtual void FX::FXColorRing::load (  FXStream &  store  )  [virtual]

Load color well from a stream. Reimplemented from FX::FXFrame.

Copyright © 1997-2005 Jeroen van der Zijp