# spinbox class

Provides a simple spin button.

Inherits
object widget
Description
This widget allows the user to choose a value either by clicking the up/down buttons to increase/decrease the value currently displayed or by typing the value directly into the spin box.
Functions

`$setValue(<value:integer>)`
Sets the value of the spin box. See also $value()
`$setMinValue(<min_value:integer>)`
Sets the minimum value of the spin box. See also $MinValue()
`$setMaxValue(<max_value:integer>)`
Sets the maximum value of the spin box. See also $maxValue()
`$setLineStep(<line_step:integer>)`
Sets the line step: when the user uses the arrows to change the spin box's value the value will be incremented/decremented by the amount of the line step. See also $lineStep()
`$setSpecialValueText(<text:string>)`
Sets the special-value text. If set, the spin box will display this text instead of a numeric value whenever the current value is equal to $minValue(). See also $setSpecialValueText()
`$setPrefix(<text:string>)`
This property holds the spin box's prefix. The prefix is prepended to the start of the displayed value. Typical use is to display a unit of measurement or a currency symbol. See also $setSuffix()
`$setSuffix(<text:string>);`
This property holds the suffix of the spin box. The suffix is appended to the end of the displayed value. See also $setPrefix()
`<integer> $value()`
Returns the value of the spin box. See also $setValue()
`<integer> $minValue`
Returns the minimum value of the spin box. See also $setMinValue()
`<integer> $maxValue`
Returns the maximum value of the spin box. See also $setMaxValue()
`<integer> $lineStep()`
Return the linestep.
`<string> $specialValueText()`
Returns the special-value text. See also $setSpecialValueText()
`$valueChangedEvent(<new value:integer>)`

This function is called by the framework when the spinbox value is changed and return the new slider value as its argument.
The default implementation emits the $valueChanged() signal, so it is easy to handle the values from many spinboxes without reimplementing the $valueChangedEvent() for every one.
Note: If you reimplement this function to catch the spinbox value, you will have to emit the signal by yourself (if you still need it, obviously).

Signals

`$valueChanged()`
This signal is emitted by the default implementation of [classfnc]valueChangedEvent[/classfnc](). If you reimplement that function you will have to emit the signal manually (if you still need it).

Index, Object Classes

KVIrc 3.4.0 Documentation
Generated by linimon at Wed Dec 3 16:16:57 2008