• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KIntNumInput Class Reference

An input widget for integer numbers, consisting of a spinbox and a slider. More...

#include <knuminput.h>

Inheritance diagram for KIntNumInput:
KNumInput QWidget

List of all members.

Public Slots

void setEditFocus (bool mark=true)
void setPrefix (const QString &prefix)
void setReferencePoint (int)
void setRelativeValue (double)
void setSuffix (const KLocalizedString &suffix)
void setSuffix (const QString &suffix)
void setValue (int)

Signals

void relativeValueChanged (double)
void valueChanged (int)

Public Member Functions

KDE_CONSTRUCTOR_DEPRECATED KIntNumInput (KNumInput *below, int value, QWidget *parent, int base=10)
 KIntNumInput (int value, QWidget *parent=0, int base=10)
 KIntNumInput (QWidget *parent=0)
int maximum () const
int minimum () const
virtual QSize minimumSizeHint () const
QString prefix () const
int referencePoint () const
double relativeValue () const
virtual void setLabel (const QString &label, Qt::Alignment a=Qt::AlignLeft|Qt::AlignTop)
void setMaximum (int max)
void setMinimum (int min)
KDE_DEPRECATED void setRange (int min, int max, int singleStep, bool slider)
void setRange (int min, int max, int singleStep=1)
void setSingleStep (int step)
void setSliderEnabled (bool enabled=true)
void setSpecialValueText (const QString &text)
int singleStep () const
QString specialValueText () const
QString suffix () const
int value () const
virtual ~KIntNumInput ()

Protected Member Functions

virtual void doLayout ()
void resizeEvent (QResizeEvent *)
QSpinBox * spinBox () const

Properties

int maximum
int minimum
QString prefix
int referencePoint
double relativeValue
int singleStep
bool sliderEnabled
QString specialValueText
QString suffix
int value

Detailed Description

An input widget for integer numbers, consisting of a spinbox and a slider.

KIntNumInput combines a QSpinBox and optionally a QSlider with a label to make an easy to use control for setting some integer 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 or when the user calls setSliderEnabled.

A special feature of KIntNumInput, designed specifically for the situation when there are several KIntNumInputs 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 KIntValidator validator class. KIntNumInput enforces the value to be in the given range, and can display it in any base between 2 and 36.

kintnuminput.png

KDE Int Number Input Spinbox

Definition at line 170 of file knuminput.h.


Constructor & Destructor Documentation

KIntNumInput::KIntNumInput ( QWidget *  parent = 0  )  [explicit]

Constructs an input control for integer values with base 10 and initial value 0.

Definition at line 338 of file knuminput.cpp.

KIntNumInput::KIntNumInput ( int  value,
QWidget *  parent = 0,
int  base = 10 
) [explicit]

Constructor It constructs a QSpinBox that allows the input of integer numbers in the range of -INT_MAX to +INT_MAX.

To set a descriptive label, use setLabel(). To enforce the value being in a range and optionally to attach a slider to it, use setRange().

Parameters:
value initial value for the control
base numeric base used for display
parent parent QWidget

Definition at line 345 of file knuminput.cpp.

KIntNumInput::KIntNumInput ( KNumInput *  below,
int  value,
QWidget *  parent,
int  base = 10 
)

Constructor.

the difference to the one above 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 KIntNumInput to the KNumInput chain
value initial value for the control
base numeric base used for display
parent parent QWidget
Deprecated:
use the version without the below parameter instead.

Definition at line 331 of file knuminput.cpp.

KIntNumInput::~KIntNumInput (  )  [virtual]

Destructor.

Definition at line 608 of file knuminput.cpp.


Member Function Documentation

void KIntNumInput::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 559 of file knuminput.cpp.

int KIntNumInput::maximum (  )  const
Returns:
the maximum value.
int KIntNumInput::minimum (  )  const
Returns:
the minimum value.
QSize KIntNumInput::minimumSizeHint (  )  const [virtual]

This method returns the minimum size necessary to display the control.

The minimum size is enough to show all the labels in the current font (font change may invalidate the return value).

Returns:
the minimum size necessary to show the control

Definition at line 531 of file knuminput.cpp.

QString KIntNumInput::prefix (  )  const
Returns:
the prefix displayed in front of the value.
See also:
setPrefix()
int KIntNumInput::referencePoint (  )  const
Returns:
the current reference point
double KIntNumInput::relativeValue (  )  const
Returns:
the curent value in units of the referencePoint.
void KIntNumInput::relativeValueChanged ( double   )  [signal]

Emitted whenever valueChanged is.

Contains the change relative to the referencePoint.

void KIntNumInput::resizeEvent ( QResizeEvent *  e  )  [protected]

Definition at line 571 of file knuminput.cpp.

void KIntNumInput::setEditFocus ( bool  mark = true  )  [slot]

sets focus to the edit widget and marks all text in if mark == true

Definition at line 526 of file knuminput.cpp.

void KIntNumInput::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 653 of file knuminput.cpp.

void KIntNumInput::setMaximum ( int  max  ) 

Sets the maximum value.

Definition at line 476 of file knuminput.cpp.

void KIntNumInput::setMinimum ( int  min  ) 

Sets the minimum value.

Definition at line 466 of file knuminput.cpp.

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

Sets the prefix to prefix.

Use QString() to disable this feature. Formatting has to be provided (see above).

See also:
QSpinBox::setPrefix(), setSuffix()

Definition at line 514 of file knuminput.cpp.

void KIntNumInput::setRange ( int  min,
int  max,
int  singleStep,
bool  slider 
)
Deprecated:
Use the other setRange function and setSliderEnabled instead

Definition at line 460 of file knuminput.cpp.

void KIntNumInput::setRange ( int  min,
int  max,
int  singleStep = 1 
)

Sets the allowed input range and the step size for the slider and the spin box.

Parameters:
min minimum value
max maximum value
step step size

Definition at line 437 of file knuminput.cpp.

void KIntNumInput::setReferencePoint ( int  ref  )  [slot]

Sets the reference point for relativeValue.

Definition at line 378 of file knuminput.cpp.

void KIntNumInput::setRelativeValue ( double  r  )  [slot]

Sets the value in units of the referencePoint.

Definition at line 619 of file knuminput.cpp.

void KIntNumInput::setSingleStep ( int  step  ) 
Returns:
the step of the spin box

Definition at line 491 of file knuminput.cpp.

void KIntNumInput::setSliderEnabled ( bool  enabled = true  ) 
Parameters:
enabled Show the slider enabled

Definition at line 409 of file knuminput.cpp.

void KIntNumInput::setSpecialValueText ( const QString &  text  ) 

Sets the special value text.

If set, the SpinBox 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 642 of file knuminput.cpp.

void KIntNumInput::setSuffix ( const KLocalizedString &  suffix  )  [slot]

Sets the suffix to suffix.

Use this to add a plural-aware suffix, e.g. by using ki18np("singular", "plural").

Since:
4.3

Definition at line 503 of file knuminput.cpp.

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

Sets the suffix to suffix.

Use QString() to disable this feature. Formatting has to be provided (e.g. a space separator between the prepended value and the suffix's text has to be provided as the first character in the suffix).

See also:
QSpinBox::setSuffix(), setPrefix()

Definition at line 496 of file knuminput.cpp.

void KIntNumInput::setValue ( int  val  )  [slot]

Sets the value of the control.

Definition at line 613 of file knuminput.cpp.

int KIntNumInput::singleStep (  )  const
Returns:
the step of the spin box
QString KIntNumInput::specialValueText (  )  const
Returns:
the string displayed for a special value.
See also:
setSpecialValueText()
QSpinBox * KIntNumInput::spinBox (  )  const [protected]
Returns:
the spin box widget.

For internal use only.

Definition at line 352 of file knuminput.cpp.

QString KIntNumInput::suffix (  )  const
Returns:
the suffix displayed behind the value.
See also:
setSuffix()
int KIntNumInput::value (  )  const
Returns:
the current value.
void KIntNumInput::valueChanged ( int   )  [signal]

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


Property Documentation

int KIntNumInput::maximum [read, write]

Definition at line 175 of file knuminput.h.

int KIntNumInput::minimum [read, write]

Definition at line 174 of file knuminput.h.

QString KIntNumInput::prefix [read, write]

Definition at line 180 of file knuminput.h.

int KIntNumInput::referencePoint [read, write]

Definition at line 177 of file knuminput.h.

double KIntNumInput::relativeValue [read, write]

Definition at line 178 of file knuminput.h.

int KIntNumInput::singleStep [read, write]

Definition at line 176 of file knuminput.h.

bool KIntNumInput::sliderEnabled [read, write]

Definition at line 182 of file knuminput.h.

QString KIntNumInput::specialValueText [read, write]

Definition at line 181 of file knuminput.h.

QString KIntNumInput::suffix [read, write]

Definition at line 179 of file knuminput.h.

int KIntNumInput::value [read, write]

Definition at line 173 of file knuminput.h.


The documentation for this class was generated from the following files:
  • knuminput.h
  • knuminput.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal