FX::FXColorBar Class Reference

A Color Bar is a widget which controls the brightness (value) of a color by means of the hue, saturation, value specification system. More...

#include <FXColorBar.h>

Inheritance diagram for FX::FXColorBar:

List of all members.

Public Member Functions
	FXColorBar (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 FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
virtual void	layout ()
void	setHue (FXfloat h)
FXfloat	getHue () const
void	setSat (FXfloat s)
FXfloat	getSat () const
void	setVal (FXfloat v)
FXfloat	getVal () const
FXuint	getBarStyle () const
void	setBarStyle (FXuint style)
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	~FXColorBar ()

---

Detailed Description

A Color Bar is a widget which controls the brightness (value) of a color by means of the hue, saturation, value specification system.

It is most useful when used together with the Color Wheel which controls the hue and saturation. The options COLORBAR_HORIZONTAL and COLORBAR_VERTICAL control the orientation of the bar.

See also:

• Color bar orientation.

---

Constructor & Destructor Documentation

FX::FXColorBar::FXColorBar	(	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 bar.

virtual FX::FXColorBar::~FXColorBar

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual void FX::FXColorBar::create

(

)

[virtual]

Create server-side resources.

Reimplemented from FX::FXWindow.

virtual void FX::FXColorBar::detach

(

)

[virtual]

Detach server-side resources.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXColorBar::getDefaultWidth

(

)

[virtual]

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXColorBar::getDefaultHeight

(

)

[virtual]

Return default height.

Reimplemented from FX::FXFrame.

virtual void FX::FXColorBar::layout

(

)

[virtual]

Perform layout.

Reimplemented from FX::FXWindow.

void FX::FXColorBar::setHue

(

FXfloat

h

)

Change hue.

FXfloat FX::FXColorBar::getHue

(

)

const [inline]

Return hue.

void FX::FXColorBar::setSat

(

FXfloat

s

)

Change saturation.

FXfloat FX::FXColorBar::getSat

(

)

const [inline]

Return saturation.

void FX::FXColorBar::setVal

(

FXfloat

v

)

Change value.

FXfloat FX::FXColorBar::getVal

(

)

const [inline]

Return value.

FXuint FX::FXColorBar::getBarStyle

(

)

const

Change the color bar style.

void FX::FXColorBar::setBarStyle

(

FXuint

style

)

Get the color bar style.

void FX::FXColorBar::setHelpText

(

const FXString &

text

)

[inline]

Set status line help text for this color bar.

const FXString& FX::FXColorBar::getHelpText

(

)

const [inline]

Get status line help text for this color bar.

void FX::FXColorBar::setTipText

(

const FXString &

text

)

[inline]

Set tool tip message for this color bar.

const FXString& FX::FXColorBar::getTipText

(

)

const [inline]

Get tool tip message for this color bar.

virtual void FX::FXColorBar::save

(

FXStream &

store

)

const [virtual]

Save color bar to a stream.

Reimplemented from FX::FXFrame.

virtual void FX::FXColorBar::load

(

FXStream &

store

)

[virtual]

Load color bar from a stream.

Reimplemented from FX::FXFrame.