Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KDoubleNumInput Class Reference

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

#include <knuminput.h>

Inheritance diagram for KDoubleNumInput:

KNumInput List of all members.

Public Slots

void setValue (double)
void setRelativeValue (double)
void setReferencePoint (double ref)
void setSuffix (const QString &suffix)
void setPrefix (const QString &prefix)

Signals

void valueChanged (double)
void relativeValueChanged (double)

Public Methods

 KDoubleNumInput (QWidget *parent=0, const char *name=0)
 KDoubleNumInput (double value, QWidget *parent=0, const char *name=0)
 KDoubleNumInput (double lower, double upper, double value, double step=0.01, int precision=2, QWidget *parent=0, const char *name=0)
virtual ~KDoubleNumInput ()
 KDoubleNumInput (KNumInput *below, double value, QWidget *parent=0, const char *name=0)
 KDoubleNumInput (KNumInput *below, double lower, double upper, double value, double step=0.02, int precision=2, QWidget *parent=0, const char *name=0)
double value () const
QString suffix () const
QString prefix () const
int precision () const
QString specialValueText () const
void setRange (double min, double max, double step=1, bool slider=true)
void setMinValue (double min)
double minValue () const
void setMaxValue (double max)
double maxValue () const
void setPrecision (int precision)
double referencePoint () const
double relativeValue () const
void setSpecialValueText (const QString &text)
virtual void setLabel (const QString &label, int a=AlignLeft|AlignTop)
virtual QSize minimumSizeHint () const
virtual bool eventFilter (QObject *, QEvent *)

Protected Methods

virtual void doLayout ()
void resizeEvent (QResizeEvent *)
virtual void virtual_hook (int id, void *data)

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.

It uses the KDoubleValidator validator class. KDoubleNumInput enforces the value to be in the given range, but see the class documentation of KDoubleSpinBox for the tricky interrelationship of precision and values. All of what is said there applies here, too.

See also:
KIntNumInput, KDoubleSpinBox

Definition at line 432 of file knuminput.h.

Constructor & Destructor Documentation

KDoubleNumInput::KDoubleNumInput (  QWidget *    parent = 0,
const char *    name = 0
) 
 

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

KDoubleNumInput::KDoubleNumInput (  double    value,
QWidget *    parent = 0,
const char *    name = 0
) 
 

Deprecated:
(value is rounded to a multiple of 1/100) Constructor
Parameters:
value  initial value for the control
parent  parent QWidget
name  internal name for this widget

KDoubleNumInput::KDoubleNumInput (  double    lower,
double    upper,
double    value,
double    step = 0.01,
int    precision = 2,
QWidget *    parent = 0,
const char *    name = 0
) 
 

Constructor

Parameters:
lower  lower boundary value
upper  upper boundary value
value  initial value for the control
step  step size to use for up/down arrow clicks
precision  number of digits after the decimal point
parent  parent QWidget
name  internal name for this widget
Since:
3.1

virtual KDoubleNumInput::~KDoubleNumInput (    )  [virtual]
 

destructor

KDoubleNumInput::KDoubleNumInput (  KNumInput *    below,
double    value,
QWidget *    parent = 0,
const char *    name = 0
) 
 

Deprecated:
(rounds value to a mulitple of 1/100) Constructor

puts it below other KNumInput

Parameters:
below 
value  initial value for the control
parent  parent QWidget
name  internal name for this widget

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

Constructor

puts it below other KNumInput

Parameters:
lower  lower boundary value
upper  upper boundary value
value  initial value for the control
step  step size to use for up/down arrow clicks
precision  number of digits after the decimal point
parent  parent QWidget
name  internal name for this widget
Since:
3.1

Member Function Documentation

virtual void KDoubleNumInput::doLayout (    )  [protected, virtual]
 

@reimplemented

Implements KNumInput.

virtual bool KDoubleNumInput::eventFilter (  QObject *   ,
QEvent *   
)  [virtual]
 

@reimplemented

double KDoubleNumInput::maxValue (    ) 
 

Returns:
the maximum value.

virtual QSize KDoubleNumInput::minimumSizeHint (    )  [virtual]
 

@reimplemented

double KDoubleNumInput::minValue (    ) 
 

Returns:
the minimum value.

int KDoubleNumInput::precision (    ) 
 

Returns:
the precision.
See also:
setPrecision()

QString KDoubleNumInput::prefix (    ) 
 

Returns:
the prefix.
See also:
setPrefix()

double KDoubleNumInput::referencePoint (    ) 
 

Returns:
the reference point for relativeValue calculation
Since:
3.1

double KDoubleNumInput::relativeValue (    ) 
 

Returns:
the current value in units of referencePoint.
Since:
3.1

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.

Since:
3.1

void KDoubleNumInput::resizeEvent (  QResizeEvent *    )  [protected]
 

@reimplemented

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

@reimplemented

Reimplemented from KNumInput.

void KDoubleNumInput::setMaxValue (  double    max ) 
 

Sets the maximum value.

void KDoubleNumInput::setMinValue (  double    min ) 
 

Sets the minimum value.

void KDoubleNumInput::setPrecision (  int    precision ) 
 

Specifies the number of digits to use.

void KDoubleNumInput::setPrefix (  const QString &    prefix )  [slot]
 

Sets the prefix to be displayed to prefix. Use QString::null to disable this feature. Note that the prefix is attached to the value without any spacing.

See also:
setPrefix()

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

Parameters:
min  minimum value
max  maximum value
step  step size for the QSlider

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.

Since:
3.1

void KDoubleNumInput::setRelativeValue (  double    )  [slot]
 

Sets the value in units of referencePoint.

Since:
3.1

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.

void KDoubleNumInput::setSuffix (  const QString &    suffix )  [slot]
 

Sets the suffix to be displayed to suffix. Use QString::null 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()

void KDoubleNumInput::setValue (  double    )  [slot]
 

Sets the value of the control.

QString KDoubleNumInput::specialValueText (    )  const [inline]
 

Returns:
the string displayed for a special value.
See also:
setSpecialValueText()

Definition at line 537 of file knuminput.h.

QString KDoubleNumInput::suffix (    ) 
 

Returns:
the suffix.
See also:
setSuffix()

double KDoubleNumInput::value (    ) 
 

Returns:
the current value.

void KDoubleNumInput::valueChanged (  double    )  [signal]
 

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

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:11 2003 for kdelibs by doxygen1.2.18