FX::FXDial Class Reference

The Dial widget is a valuator widget which is able to provide a cyclic value range when the DIAL_CYCLIC is passed, or a simple linear value range. More...

#include <FXDial.h>

Inheritance diagram for FX::FXDial:

List of all members.

Public Member Functions
	FXDial (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=DIAL_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 FXint	getDefaultWidth ()
virtual FXint	getDefaultHeight ()
virtual bool	canFocus () const
void	setValue (FXint value, FXbool notify=FALSE)
FXint	getValue () const
void	setRange (FXint lo, FXint hi, FXbool notify=FALSE)
void	getRange (FXint &lo, FXint &hi) const
void	setRevolutionIncrement (FXint i)
FXint	getRevolutionIncrement () const
void	setNotchSpacing (FXint spacing)
FXint	getNotchSpacing () const
void	setNotchOffset (FXint offset)
FXint	getNotchOffset () const
void	setDialStyle (FXuint opts)
FXuint	getDialStyle () const
void	setNotchColor (FXColor clr)
FXColor	getNotchColor () 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)

---

Detailed Description

The Dial widget is a valuator widget which is able to provide a cyclic value range when the DIAL_CYCLIC is passed, or a simple linear value range.

While being turned, the dial sends a SEL_CHANGED message to its target; at the end of the interaction, a SEL_COMMAND message is sent. The message data represents the current value, of type FXint. The options DIAL_VERTICAL and DIAL_HORIZONTAL control the orientation of the dial. An optional notch can be used to indicate the zero-position of the dial; display of the notch is controlled by the DIAL_HAS_NOTCH option.

See also:

• Dial style options.

---

Constructor & Destructor Documentation

FX::FXDial::FXDial	(	FXComposite *	p,
		FXObject *	tgt = NULL,
		FXSelector	sel = 0,
		FXuint	opts = DIAL_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 a dial widget.

---

Member Function Documentation

virtual FXint FX::FXDial::getDefaultWidth

(

)

[virtual]

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXDial::getDefaultHeight

(

)

[virtual]

Return default height.

Reimplemented from FX::FXFrame.

virtual bool FX::FXDial::canFocus

(

)

const [virtual]

Returns true because a dial can receive focus.

Reimplemented from FX::FXWindow.

void FX::FXDial::setValue	(	FXint	value,
		FXbool	notify = FALSE
	)

Set the dial value.

FXint FX::FXDial::getValue

(

)

const [inline]

Return the dial value.

void FX::FXDial::setRange	(	FXint	lo,
		FXint	hi,
		FXbool	notify = FALSE
	)

Change the dial's range.

void FX::FXDial::getRange	(	FXint &	lo,
		FXint &	hi
	)			const [inline]

Obtain the current range of the dial.

void FX::FXDial::setRevolutionIncrement

(

FXint

i

)

Set the revolution increment, which is the amount of change in the position for revolution of the dial; the dial may go through multiple revolutions to go through its whole range; by default it takes one 360 degree turn of the dial to go from the lower to the upper range.

FXint FX::FXDial::getRevolutionIncrement

(

)

const [inline]

Get the current value of the revolution increment.

void FX::FXDial::setNotchSpacing

(

FXint

spacing

)

Change the spacing for the small notches; this should be set in tenths of degrees in the range [1,3600], and the value should be a divisor of 3600, so as to make the notches come out evenly.

FXint FX::FXDial::getNotchSpacing

(

)

const [inline]

Get the current notch spacing.

void FX::FXDial::setNotchOffset

(

FXint

offset

)

Change the notch offset, which is the position of the center notch; the value should be tenths of degrees in the range [-3600,3600].

FXint FX::FXDial::getNotchOffset

(

)

const [inline]

Get the current center notch offset.

void FX::FXDial::setDialStyle

(

FXuint

opts

)

Changes the dial style.

FXuint FX::FXDial::getDialStyle

(

)

const

Get the current dial style.

void FX::FXDial::setNotchColor

(

FXColor

clr

)

Change the center notch color.

FXColor FX::FXDial::getNotchColor

(

)

const [inline]

Get the current center notch color.

void FX::FXDial::setHelpText

(

const FXString &

text

)

Set the help text to be displayed on the status line.

const FXString& FX::FXDial::getHelpText

(

)

const [inline]

Get the current help text.

void FX::FXDial::setTipText

(

const FXString &

text

)

Set the tip text to be displayed in the tooltip.

const FXString& FX::FXDial::getTipText

(

)

const [inline]

Get the current tooltip text value.

virtual void FX::FXDial::save

(

FXStream &

store

)

const [virtual]

Save to stream.

Reimplemented from FX::FXFrame.

virtual void FX::FXDial::load

(

FXStream &

store

)

[virtual]

Load from stream.

Reimplemented from FX::FXFrame.