KDoubleNumInput Class Reference

An input control for real numbers, consisting of a spinbox and a slider. More...

#include <knuminput.h>

Inheritance diagram for KDoubleNumInput:

List of all members.

Public Slots
void	setPrefix (const QString &prefix)
void	setReferencePoint (double ref)
void	setRelativeValue (double)
void	setSuffix (const QString &suffix)
void	setValue (double)
Signals
void	relativeValueChanged (double)
void	valueChanged (double)
Public Member Functions
	KDoubleNumInput (QWidget *parent=0)
	KDoubleNumInput (double lower, double upper, double value, QWidget *parent=0, double singleStep=0.01, int precision=2)
KDE_CONSTRUCTOR_DEPRECATED	KDoubleNumInput (KNumInput *below, double lower, double upper, double value, QWidget *parent=0, double singleStep=0.02, int precision=2)
virtual	~KDoubleNumInput ()
int	decimals () const
double	exponentRatio () const
double	maximum () const
double	minimum () const
virtual QSize	minimumSizeHint () const
QString	prefix () const
double	referencePoint () const
double	relativeValue () const
void	setDecimals (int decimals)
void	setExponentRatio (double dbl)
virtual void	setLabel (const QString &label, Qt::Alignment a=Qt::AlignLeft|Qt::AlignTop)
void	setMaximum (double max)
void	setMinimum (double min)
void	setPrecision (int precision)
void	setRange (double min, double max, double singleStep=1, bool slider=true)
void	setSingleStep (double singleStep)
void	setSliderEnabled (bool enabled)
void	setSpecialValueText (const QString &text)
double	singleStep () const
QString	specialValueText () const
QString	suffix () const
double	value () const
Protected Member Functions
virtual void	doLayout ()
void	resizeEvent (QResizeEvent *)
Properties
int	decimals
double	exponentRatio
double	maximum
double	minimum
QString	prefix
double	referencePoint
double	relativeValue
double	singleStep
bool	sliderEnabled
QString	specialValueText
QString	suffix
double	value

---

Detailed Description

An input control for real numbers, consisting of a spinbox and a slider.

KDoubleNumInput combines a QSpinBox and optionally a QSlider with a label to make an easy to use control for setting some float parameter. This is especially nice for configuration dialogs, which can have many such combinated controls.

The slider is created only when the user specifies a range for the control using the setRange function with the slider parameter set to "true".

A special feature of KDoubleNumInput, designed specifically for the situation when there are several instances in a column, is that you can specify what portion of the control is taken by the QSpinBox (the remaining portion is used by the slider). This makes it very simple to have all the sliders in a column be the same size.

KDE Double Number Input Spinbox

See also:

KIntNumInput

Definition at line 450 of file knuminput.h.

---

Constructor & Destructor Documentation

KDoubleNumInput::KDoubleNumInput

(

QWidget *

parent = 0

)

[explicit]

Constructs an input control for double values with initial value 0.00.

Definition at line 694 of file knuminput.cpp.

KDoubleNumInput::KDoubleNumInput	(	double	lower,
		double	upper,
		double	value,
		QWidget *	parent = 0,
		double	singleStep = 0.01,
		int	precision = 2
	)

Constructor.

Parameters:

lower	lower boundary value
upper	upper boundary value
value	initial value for the control
singleStep	step size to use for up/down arrow clicks
precision	number of digits after the decimal point
parent	parent QWidget

Definition at line 702 of file knuminput.cpp.

KDoubleNumInput::~KDoubleNumInput

(

)

[virtual]

destructor

Definition at line 721 of file knuminput.cpp.

KDoubleNumInput::KDoubleNumInput	(	KNumInput *	below,
		double	lower,
		double	upper,
		double	value,
		QWidget *	parent = 0,
		double	singleStep = 0.02,
		int	precision = 2
	)

Constructor.

the difference here is the "below" parameter. It tells this instance that it is visually put below some other KNumInput widget. Note that these two KNumInput's need not to have the same parent widget or be in the same layout group. The effect is that it'll adjust its layout in correspondence with the layout of the other KNumInput's (you can build an arbitrary long chain).

Parameters:

below	append KDoubleNumInput to the KDoubleNumInput chain
lower	lower boundary value
upper	upper boundary value
value	initial value for the control
singleStep	step size to use for up/down arrow clicks
precision	number of digits after the decimal point
parent	parent QWidget

Deprecated:

use the version without below instead

Definition at line 711 of file knuminput.cpp.

---

Member Function Documentation

int KDoubleNumInput::decimals

(

)

const

Returns:

number of decimals.

See also:

setDecimals()

void KDoubleNumInput::doLayout

(

)

[protected, virtual]

You need to overwrite this method and implement your layout calculations there.

See KIntNumInput::doLayout and KDoubleNumInput::doLayout implementation for details.

Implements KNumInput.

Definition at line 873 of file knuminput.cpp.

double KDoubleNumInput::exponentRatio

(

)

const

Returns:

the value of the exponent use to map the slider to the spin box.

double KDoubleNumInput::maximum

(

)

const

Returns:

the maximum value.

double KDoubleNumInput::minimum

(

)

const

Returns:

the minimum value.

QSize KDoubleNumInput::minimumSizeHint

(

)

const [virtual]

Definition at line 804 of file knuminput.cpp.

QString KDoubleNumInput::prefix

(

)

const

Returns:

the prefix.

See also:

setPrefix()

double KDoubleNumInput::referencePoint

(

)

const

Returns:

the reference point for relativeValue calculation

double KDoubleNumInput::relativeValue

(

)

const

Returns:

the current value in units of referencePoint.

void KDoubleNumInput::relativeValueChanged

(

double

)

[signal]

This is an overloaded member function, provided for convenience.

It essentially behaves like the above function.

Contains the value in units of referencePoint.

void KDoubleNumInput::resizeEvent

(

QResizeEvent *

e

)

[protected]

Definition at line 833 of file knuminput.cpp.

void KDoubleNumInput::setDecimals

(

int

decimals

)

Specifies the number of digits to use.

Definition at line 1037 of file knuminput.cpp.

void KDoubleNumInput::setExponentRatio

(

double

dbl

)

Parameters:

dbl	the value of the exponent use to map the slider to the spin box (dbl need to be strictly positive).

Definition at line 1073 of file knuminput.cpp.

void KDoubleNumInput::setLabel	(	const QString &	label,
		Qt::Alignment	a = Qt::AlignLeft | Qt::AlignTop
	)		[virtual]

Sets the text and alignment of the main description label.

Parameters:

label	The text of the label. Use QString() to remove an existing one.
a	The alignment of the label (Qt::Alignment). Default is Qt:AlignLeft | Qt:AlignTop.

The vertical alignment flags have special meaning with this widget:

• Qt:AlignTop The label is placed above the edit/slider
• Qt:AlignVCenter The label is placed left beside the edit
• Qt:AlignBottom The label is placed below the edit/slider

Reimplemented from KNumInput.

Definition at line 1057 of file knuminput.cpp.

void KDoubleNumInput::setMaximum

(

double

max

)

Sets the maximum value.

Definition at line 974 of file knuminput.cpp.

void KDoubleNumInput::setMinimum

(

double

min

)

Sets the minimum value.

Definition at line 963 of file knuminput.cpp.

void KDoubleNumInput::setPrecision

(

int

precision

)

[inline]

Definition at line 595 of file knuminput.h.

void KDoubleNumInput::setPrefix

(

const QString &

prefix

)

[slot]

Sets the prefix to be displayed to prefix.

Use QString() to disable this feature. Note that the prefix is attached to the value without any spacing.

See also:

setPrefix()

Definition at line 1030 of file knuminput.cpp.

void KDoubleNumInput::setRange	(	double	min,
		double	max,
		double	singleStep = 1,
		bool	slider = true
	)

Parameters:

min	minimum value
max	maximum value
singleStep	step size for the QSlider
slider	whether the slider is created or not

Definition at line 903 of file knuminput.cpp.

void KDoubleNumInput::setReferencePoint

(

double

ref

)

[slot]

Sets the reference Point to ref.

It ref == 0, emitting of relativeValueChanged is blocked and relativeValue just returns 0.

Definition at line 896 of file knuminput.cpp.

void KDoubleNumInput::setRelativeValue

(

double

r

)

[slot]

Sets the value in units of referencePoint.

Definition at line 886 of file knuminput.cpp.

void KDoubleNumInput::setSingleStep

(

double

singleStep

)

Returns:

the step of the spin box

Definition at line 990 of file knuminput.cpp.

void KDoubleNumInput::setSliderEnabled

(

bool

enabled

)

Parameters:

enabled

Show the slider enabled

Definition at line 925 of file knuminput.cpp.

void KDoubleNumInput::setSpecialValueText

(

const QString &

text

)

Sets the special value text.

If set, the spin box will display this text instead of the numeric value whenever the current value is equal to minVal(). Typically this is used for indicating that the choice has a special (default) meaning.

Definition at line 1049 of file knuminput.cpp.

void KDoubleNumInput::setSuffix

(

const QString &

suffix

)

[slot]

Sets the suffix to be displayed to suffix.

Use QString() to disable this feature. Note that the suffix is attached to the value without any spacing. So if you prefer to display a space separator, set suffix to something like " cm".

See also:

setSuffix()

Definition at line 1023 of file knuminput.cpp.

void KDoubleNumInput::setValue

(

double

val

)

[slot]

Sets the value of the control.

Definition at line 881 of file knuminput.cpp.

double KDoubleNumInput::singleStep

(

)

const

Returns:

the step of the spin box

QString KDoubleNumInput::specialValueText

(

)

const

Returns:

the string displayed for a special value.

See also:

setSpecialValueText()

QString KDoubleNumInput::suffix

(

)

const

Returns:

the suffix.

See also:

setSuffix()

double KDoubleNumInput::value

(

)

const

Returns:

the current value.

void KDoubleNumInput::valueChanged

(

double

)

[signal]

Emitted every time the value changes (by calling setValue() or by user interaction).

---

Property Documentation

int KDoubleNumInput::decimals [read, write]

Definition at line 460 of file knuminput.h.

double KDoubleNumInput::exponentRatio [read, write]

Definition at line 464 of file knuminput.h.

double KDoubleNumInput::maximum [read, write]

Definition at line 455 of file knuminput.h.

double KDoubleNumInput::minimum [read, write]

Definition at line 454 of file knuminput.h.

QString KDoubleNumInput::prefix [read, write]

Definition at line 458 of file knuminput.h.

double KDoubleNumInput::referencePoint [read, write]

Definition at line 461 of file knuminput.h.

double KDoubleNumInput::relativeValue [read, write]

Definition at line 462 of file knuminput.h.

double KDoubleNumInput::singleStep [read, write]

Definition at line 456 of file knuminput.h.

bool KDoubleNumInput::sliderEnabled [read, write]

Definition at line 463 of file knuminput.h.

QString KDoubleNumInput::specialValueText [read, write]

Definition at line 459 of file knuminput.h.

QString KDoubleNumInput::suffix [read, write]

Definition at line 457 of file knuminput.h.

double KDoubleNumInput::value [read, write]

Definition at line 453 of file knuminput.h.

---

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

• knuminput.h
• knuminput.cpp